cea21a18f930f85ac2e8e94a2ff827e0b9fe0a98
[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.94"
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 2020
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>University of Cambridge</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 .new
1425 .cindex "tainted data" "de-tainting"
1426 A match verifies the variable &$domain$& (which carries tainted data)
1427 and assigns an untainted value to the &$domain_data$& variable.
1428 Such an untainted value is often needed in the transport.
1429 For specifics of the matching operation and the resulting untainted value,
1430 refer to section &<<SECTdomainlist>>&.
1431
1432 When an untainted value is wanted, use this option
1433 rather than the generic &%condition%& option.
1434 .wen
1435
1436 .next
1437 .vindex "&$local_part_prefix$&"
1438 .vindex "&$local_part_prefix_v$&"
1439 .vindex "&$local_part$&"
1440 .vindex "&$local_part_suffix$&"
1441 .vindex "&$local_part_suffix_v$&"
1442 .cindex affix "router precondition"
1443 If the &%local_parts%& option is set, the local part of the address must be in
1444 the set of local parts that it defines.
1445 .new
1446 A match verifies the variable &$local_part$& (which carries tainted data)
1447 and assigns an untainted value to the &$local_part_data$& variable.
1448 Such an untainted value is often needed in the transport.
1449 For specifics of the matching operation and the resulting untainted value,
1450 refer to section &<<SECTlocparlis>>&.
1451
1452 When an untainted value is wanted, use this option
1453 rather than the generic &%condition%& option.
1454 .wen
1455
1456 If &%local_part_prefix%& or
1457 &%local_part_suffix%& is in use, the prefix or suffix is removed from the local
1458 part before this check. If you want to do precondition tests on local parts
1459 that include affixes, you can do so by using a &%condition%& option (see below)
1460 that uses the variables &$local_part$&, &$local_part_prefix$&,
1461 &$local_part_prefix_v$&, &$local_part_suffix$&
1462 and &$local_part_suffix_v$& as necessary.
1463
1464 .next
1465 .vindex "&$local_user_uid$&"
1466 .vindex "&$local_user_gid$&"
1467 .vindex "&$home$&"
1468 If the &%check_local_user%& option is set, the local part must be the name of
1469 an account on the local host. If this check succeeds, the uid and gid of the
1470 local user are placed in &$local_user_uid$& and &$local_user_gid$& and the
1471 user's home directory is placed in &$home$&; these values can be used in the
1472 remaining preconditions.
1473
1474 .next
1475 If the &%router_home_directory%& option is set, it is expanded at this point,
1476 because it overrides the value of &$home$&. If this expansion were left till
1477 later, the value of &$home$& as set by &%check_local_user%& would be used in
1478 subsequent tests. Having two different values of &$home$& in the same router
1479 could lead to confusion.
1480
1481 .next
1482 If the &%senders%& option is set, the envelope sender address must be in the
1483 set of addresses that it defines.
1484
1485 .next
1486 If the &%require_files%& option is set, the existence or non-existence of
1487 specified files is tested.
1488
1489 .next
1490 .cindex "customizing" "precondition"
1491 If the &%condition%& option is set, it is evaluated and tested. This option
1492 uses an expanded string to allow you to set up your own custom preconditions.
1493 Expanded strings are described in chapter &<<CHAPexpand>>&.
1494
1495 .new
1496 Note that while using
1497 this option for address matching technically works,
1498 it does not set any de-tainted values.
1499 Such values are often needed, either for router-specific options or
1500 for transport options.
1501 Using the &%domains%& and &%local_parts%& options is usually the most
1502 convenient way to obtain them.
1503 .wen
1504 .endlist
1505
1506
1507 Note that &%require_files%& comes near the end of the list, so you cannot use
1508 it to check for the existence of a file in which to lookup up a domain, local
1509 part, or sender. However, as these options are all expanded, you can use the
1510 &%exists%& expansion condition to make such tests within each condition. The
1511 &%require_files%& option is intended for checking files that the router may be
1512 going to use internally, or which are needed by a specific transport (for
1513 example, &_.procmailrc_&).
1514
1515
1516
1517 .section "Delivery in detail" "SECID18"
1518 .cindex "delivery" "in detail"
1519 When a message is to be delivered, the sequence of events is as follows:
1520
1521 .ilist
1522 If a system-wide filter file is specified, the message is passed to it. The
1523 filter may add recipients to the message, replace the recipients, discard the
1524 message, cause a new message to be generated, or cause the message delivery to
1525 fail. The format of the system filter file is the same as for Exim user filter
1526 files, described in the separate document entitled &'Exim's interfaces to mail
1527 filtering'&.
1528 .cindex "Sieve filter" "not available for system filter"
1529 (&*Note*&: Sieve cannot be used for system filter files.)
1530
1531 Some additional features are available in system filters &-- see chapter
1532 &<<CHAPsystemfilter>>& for details. Note that a message is passed to the system
1533 filter only once per delivery attempt, however many recipients it has. However,
1534 if there are several delivery attempts because one or more addresses could not
1535 be immediately delivered, the system filter is run each time. The filter
1536 condition &%first_delivery%& can be used to detect the first run of the system
1537 filter.
1538 .next
1539 Each recipient address is offered to each configured router, in turn, subject to
1540 its preconditions, until one is able to handle it. If no router can handle the
1541 address, that is, if they all decline, the address is failed. Because routers
1542 can be targeted at particular domains, several locally handled domains can be
1543 processed entirely independently of each other.
1544 .next
1545 .cindex "routing" "loops in"
1546 .cindex "loop" "while routing"
1547 A router that accepts an address may assign it to a local or a remote
1548 transport. However, the transport is not run at this time. Instead, the address
1549 is placed on a list for the particular transport, which will be run later.
1550 Alternatively, the router may generate one or more new addresses (typically
1551 from alias, forward, or filter files). New addresses are fed back into this
1552 process from the top, but in order to avoid loops, a router ignores any address
1553 which has an identically-named ancestor that was processed by itself.
1554 .next
1555 When all the routing has been done, addresses that have been successfully
1556 handled are passed to their assigned transports. When local transports are
1557 doing real local deliveries, they handle only one address at a time, but if a
1558 local transport is being used as a pseudo-remote transport (for example, to
1559 collect batched SMTP messages for transmission by some other means) multiple
1560 addresses can be handled. Remote transports can always handle more than one
1561 address at a time, but can be configured not to do so, or to restrict multiple
1562 addresses to the same domain.
1563 .next
1564 Each local delivery to a file or a pipe runs in a separate process under a
1565 non-privileged uid, and these deliveries are run one at a time. Remote
1566 deliveries also run in separate processes, normally under a uid that is private
1567 to Exim (&"the Exim user"&), but in this case, several remote deliveries can be
1568 run in parallel. The maximum number of simultaneous remote deliveries for any
1569 one message is set by the &%remote_max_parallel%& option.
1570 The order in which deliveries are done is not defined, except that all local
1571 deliveries happen before any remote deliveries.
1572 .next
1573 .cindex "queue runner"
1574 When it encounters a local delivery during a queue run, Exim checks its retry
1575 database to see if there has been a previous temporary delivery failure for the
1576 address before running the local transport. If there was a previous failure,
1577 Exim does not attempt a new delivery until the retry time for the address is
1578 reached. However, this happens only for delivery attempts that are part of a
1579 queue run. Local deliveries are always attempted when delivery immediately
1580 follows message reception, even if retry times are set for them. This makes for
1581 better behaviour if one particular message is causing problems (for example,
1582 causing quota overflow, or provoking an error in a filter file).
1583 .next
1584 .cindex "delivery" "retry in remote transports"
1585 Remote transports do their own retry handling, since an address may be
1586 deliverable to one of a number of hosts, each of which may have a different
1587 retry time. If there have been previous temporary failures and no host has
1588 reached its retry time, no delivery is attempted, whether in a queue run or
1589 not. See chapter &<<CHAPretry>>& for details of retry strategies.
1590 .next
1591 If there were any permanent errors, a bounce message is returned to an
1592 appropriate address (the sender in the common case), with details of the error
1593 for each failing address. Exim can be configured to send copies of bounce
1594 messages to other addresses.
1595 .next
1596 .cindex "delivery" "deferral"
1597 If one or more addresses suffered a temporary failure, the message is left on
1598 the queue, to be tried again later. Delivery of these addresses is said to be
1599 &'deferred'&.
1600 .next
1601 When all the recipient addresses have either been delivered or bounced,
1602 handling of the message is complete. The spool files and message log are
1603 deleted, though the message log can optionally be preserved if required.
1604 .endlist
1605
1606
1607
1608
1609 .section "Retry mechanism" "SECID19"
1610 .cindex "delivery" "retry mechanism"
1611 .cindex "retry" "description of mechanism"
1612 .cindex "queue runner"
1613 Exim's mechanism for retrying messages that fail to get delivered at the first
1614 attempt is the queue runner process. You must either run an Exim daemon that
1615 uses the &%-q%& option with a time interval to start queue runners at regular
1616 intervals or use some other means (such as &'cron'&) to start them. If you do
1617 not arrange for queue runners to be run, messages that fail temporarily at the
1618 first attempt will remain in your queue forever. A queue runner process works
1619 its way through the queue, one message at a time, trying each delivery that has
1620 passed its retry time.
1621 You can run several queue runners at once.
1622
1623 Exim uses a set of configured rules to determine when next to retry the failing
1624 address (see chapter &<<CHAPretry>>&). These rules also specify when Exim
1625 should give up trying to deliver to the address, at which point it generates a
1626 bounce message. If no retry rules are set for a particular host, address, and
1627 error combination, no retries are attempted, and temporary errors are treated
1628 as permanent.
1629
1630
1631
1632 .section "Temporary delivery failure" "SECID20"
1633 .cindex "delivery" "temporary failure"
1634 There are many reasons why a message may not be immediately deliverable to a
1635 particular address. Failure to connect to a remote machine (because it, or the
1636 connection to it, is down) is one of the most common. Temporary failures may be
1637 detected during routing as well as during the transport stage of delivery.
1638 Local deliveries may be delayed if NFS files are unavailable, or if a mailbox
1639 is on a file system where the user is over quota. Exim can be configured to
1640 impose its own quotas on local mailboxes; where system quotas are set they will
1641 also apply.
1642
1643 If a host is unreachable for a period of time, a number of messages may be
1644 waiting for it by the time it recovers, and sending them in a single SMTP
1645 connection is clearly beneficial. Whenever a delivery to a remote host is
1646 deferred,
1647 .cindex "hints database" "deferred deliveries"
1648 Exim makes a note in its hints database, and whenever a successful
1649 SMTP delivery has happened, it looks to see if any other messages are waiting
1650 for the same host. If any are found, they are sent over the same SMTP
1651 connection, subject to a configuration limit as to the maximum number in any
1652 one connection.
1653
1654
1655
1656 .section "Permanent delivery failure" "SECID21"
1657 .cindex "delivery" "permanent failure"
1658 .cindex "bounce message" "when generated"
1659 When a message cannot be delivered to some or all of its intended recipients, a
1660 bounce message is generated. Temporary delivery failures turn into permanent
1661 errors when their timeout expires. All the addresses that fail in a given
1662 delivery attempt are listed in a single message. If the original message has
1663 many recipients, it is possible for some addresses to fail in one delivery
1664 attempt and others to fail subsequently, giving rise to more than one bounce
1665 message. The wording of bounce messages can be customized by the administrator.
1666 See chapter &<<CHAPemsgcust>>& for details.
1667
1668 .cindex "&'X-Failed-Recipients:'& header line"
1669 Bounce messages contain an &'X-Failed-Recipients:'& header line that lists the
1670 failed addresses, for the benefit of programs that try to analyse such messages
1671 automatically.
1672
1673 .cindex "bounce message" "recipient of"
1674 A bounce message is normally sent to the sender of the original message, as
1675 obtained from the message's envelope. For incoming SMTP messages, this is the
1676 address given in the MAIL command. However, when an address is expanded via a
1677 forward or alias file, an alternative address can be specified for delivery
1678 failures of the generated addresses. For a mailing list expansion (see section
1679 &<<SECTmailinglists>>&) it is common to direct bounce messages to the manager
1680 of the list.
1681
1682
1683
1684 .section "Failures to deliver bounce messages" "SECID22"
1685 .cindex "bounce message" "failure to deliver"
1686 If a bounce message (either locally generated or received from a remote host)
1687 itself suffers a permanent delivery failure, the message is left in the queue,
1688 but it is frozen, awaiting the attention of an administrator. There are options
1689 that can be used to make Exim discard such failed messages, or to keep them
1690 for only a short time (see &%timeout_frozen_after%& and
1691 &%ignore_bounce_errors_after%&).
1692
1693
1694
1695
1696
1697 . ////////////////////////////////////////////////////////////////////////////
1698 . ////////////////////////////////////////////////////////////////////////////
1699
1700 .chapter "Building and installing Exim" "CHID3"
1701 .scindex IIDbuex "building Exim"
1702
1703 .section "Unpacking" "SECID23"
1704 Exim is distributed as a gzipped or bzipped tar file which, when unpacked,
1705 creates a directory with the name of the current release (for example,
1706 &_exim-&version()_&) into which the following files are placed:
1707
1708 .table2 140pt
1709 .irow &_ACKNOWLEDGMENTS_& "contains some acknowledgments"
1710 .irow &_CHANGES_&         "contains a reference to where changes are &&&
1711   documented"
1712 .irow &_LICENCE_&         "the GNU General Public Licence"
1713 .irow &_Makefile_&        "top-level make file"
1714 .irow &_NOTICE_&          "conditions for the use of Exim"
1715 .irow &_README_&          "list of files, directories and simple build &&&
1716   instructions"
1717 .endtable
1718
1719 Other files whose names begin with &_README_& may also be present. The
1720 following subdirectories are created:
1721
1722 .table2 140pt
1723 .irow &_Local_&           "an empty directory for local configuration files"
1724 .irow &_OS_&              "OS-specific files"
1725 .irow &_doc_&             "documentation files"
1726 .irow &_exim_monitor_&    "source files for the Exim monitor"
1727 .irow &_scripts_&         "scripts used in the build process"
1728 .irow &_src_&             "remaining source files"
1729 .irow &_util_&            "independent utilities"
1730 .endtable
1731
1732 The main utility programs are contained in the &_src_& directory and are built
1733 with the Exim binary. The &_util_& directory contains a few optional scripts
1734 that may be useful to some sites.
1735
1736
1737 .section "Multiple machine architectures and operating systems" "SECID24"
1738 .cindex "building Exim" "multiple OS/architectures"
1739 The building process for Exim is arranged to make it easy to build binaries for
1740 a number of different architectures and operating systems from the same set of
1741 source files. Compilation does not take place in the &_src_& directory.
1742 Instead, a &'build directory'& is created for each architecture and operating
1743 system.
1744 .cindex "symbolic link" "to build directory"
1745 Symbolic links to the sources are installed in this directory, which is where
1746 the actual building takes place. In most cases, Exim can discover the machine
1747 architecture and operating system for itself, but the defaults can be
1748 overridden if necessary.
1749 .cindex compiler requirements
1750 .cindex compiler version
1751 A C99-capable compiler will be required for the build.
1752
1753
1754 .section "PCRE library" "SECTpcre"
1755 .cindex "PCRE library"
1756 Exim no longer has an embedded PCRE library as the vast majority of
1757 modern systems include PCRE as a system library, although you may need to
1758 install the PCRE package or the PCRE development package for your operating
1759 system. If your system has a normal PCRE installation the Exim build
1760 process will need no further configuration. If the library or the
1761 headers are in an unusual location you will need to either set the PCRE_LIBS
1762 and INCLUDE directives appropriately,
1763 or set PCRE_CONFIG=yes to use the installed &(pcre-config)& command.
1764 If your operating system has no
1765 PCRE support then you will need to obtain and build the current PCRE
1766 from &url(ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/).
1767 More information on PCRE is available at &url(https://www.pcre.org/).
1768
1769 .section "DBM libraries" "SECTdb"
1770 .cindex "DBM libraries" "discussion of"
1771 .cindex "hints database" "DBM files used for"
1772 Even if you do not use any DBM files in your configuration, Exim still needs a
1773 DBM library in order to operate, because it uses indexed files for its hints
1774 databases. Unfortunately, there are a number of DBM libraries in existence, and
1775 different operating systems often have different ones installed.
1776
1777 .cindex "Solaris" "DBM library for"
1778 .cindex "IRIX, DBM library for"
1779 .cindex "BSD, DBM library for"
1780 .cindex "Linux, DBM library for"
1781 If you are using Solaris, IRIX, one of the modern BSD systems, or a modern
1782 Linux distribution, the DBM configuration should happen automatically, and you
1783 may be able to ignore this section. Otherwise, you may have to learn more than
1784 you would like about DBM libraries from what follows.
1785
1786 .cindex "&'ndbm'& DBM library"
1787 Licensed versions of Unix normally contain a library of DBM functions operating
1788 via the &'ndbm'& interface, and this is what Exim expects by default. Free
1789 versions of Unix seem to vary in what they contain as standard. In particular,
1790 some early versions of Linux have no default DBM library, and different
1791 distributors have chosen to bundle different libraries with their packaged
1792 versions. However, the more recent releases seem to have standardized on the
1793 Berkeley DB library.
1794
1795 Different DBM libraries have different conventions for naming the files they
1796 use. When a program opens a file called &_dbmfile_&, there are several
1797 possibilities:
1798
1799 .olist
1800 A traditional &'ndbm'& implementation, such as that supplied as part of
1801 Solaris, operates on two files called &_dbmfile.dir_& and &_dbmfile.pag_&.
1802 .next
1803 .cindex "&'gdbm'& DBM library"
1804 The GNU library, &'gdbm'&, operates on a single file. If used via its &'ndbm'&
1805 compatibility interface it makes two different hard links to it with names
1806 &_dbmfile.dir_& and &_dbmfile.pag_&, but if used via its native interface, the
1807 filename is used unmodified.
1808 .next
1809 .cindex "Berkeley DB library"
1810 The Berkeley DB package, if called via its &'ndbm'& compatibility interface,
1811 operates on a single file called &_dbmfile.db_&, but otherwise looks to the
1812 programmer exactly the same as the traditional &'ndbm'& implementation.
1813 .next
1814 If the Berkeley package is used in its native mode, it operates on a single
1815 file called &_dbmfile_&; the programmer's interface is somewhat different to
1816 the traditional &'ndbm'& interface.
1817 .next
1818 To complicate things further, there are several very different versions of the
1819 Berkeley DB package. Version 1.85 was stable for a very long time, releases
1820 2.&'x'& and 3.&'x'& were current for a while, but the latest versions when Exim last revamped support were numbered 4.&'x'&.
1821 Maintenance of some of the earlier releases has ceased. All versions of
1822 Berkeley DB could be obtained from
1823 &url(http://www.sleepycat.com/), which is now a redirect to their new owner's
1824 page with far newer versions listed.
1825 It is probably wise to plan to move your storage configurations away from
1826 Berkeley DB format, as today there are smaller and simpler alternatives more
1827 suited to Exim's usage model.
1828 .next
1829 .cindex "&'tdb'& DBM library"
1830 Yet another DBM library, called &'tdb'&, is available from
1831 &url(https://sourceforge.net/projects/tdb/files/). It has its own interface, and also
1832 operates on a single file.
1833 .endlist
1834
1835 .cindex "USE_DB"
1836 .cindex "DBM libraries" "configuration for building"
1837 Exim and its utilities can be compiled to use any of these interfaces. In order
1838 to use any version of the Berkeley DB package in native mode, you must set
1839 USE_DB in an appropriate configuration file (typically
1840 &_Local/Makefile_&). For example:
1841 .code
1842 USE_DB=yes
1843 .endd
1844 Similarly, for gdbm you set USE_GDBM, and for tdb you set USE_TDB. An
1845 error is diagnosed if you set more than one of these.
1846
1847 At the lowest level, the build-time configuration sets none of these options,
1848 thereby assuming an interface of type (1). However, some operating system
1849 configuration files (for example, those for the BSD operating systems and
1850 Linux) assume type (4) by setting USE_DB as their default, and the
1851 configuration files for Cygwin set USE_GDBM. Anything you set in
1852 &_Local/Makefile_&, however, overrides these system defaults.
1853
1854 As well as setting USE_DB, USE_GDBM, or USE_TDB, it may also be
1855 necessary to set DBMLIB, to cause inclusion of the appropriate library, as
1856 in one of these lines:
1857 .code
1858 DBMLIB = -ldb
1859 DBMLIB = -ltdb
1860 .endd
1861 Settings like that will work if the DBM library is installed in the standard
1862 place. Sometimes it is not, and the library's header file may also not be in
1863 the default path. You may need to set INCLUDE to specify where the header
1864 file is, and to specify the path to the library more fully in DBMLIB, as in
1865 this example:
1866 .code
1867 INCLUDE=-I/usr/local/include/db-4.1
1868 DBMLIB=/usr/local/lib/db-4.1/libdb.a
1869 .endd
1870 There is further detailed discussion about the various DBM libraries in the
1871 file &_doc/dbm.discuss.txt_& in the Exim distribution.
1872
1873
1874
1875 .section "Pre-building configuration" "SECID25"
1876 .cindex "building Exim" "pre-building configuration"
1877 .cindex "configuration for building Exim"
1878 .cindex "&_Local/Makefile_&"
1879 .cindex "&_src/EDITME_&"
1880 Before building Exim, a local configuration file that specifies options
1881 independent of any operating system has to be created with the name
1882 &_Local/Makefile_&. A template for this file is supplied as the file
1883 &_src/EDITME_&, and it contains full descriptions of all the option settings
1884 therein. These descriptions are therefore not repeated here. If you are
1885 building Exim for the first time, the simplest thing to do is to copy
1886 &_src/EDITME_& to &_Local/Makefile_&, then read it and edit it appropriately.
1887
1888 There are three settings that you must supply, because Exim will not build
1889 without them. They are the location of the runtime configuration file
1890 (CONFIGURE_FILE), the directory in which Exim binaries will be installed
1891 (BIN_DIRECTORY), and the identity of the Exim user (EXIM_USER and
1892 maybe EXIM_GROUP as well). The value of CONFIGURE_FILE can in fact be
1893 a colon-separated list of filenames; Exim uses the first of them that exists.
1894
1895 There are a few other parameters that can be specified either at build time or
1896 at runtime, to enable the same binary to be used on a number of different
1897 machines. However, if the locations of Exim's spool directory and log file
1898 directory (if not within the spool directory) are fixed, it is recommended that
1899 you specify them in &_Local/Makefile_& instead of at runtime, so that errors
1900 detected early in Exim's execution (such as a malformed configuration file) can
1901 be logged.
1902
1903 .cindex "content scanning" "specifying at build time"
1904 Exim's interfaces for calling virus and spam scanning software directly from
1905 access control lists are not compiled by default. If you want to include these
1906 facilities, you need to set
1907 .code
1908 WITH_CONTENT_SCAN=yes
1909 .endd
1910 in your &_Local/Makefile_&. For details of the facilities themselves, see
1911 chapter &<<CHAPexiscan>>&.
1912
1913
1914 .cindex "&_Local/eximon.conf_&"
1915 .cindex "&_exim_monitor/EDITME_&"
1916 If you are going to build the Exim monitor, a similar configuration process is
1917 required. The file &_exim_monitor/EDITME_& must be edited appropriately for
1918 your installation and saved under the name &_Local/eximon.conf_&. If you are
1919 happy with the default settings described in &_exim_monitor/EDITME_&,
1920 &_Local/eximon.conf_& can be empty, but it must exist.
1921
1922 This is all the configuration that is needed in straightforward cases for known
1923 operating systems. However, the building process is set up so that it is easy
1924 to override options that are set by default or by operating-system-specific
1925 configuration files, for example, to change the C compiler, which
1926 defaults to &%gcc%&. See section &<<SECToverride>>& below for details of how to
1927 do this.
1928
1929
1930
1931 .section "Support for iconv()" "SECID26"
1932 .cindex "&[iconv()]& support"
1933 .cindex "RFC 2047"
1934 The contents of header lines in messages may be encoded according to the rules
1935 described RFC 2047. This makes it possible to transmit characters that are not
1936 in the ASCII character set, and to label them as being in a particular
1937 character set. When Exim is inspecting header lines by means of the &%$h_%&
1938 mechanism, it decodes them, and translates them into a specified character set
1939 (default is set at build time). The translation is possible only if the operating system
1940 supports the &[iconv()]& function.
1941
1942 However, some of the operating systems that supply &[iconv()]& do not support
1943 very many conversions. The GNU &%libiconv%& library (available from
1944 &url(https://www.gnu.org/software/libiconv/)) can be installed on such
1945 systems to remedy this deficiency, as well as on systems that do not supply
1946 &[iconv()]& at all. After installing &%libiconv%&, you should add
1947 .code
1948 HAVE_ICONV=yes
1949 .endd
1950 to your &_Local/Makefile_& and rebuild Exim.
1951
1952
1953
1954 .section "Including TLS/SSL encryption support" "SECTinctlsssl"
1955 .cindex "TLS" "including support for TLS"
1956 .cindex "encryption" "including support for"
1957 .cindex "OpenSSL" "building Exim with"
1958 .cindex "GnuTLS" "building Exim with"
1959 Exim is usually built to support encrypted SMTP connections, using the STARTTLS
1960 command as per RFC 2487. It can also support clients that expect to
1961 start a TLS session immediately on connection to a non-standard port (see the
1962 &%tls_on_connect_ports%& runtime option and the &%-tls-on-connect%& command
1963 line option).
1964
1965 If you want to build Exim with TLS support, you must first install either the
1966 OpenSSL or GnuTLS library. There is no cryptographic code in Exim itself for
1967 implementing SSL.
1968
1969 If you do not want TLS support you should set
1970 .code
1971 DISABLE_TLS=yes
1972 .endd
1973 in &_Local/Makefile_&.
1974
1975 If OpenSSL is installed, you should set
1976 .code
1977 USE_OPENSL=yes
1978 TLS_LIBS=-lssl -lcrypto
1979 .endd
1980 in &_Local/Makefile_&. You may also need to specify the locations of the
1981 OpenSSL library and include files. For example:
1982 .code
1983 USE_OPENSSL=yes
1984 TLS_LIBS=-L/usr/local/openssl/lib -lssl -lcrypto
1985 TLS_INCLUDE=-I/usr/local/openssl/include/
1986 .endd
1987 .cindex "pkg-config" "OpenSSL"
1988 If you have &'pkg-config'& available, then instead you can just use:
1989 .code
1990 USE_OPENSSL=yes
1991 USE_OPENSSL_PC=openssl
1992 .endd
1993 .cindex "USE_GNUTLS"
1994 If GnuTLS is installed, you should set
1995 .code
1996 USE_GNUTLS=yes
1997 TLS_LIBS=-lgnutls -ltasn1 -lgcrypt
1998 .endd
1999 in &_Local/Makefile_&, and again you may need to specify the locations of the
2000 library and include files. For example:
2001 .code
2002 USE_GNUTLS=yes
2003 TLS_LIBS=-L/usr/gnu/lib -lgnutls -ltasn1 -lgcrypt
2004 TLS_INCLUDE=-I/usr/gnu/include
2005 .endd
2006 .cindex "pkg-config" "GnuTLS"
2007 If you have &'pkg-config'& available, then instead you can just use:
2008 .code
2009 USE_GNUTLS=yes
2010 USE_GNUTLS_PC=gnutls
2011 .endd
2012
2013 You do not need to set TLS_INCLUDE if the relevant directory is already
2014 specified in INCLUDE. Details of how to configure Exim to make use of TLS are
2015 given in chapter &<<CHAPTLS>>&.
2016
2017
2018
2019
2020 .section "Use of tcpwrappers" "SECID27"
2021
2022 .cindex "tcpwrappers, building Exim to support"
2023 .cindex "USE_TCP_WRAPPERS"
2024 .cindex "TCP_WRAPPERS_DAEMON_NAME"
2025 .cindex "tcp_wrappers_daemon_name"
2026 Exim can be linked with the &'tcpwrappers'& library in order to check incoming
2027 SMTP calls using the &'tcpwrappers'& control files. This may be a convenient
2028 alternative to Exim's own checking facilities for installations that are
2029 already making use of &'tcpwrappers'& for other purposes. To do this, you
2030 should set USE_TCP_WRAPPERS in &_Local/Makefile_&, arrange for the file
2031 &_tcpd.h_& to be available at compile time, and also ensure that the library
2032 &_libwrap.a_& is available at link time, typically by including &%-lwrap%& in
2033 EXTRALIBS_EXIM. For example, if &'tcpwrappers'& is installed in &_/usr/local_&,
2034 you might have
2035 .code
2036 USE_TCP_WRAPPERS=yes
2037 CFLAGS=-O -I/usr/local/include
2038 EXTRALIBS_EXIM=-L/usr/local/lib -lwrap
2039 .endd
2040 in &_Local/Makefile_&. The daemon name to use in the &'tcpwrappers'& control
2041 files is &"exim"&. For example, the line
2042 .code
2043 exim : LOCAL  192.168.1.  .friendly.domain.example
2044 .endd
2045 in your &_/etc/hosts.allow_& file allows connections from the local host, from
2046 the subnet 192.168.1.0/24, and from all hosts in &'friendly.domain.example'&.
2047 All other connections are denied. The daemon name used by &'tcpwrappers'&
2048 can be changed at build time by setting TCP_WRAPPERS_DAEMON_NAME in
2049 &_Local/Makefile_&, or by setting tcp_wrappers_daemon_name in the
2050 configure file. Consult the &'tcpwrappers'& documentation for
2051 further details.
2052
2053
2054 .section "Including support for IPv6" "SECID28"
2055 .cindex "IPv6" "including support for"
2056 Exim contains code for use on systems that have IPv6 support. Setting
2057 &`HAVE_IPV6=YES`& in &_Local/Makefile_& causes the IPv6 code to be included;
2058 it may also be necessary to set IPV6_INCLUDE and IPV6_LIBS on systems
2059 where the IPv6 support is not fully integrated into the normal include and
2060 library files.
2061
2062 Two different types of DNS record for handling IPv6 addresses have been
2063 defined. AAAA records (analogous to A records for IPv4) are in use, and are
2064 currently seen as the mainstream. Another record type called A6 was proposed
2065 as better than AAAA because it had more flexibility. However, it was felt to be
2066 over-complex, and its status was reduced to &"experimental"&.
2067 Exim used to
2068 have a compile option for including A6 record support but this has now been
2069 withdrawn.
2070
2071
2072
2073 .section "Dynamically loaded lookup module support" "SECTdynamicmodules"
2074 .cindex "lookup modules"
2075 .cindex "dynamic modules"
2076 .cindex ".so building"
2077 On some platforms, Exim supports not compiling all lookup types directly into
2078 the main binary, instead putting some into external modules which can be loaded
2079 on demand.
2080 This permits packagers to build Exim with support for lookups with extensive
2081 library dependencies without requiring all users to install all of those
2082 dependencies.
2083 Most, but not all, lookup types can be built this way.
2084
2085 Set &`LOOKUP_MODULE_DIR`& to the directory into which the modules will be
2086 installed; Exim will only load modules from that directory, as a security
2087 measure.  You will need to set &`CFLAGS_DYNAMIC`& if not already defined
2088 for your OS; see &_OS/Makefile-Linux_& for an example.
2089 Some other requirements for adjusting &`EXTRALIBS`& may also be necessary,
2090 see &_src/EDITME_& for details.
2091
2092 Then, for each module to be loaded dynamically, define the relevant
2093 &`LOOKUP_`&<&'lookup_type'&> flags to have the value "2" instead of "yes".
2094 For example, this will build in lsearch but load sqlite and mysql support
2095 on demand:
2096 .code
2097 LOOKUP_LSEARCH=yes
2098 LOOKUP_SQLITE=2
2099 LOOKUP_MYSQL=2
2100 .endd
2101
2102
2103 .section "The building process" "SECID29"
2104 .cindex "build directory"
2105 Once &_Local/Makefile_& (and &_Local/eximon.conf_&, if required) have been
2106 created, run &'make'& at the top level. It determines the architecture and
2107 operating system types, and creates a build directory if one does not exist.
2108 For example, on a Sun system running Solaris 8, the directory
2109 &_build-SunOS5-5.8-sparc_& is created.
2110 .cindex "symbolic link" "to source files"
2111 Symbolic links to relevant source files are installed in the build directory.
2112
2113 If this is the first time &'make'& has been run, it calls a script that builds
2114 a make file inside the build directory, using the configuration files from the
2115 &_Local_& directory. The new make file is then passed to another instance of
2116 &'make'&. This does the real work, building a number of utility scripts, and
2117 then compiling and linking the binaries for the Exim monitor (if configured), a
2118 number of utility programs, and finally Exim itself. The command &`make
2119 makefile`& can be used to force a rebuild of the make file in the build
2120 directory, should this ever be necessary.
2121
2122 If you have problems building Exim, check for any comments there may be in the
2123 &_README_& file concerning your operating system, and also take a look at the
2124 FAQ, where some common problems are covered.
2125
2126
2127
2128 .section 'Output from &"make"&' "SECID283"
2129 The output produced by the &'make'& process for compile lines is often very
2130 unreadable, because these lines can be very long. For this reason, the normal
2131 output is suppressed by default, and instead output similar to that which
2132 appears when compiling the 2.6 Linux kernel is generated: just a short line for
2133 each module that is being compiled or linked. However, it is still possible to
2134 get the full output, by calling &'make'& like this:
2135 .code
2136 FULLECHO='' make -e
2137 .endd
2138 The value of FULLECHO defaults to &"@"&, the flag character that suppresses
2139 command reflection in &'make'&. When you ask for the full output, it is
2140 given in addition to the short output.
2141
2142
2143
2144 .section "Overriding build-time options for Exim" "SECToverride"
2145 .cindex "build-time options, overriding"
2146 The main make file that is created at the beginning of the building process
2147 consists of the concatenation of a number of files which set configuration
2148 values, followed by a fixed set of &'make'& instructions. If a value is set
2149 more than once, the last setting overrides any previous ones. This provides a
2150 convenient way of overriding defaults. The files that are concatenated are, in
2151 order:
2152 .display
2153 &_OS/Makefile-Default_&
2154 &_OS/Makefile-_&<&'ostype'&>
2155 &_Local/Makefile_&
2156 &_Local/Makefile-_&<&'ostype'&>
2157 &_Local/Makefile-_&<&'archtype'&>
2158 &_Local/Makefile-_&<&'ostype'&>-<&'archtype'&>
2159 &_OS/Makefile-Base_&
2160 .endd
2161 .cindex "&_Local/Makefile_&"
2162 .cindex "building Exim" "operating system type"
2163 .cindex "building Exim" "architecture type"
2164 where <&'ostype'&> is the operating system type and <&'archtype'&> is the
2165 architecture type. &_Local/Makefile_& is required to exist, and the building
2166 process fails if it is absent. The other three &_Local_& files are optional,
2167 and are often not needed.
2168
2169 The values used for <&'ostype'&> and <&'archtype'&> are obtained from scripts
2170 called &_scripts/os-type_& and &_scripts/arch-type_& respectively. If either of
2171 the environment variables EXIM_OSTYPE or EXIM_ARCHTYPE is set, their
2172 values are used, thereby providing a means of forcing particular settings.
2173 Otherwise, the scripts try to get values from the &%uname%& command. If this
2174 fails, the shell variables OSTYPE and ARCHTYPE are inspected. A number
2175 of &'ad hoc'& transformations are then applied, to produce the standard names
2176 that Exim expects. You can run these scripts directly from the shell in order
2177 to find out what values are being used on your system.
2178
2179
2180 &_OS/Makefile-Default_& contains comments about the variables that are set
2181 therein. Some (but not all) are mentioned below. If there is something that
2182 needs changing, review the contents of this file and the contents of the make
2183 file for your operating system (&_OS/Makefile-<ostype>_&) to see what the
2184 default values are.
2185
2186
2187 .cindex "building Exim" "overriding default settings"
2188 If you need to change any of the values that are set in &_OS/Makefile-Default_&
2189 or in &_OS/Makefile-<ostype>_&, or to add any new definitions, you do not
2190 need to change the original files. Instead, you should make the changes by
2191 putting the new values in an appropriate &_Local_& file. For example,
2192 .cindex "Tru64-Unix build-time settings"
2193 when building Exim in many releases of the Tru64-Unix (formerly Digital UNIX,
2194 formerly DEC-OSF1) operating system, it is necessary to specify that the C
2195 compiler is called &'cc'& rather than &'gcc'&. Also, the compiler must be
2196 called with the option &%-std1%&, to make it recognize some of the features of
2197 Standard C that Exim uses. (Most other compilers recognize Standard C by
2198 default.) To do this, you should create a file called &_Local/Makefile-OSF1_&
2199 containing the lines
2200 .code
2201 CC=cc
2202 CFLAGS=-std1
2203 .endd
2204 If you are compiling for just one operating system, it may be easier to put
2205 these lines directly into &_Local/Makefile_&.
2206
2207 Keeping all your local configuration settings separate from the distributed
2208 files makes it easy to transfer them to new versions of Exim simply by copying
2209 the contents of the &_Local_& directory.
2210
2211
2212 .cindex "NIS lookup type" "including support for"
2213 .cindex "NIS+ lookup type" "including support for"
2214 .cindex "LDAP" "including support for"
2215 .cindex "lookup" "inclusion in binary"
2216 Exim contains support for doing LDAP, NIS, NIS+, and other kinds of file
2217 lookup, but not all systems have these components installed, so the default is
2218 not to include the relevant code in the binary. All the different kinds of file
2219 and database lookup that Exim supports are implemented as separate code modules
2220 which are included only if the relevant compile-time options are set. In the
2221 case of LDAP, NIS, and NIS+, the settings for &_Local/Makefile_& are:
2222 .code
2223 LOOKUP_LDAP=yes
2224 LOOKUP_NIS=yes
2225 LOOKUP_NISPLUS=yes
2226 .endd
2227 and similar settings apply to the other lookup types. They are all listed in
2228 &_src/EDITME_&. In many cases the relevant include files and interface
2229 libraries need to be installed before compiling Exim.
2230 .cindex "cdb" "including support for"
2231 However, there are some optional lookup types (such as cdb) for which
2232 the code is entirely contained within Exim, and no external include
2233 files or libraries are required. When a lookup type is not included in the
2234 binary, attempts to configure Exim to use it cause runtime configuration
2235 errors.
2236
2237 .cindex "pkg-config" "lookups"
2238 .cindex "pkg-config" "authenticators"
2239 Many systems now use a tool called &'pkg-config'& to encapsulate information
2240 about how to compile against a library; Exim has some initial support for
2241 being able to use pkg-config for lookups and authenticators.  For any given
2242 makefile variable which starts &`LOOKUP_`& or &`AUTH_`&, you can add a new
2243 variable with the &`_PC`& suffix in the name and assign as the value the
2244 name of the package to be queried.  The results of querying via the
2245 &'pkg-config'& command will be added to the appropriate Makefile variables
2246 with &`+=`& directives, so your version of &'make'& will need to support that
2247 syntax.  For instance:
2248 .code
2249 LOOKUP_SQLITE=yes
2250 LOOKUP_SQLITE_PC=sqlite3
2251 AUTH_GSASL=yes
2252 AUTH_GSASL_PC=libgsasl
2253 AUTH_HEIMDAL_GSSAPI=yes
2254 AUTH_HEIMDAL_GSSAPI_PC=heimdal-gssapi
2255 .endd
2256
2257 .cindex "Perl" "including support for"
2258 Exim can be linked with an embedded Perl interpreter, allowing Perl
2259 subroutines to be called during string expansion. To enable this facility,
2260 .code
2261 EXIM_PERL=perl.o
2262 .endd
2263 must be defined in &_Local/Makefile_&. Details of this facility are given in
2264 chapter &<<CHAPperl>>&.
2265
2266 .cindex "X11 libraries, location of"
2267 The location of the X11 libraries is something that varies a lot between
2268 operating systems, and there may be different versions of X11 to cope
2269 with. Exim itself makes no use of X11, but if you are compiling the Exim
2270 monitor, the X11 libraries must be available.
2271 The following three variables are set in &_OS/Makefile-Default_&:
2272 .code
2273 X11=/usr/X11R6
2274 XINCLUDE=-I$(X11)/include
2275 XLFLAGS=-L$(X11)/lib
2276 .endd
2277 These are overridden in some of the operating-system configuration files. For
2278 example, in &_OS/Makefile-SunOS5_& there is
2279 .code
2280 X11=/usr/openwin
2281 XINCLUDE=-I$(X11)/include
2282 XLFLAGS=-L$(X11)/lib -R$(X11)/lib
2283 .endd
2284 If you need to override the default setting for your operating system, place a
2285 definition of all three of these variables into your
2286 &_Local/Makefile-<ostype>_& file.
2287
2288 .cindex "EXTRALIBS"
2289 If you need to add any extra libraries to the link steps, these can be put in a
2290 variable called EXTRALIBS, which appears in all the link commands, but by
2291 default is not defined. In contrast, EXTRALIBS_EXIM is used only on the
2292 command for linking the main Exim binary, and not for any associated utilities.
2293
2294 .cindex "DBM libraries" "configuration for building"
2295 There is also DBMLIB, which appears in the link commands for binaries that
2296 use DBM functions (see also section &<<SECTdb>>&). Finally, there is
2297 EXTRALIBS_EXIMON, which appears only in the link step for the Exim monitor
2298 binary, and which can be used, for example, to include additional X11
2299 libraries.
2300
2301 .cindex "configuration file" "editing"
2302 The make file copes with rebuilding Exim correctly if any of the configuration
2303 files are edited. However, if an optional configuration file is deleted, it is
2304 necessary to touch the associated non-optional file (that is,
2305 &_Local/Makefile_& or &_Local/eximon.conf_&) before rebuilding.
2306
2307
2308 .section "OS-specific header files" "SECID30"
2309 .cindex "&_os.h_&"
2310 .cindex "building Exim" "OS-specific C header files"
2311 The &_OS_& directory contains a number of files with names of the form
2312 &_os.h-<ostype>_&. These are system-specific C header files that should not
2313 normally need to be changed. There is a list of macro settings that are
2314 recognized in the file &_OS/os.configuring_&, which should be consulted if you
2315 are porting Exim to a new operating system.
2316
2317
2318
2319 .section "Overriding build-time options for the monitor" "SECID31"
2320 .cindex "building Eximon"
2321 A similar process is used for overriding things when building the Exim monitor,
2322 where the files that are involved are
2323 .display
2324 &_OS/eximon.conf-Default_&
2325 &_OS/eximon.conf-_&<&'ostype'&>
2326 &_Local/eximon.conf_&
2327 &_Local/eximon.conf-_&<&'ostype'&>
2328 &_Local/eximon.conf-_&<&'archtype'&>
2329 &_Local/eximon.conf-_&<&'ostype'&>-<&'archtype'&>
2330 .endd
2331 .cindex "&_Local/eximon.conf_&"
2332 As with Exim itself, the final three files need not exist, and in this case the
2333 &_OS/eximon.conf-<ostype>_& file is also optional. The default values in
2334 &_OS/eximon.conf-Default_& can be overridden dynamically by setting environment
2335 variables of the same name, preceded by EXIMON_. For example, setting
2336 EXIMON_LOG_DEPTH in the environment overrides the value of
2337 LOG_DEPTH at runtime.
2338 .ecindex IIDbuex
2339
2340
2341 .section "Installing Exim binaries and scripts" "SECID32"
2342 .cindex "installing Exim"
2343 .cindex "BIN_DIRECTORY"
2344 The command &`make install`& runs the &(exim_install)& script with no
2345 arguments. The script copies binaries and utility scripts into the directory
2346 whose name is specified by the BIN_DIRECTORY setting in &_Local/Makefile_&.
2347 .cindex "setuid" "installing Exim with"
2348 The install script copies files only if they are newer than the files they are
2349 going to replace. The Exim binary is required to be owned by root and have the
2350 &'setuid'& bit set, for normal configurations. Therefore, you must run &`make
2351 install`& as root so that it can set up the Exim binary in this way. However, in
2352 some special situations (for example, if a host is doing no local deliveries)
2353 it may be possible to run Exim without making the binary setuid root (see
2354 chapter &<<CHAPsecurity>>& for details).
2355
2356 .cindex "CONFIGURE_FILE"
2357 Exim's runtime configuration file is named by the CONFIGURE_FILE setting
2358 in &_Local/Makefile_&. If this names a single file, and the file does not
2359 exist, the default configuration file &_src/configure.default_& is copied there
2360 by the installation script. If a runtime configuration file already exists, it
2361 is left alone. If CONFIGURE_FILE is a colon-separated list, naming several
2362 alternative files, no default is installed.
2363
2364 .cindex "system aliases file"
2365 .cindex "&_/etc/aliases_&"
2366 One change is made to the default configuration file when it is installed: the
2367 default configuration contains a router that references a system aliases file.
2368 The path to this file is set to the value specified by
2369 SYSTEM_ALIASES_FILE in &_Local/Makefile_& (&_/etc/aliases_& by default).
2370 If the system aliases file does not exist, the installation script creates it,
2371 and outputs a comment to the user.
2372
2373 The created file contains no aliases, but it does contain comments about the
2374 aliases a site should normally have. Mail aliases have traditionally been
2375 kept in &_/etc/aliases_&. However, some operating systems are now using
2376 &_/etc/mail/aliases_&. You should check if yours is one of these, and change
2377 Exim's configuration if necessary.
2378
2379 The default configuration uses the local host's name as the only local domain,
2380 and is set up to do local deliveries into the shared directory &_/var/mail_&,
2381 running as the local user. System aliases and &_.forward_& files in users' home
2382 directories are supported, but no NIS or NIS+ support is configured. Domains
2383 other than the name of the local host are routed using the DNS, with delivery
2384 over SMTP.
2385
2386 It is possible to install Exim for special purposes (such as building a binary
2387 distribution) in a private part of the file system. You can do this by a
2388 command such as
2389 .code
2390 make DESTDIR=/some/directory/ install
2391 .endd
2392 This has the effect of pre-pending the specified directory to all the file
2393 paths, except the name of the system aliases file that appears in the default
2394 configuration. (If a default alias file is created, its name &'is'& modified.)
2395 For backwards compatibility, ROOT is used if DESTDIR is not set,
2396 but this usage is deprecated.
2397
2398 .cindex "installing Exim" "what is not installed"
2399 Running &'make install'& does not copy the Exim 4 conversion script
2400 &'convert4r4'&. You will probably run this only once if you are
2401 upgrading from Exim 3. None of the documentation files in the &_doc_&
2402 directory are copied, except for the info files when you have set
2403 INFO_DIRECTORY, as described in section &<<SECTinsinfdoc>>& below.
2404
2405 For the utility programs, old versions are renamed by adding the suffix &_.O_&
2406 to their names. The Exim binary itself, however, is handled differently. It is
2407 installed under a name that includes the version number and the compile number,
2408 for example, &_exim-&version()-1_&. The script then arranges for a symbolic link
2409 called &_exim_& to point to the binary. If you are updating a previous version
2410 of Exim, the script takes care to ensure that the name &_exim_& is never absent
2411 from the directory (as seen by other processes).
2412
2413 .cindex "installing Exim" "testing the script"
2414 If you want to see what the &'make install'& will do before running it for
2415 real, you can pass the &%-n%& option to the installation script by this
2416 command:
2417 .code
2418 make INSTALL_ARG=-n install
2419 .endd
2420 The contents of the variable INSTALL_ARG are passed to the installation
2421 script. You do not need to be root to run this test. Alternatively, you can run
2422 the installation script directly, but this must be from within the build
2423 directory. For example, from the top-level Exim directory you could use this
2424 command:
2425 .code
2426 (cd build-SunOS5-5.5.1-sparc; ../scripts/exim_install -n)
2427 .endd
2428 .cindex "installing Exim" "install script options"
2429 There are two other options that can be supplied to the installation script.
2430
2431 .ilist
2432 &%-no_chown%& bypasses the call to change the owner of the installed binary
2433 to root, and the call to make it a setuid binary.
2434 .next
2435 &%-no_symlink%& bypasses the setting up of the symbolic link &_exim_& to the
2436 installed binary.
2437 .endlist
2438
2439 INSTALL_ARG can be used to pass these options to the script. For example:
2440 .code
2441 make INSTALL_ARG=-no_symlink install
2442 .endd
2443 The installation script can also be given arguments specifying which files are
2444 to be copied. For example, to install just the Exim binary, and nothing else,
2445 without creating the symbolic link, you could use:
2446 .code
2447 make INSTALL_ARG='-no_symlink exim' install
2448 .endd
2449
2450
2451
2452 .section "Installing info documentation" "SECTinsinfdoc"
2453 .cindex "installing Exim" "&'info'& documentation"
2454 Not all systems use the GNU &'info'& system for documentation, and for this
2455 reason, the Texinfo source of Exim's documentation is not included in the main
2456 distribution. Instead it is available separately from the FTP site (see section
2457 &<<SECTavail>>&).
2458
2459 If you have defined INFO_DIRECTORY in &_Local/Makefile_& and the Texinfo
2460 source of the documentation is found in the source tree, running &`make
2461 install`& automatically builds the info files and installs them.
2462
2463
2464
2465 .section "Setting up the spool directory" "SECID33"
2466 .cindex "spool directory" "creating"
2467 When it starts up, Exim tries to create its spool directory if it does not
2468 exist. The Exim uid and gid are used for the owner and group of the spool
2469 directory. Sub-directories are automatically created in the spool directory as
2470 necessary.
2471
2472
2473
2474
2475 .section "Testing" "SECID34"
2476 .cindex "testing" "installation"
2477 Having installed Exim, you can check that the runtime configuration file is
2478 syntactically valid by running the following command, which assumes that the
2479 Exim binary directory is within your PATH environment variable:
2480 .code
2481 exim -bV
2482 .endd
2483 If there are any errors in the configuration file, Exim outputs error messages.
2484 Otherwise it outputs the version number and build date,
2485 the DBM library that is being used, and information about which drivers and
2486 other optional code modules are included in the binary.
2487 Some simple routing tests can be done by using the address testing option. For
2488 example,
2489 .display
2490 &`exim -bt`& <&'local username'&>
2491 .endd
2492 should verify that it recognizes a local mailbox, and
2493 .display
2494 &`exim -bt`& <&'remote address'&>
2495 .endd
2496 a remote one. Then try getting it to deliver mail, both locally and remotely.
2497 This can be done by passing messages directly to Exim, without going through a
2498 user agent. For example:
2499 .code
2500 exim -v postmaster@your.domain.example
2501 From: user@your.domain.example
2502 To: postmaster@your.domain.example
2503 Subject: Testing Exim
2504
2505 This is a test message.
2506 ^D
2507 .endd
2508 The &%-v%& option causes Exim to output some verification of what it is doing.
2509 In this case you should see copies of three log lines, one for the message's
2510 arrival, one for its delivery, and one containing &"Completed"&.
2511
2512 .cindex "delivery" "problems with"
2513 If you encounter problems, look at Exim's log files (&'mainlog'& and
2514 &'paniclog'&) to see if there is any relevant information there. Another source
2515 of information is running Exim with debugging turned on, by specifying the
2516 &%-d%& option. If a message is stuck on Exim's spool, you can force a delivery
2517 with debugging turned on by a command of the form
2518 .display
2519 &`exim -d -M`& <&'exim-message-id'&>
2520 .endd
2521 You must be root or an &"admin user"& in order to do this. The &%-d%& option
2522 produces rather a lot of output, but you can cut this down to specific areas.
2523 For example, if you use &%-d-all+route%& only the debugging information
2524 relevant to routing is included. (See the &%-d%& option in chapter
2525 &<<CHAPcommandline>>& for more details.)
2526
2527 .cindex '&"sticky"& bit'
2528 .cindex "lock files"
2529 One specific problem that has shown up on some sites is the inability to do
2530 local deliveries into a shared mailbox directory, because it does not have the
2531 &"sticky bit"& set on it. By default, Exim tries to create a lock file before
2532 writing to a mailbox file, and if it cannot create the lock file, the delivery
2533 is deferred. You can get round this either by setting the &"sticky bit"& on the
2534 directory, or by setting a specific group for local deliveries and allowing
2535 that group to create files in the directory (see the comments above the
2536 &(local_delivery)& transport in the default configuration file). Another
2537 approach is to configure Exim not to use lock files, but just to rely on
2538 &[fcntl()]& locking instead. However, you should do this only if all user
2539 agents also use &[fcntl()]& locking. For further discussion of locking issues,
2540 see chapter &<<CHAPappendfile>>&.
2541
2542 One thing that cannot be tested on a system that is already running an MTA is
2543 the receipt of incoming SMTP mail on the standard SMTP port. However, the
2544 &%-oX%& option can be used to run an Exim daemon that listens on some other
2545 port, or &'inetd'& can be used to do this. The &%-bh%& option and the
2546 &'exim_checkaccess'& utility can be used to check out policy controls on
2547 incoming SMTP mail.
2548
2549 Testing a new version on a system that is already running Exim can most easily
2550 be done by building a binary with a different CONFIGURE_FILE setting. From
2551 within the runtime configuration, all other file and directory names
2552 that Exim uses can be altered, in order to keep it entirely clear of the
2553 production version.
2554
2555
2556 .section "Replacing another MTA with Exim" "SECID35"
2557 .cindex "replacing another MTA"
2558 Building and installing Exim for the first time does not of itself put it in
2559 general use. The name by which the system's MTA is called by mail user agents
2560 is either &_/usr/sbin/sendmail_&, or &_/usr/lib/sendmail_& (depending on the
2561 operating system), and it is necessary to make this name point to the &'exim'&
2562 binary in order to get the user agents to pass messages to Exim. This is
2563 normally done by renaming any existing file and making &_/usr/sbin/sendmail_&
2564 or &_/usr/lib/sendmail_&
2565 .cindex "symbolic link" "to &'exim'& binary"
2566 a symbolic link to the &'exim'& binary. It is a good idea to remove any setuid
2567 privilege and executable status from the old MTA. It is then necessary to stop
2568 and restart the mailer daemon, if one is running.
2569
2570 .cindex "FreeBSD, MTA indirection"
2571 .cindex "&_/etc/mail/mailer.conf_&"
2572 Some operating systems have introduced alternative ways of switching MTAs. For
2573 example, if you are running FreeBSD, you need to edit the file
2574 &_/etc/mail/mailer.conf_& instead of setting up a symbolic link as just
2575 described. A typical example of the contents of this file for running Exim is
2576 as follows:
2577 .code
2578 sendmail            /usr/exim/bin/exim
2579 send-mail           /usr/exim/bin/exim
2580 mailq               /usr/exim/bin/exim -bp
2581 newaliases          /usr/bin/true
2582 .endd
2583 Once you have set up the symbolic link, or edited &_/etc/mail/mailer.conf_&,
2584 your Exim installation is &"live"&. Check it by sending a message from your
2585 favourite user agent.
2586
2587 You should consider what to tell your users about the change of MTA. Exim may
2588 have different capabilities to what was previously running, and there are
2589 various operational differences such as the text of messages produced by
2590 command line options and in bounce messages. If you allow your users to make
2591 use of Exim's filtering capabilities, you should make the document entitled
2592 &'Exim's interface to mail filtering'& available to them.
2593
2594
2595
2596 .section "Upgrading Exim" "SECID36"
2597 .cindex "upgrading Exim"
2598 If you are already running Exim on your host, building and installing a new
2599 version automatically makes it available to MUAs, or any other programs that
2600 call the MTA directly. However, if you are running an Exim daemon, you do need
2601 .cindex restart "on HUP signal"
2602 .cindex signal "HUP, to restart"
2603 to send it a HUP signal, to make it re-execute itself, and thereby pick up the
2604 new binary. You do not need to stop processing mail in order to install a new
2605 version of Exim. The install script does not modify an existing runtime
2606 configuration file.
2607
2608
2609
2610
2611 .section "Stopping the Exim daemon on Solaris" "SECID37"
2612 .cindex "Solaris" "stopping Exim on"
2613 The standard command for stopping the mailer daemon on Solaris is
2614 .code
2615 /etc/init.d/sendmail stop
2616 .endd
2617 If &_/usr/lib/sendmail_& has been turned into a symbolic link, this script
2618 fails to stop Exim because it uses the command &'ps -e'& and greps the output
2619 for the text &"sendmail"&; this is not present because the actual program name
2620 (that is, &"exim"&) is given by the &'ps'& command with these options. A
2621 solution is to replace the line that finds the process id with something like
2622 .code
2623 pid=`cat /var/spool/exim/exim-daemon.pid`
2624 .endd
2625 to obtain the daemon's pid directly from the file that Exim saves it in.
2626
2627 Note, however, that stopping the daemon does not &"stop Exim"&. Messages can
2628 still be received from local processes, and if automatic delivery is configured
2629 (the normal case), deliveries will still occur.
2630
2631
2632
2633
2634 . ////////////////////////////////////////////////////////////////////////////
2635 . ////////////////////////////////////////////////////////////////////////////
2636
2637 .chapter "The Exim command line" "CHAPcommandline"
2638 .scindex IIDclo1 "command line" "options"
2639 .scindex IIDclo2 "options" "command line"
2640 Exim's command line takes the standard Unix form of a sequence of options,
2641 each starting with a hyphen character, followed by a number of arguments. The
2642 options are compatible with the main options of Sendmail, and there are also
2643 some additional options, some of which are compatible with Smail 3. Certain
2644 combinations of options do not make sense, and provoke an error if used.
2645 The form of the arguments depends on which options are set.
2646
2647
2648 .section "Setting options by program name" "SECID38"
2649 .cindex "&'mailq'&"
2650 If Exim is called under the name &'mailq'&, it behaves as if the option &%-bp%&
2651 were present before any other options.
2652 The &%-bp%& option requests a listing of the contents of the mail queue on the
2653 standard output.
2654 This feature is for compatibility with some systems that contain a command of
2655 that name in one of the standard libraries, symbolically linked to
2656 &_/usr/sbin/sendmail_& or &_/usr/lib/sendmail_&.
2657
2658 .cindex "&'rsmtp'&"
2659 If Exim is called under the name &'rsmtp'& it behaves as if the option &%-bS%&
2660 were present before any other options, for compatibility with Smail. The
2661 &%-bS%& option is used for reading in a number of messages in batched SMTP
2662 format.
2663
2664 .cindex "&'rmail'&"
2665 If Exim is called under the name &'rmail'& it behaves as if the &%-i%& and
2666 &%-oee%& options were present before any other options, for compatibility with
2667 Smail. The name &'rmail'& is used as an interface by some UUCP systems.
2668
2669 .cindex "&'runq'&"
2670 .cindex "queue runner"
2671 If Exim is called under the name &'runq'& it behaves as if the option &%-q%&
2672 were present before any other options, for compatibility with Smail. The &%-q%&
2673 option causes a single queue runner process to be started.
2674
2675 .cindex "&'newaliases'&"
2676 .cindex "alias file" "building"
2677 .cindex "Sendmail compatibility" "calling Exim as &'newaliases'&"
2678 If Exim is called under the name &'newaliases'& it behaves as if the option
2679 &%-bi%& were present before any other options, for compatibility with Sendmail.
2680 This option is used for rebuilding Sendmail's alias file. Exim does not have
2681 the concept of a single alias file, but can be configured to run a given
2682 command if called with the &%-bi%& option.
2683
2684
2685 .section "Trusted and admin users" "SECTtrustedadmin"
2686 Some Exim options are available only to &'trusted users'& and others are
2687 available only to &'admin users'&. In the description below, the phrases &"Exim
2688 user"& and &"Exim group"& mean the user and group defined by EXIM_USER and
2689 EXIM_GROUP in &_Local/Makefile_& or set by the &%exim_user%& and
2690 &%exim_group%& options. These do not necessarily have to use the name &"exim"&.
2691
2692 .ilist
2693 .cindex "trusted users" "definition of"
2694 .cindex "user" "trusted definition of"
2695 The trusted users are root, the Exim user, any user listed in the
2696 &%trusted_users%& configuration option, and any user whose current group or any
2697 supplementary group is one of those listed in the &%trusted_groups%&
2698 configuration option. Note that the Exim group is not automatically trusted.
2699
2700 .cindex '&"From"& line'
2701 .cindex "envelope from"
2702 .cindex "envelope sender"
2703 Trusted users are always permitted to use the &%-f%& option or a leading
2704 &"From&~"& line to specify the envelope sender of a message that is passed to
2705 Exim through the local interface (see the &%-bm%& and &%-f%& options below).
2706 See the &%untrusted_set_sender%& option for a way of permitting non-trusted
2707 users to set envelope senders.
2708
2709 .chindex From:
2710 .chindex Sender:
2711 For a trusted user, there is never any check on the contents of the &'From:'&
2712 header line, and a &'Sender:'& line is never added. Furthermore, any existing
2713 &'Sender:'& line in incoming local (non-TCP/IP) messages is not removed.
2714
2715 Trusted users may also specify a host name, host address, interface address,
2716 protocol name, ident value, and authentication data when submitting a message
2717 locally. Thus, they are able to insert messages into Exim's queue locally that
2718 have the characteristics of messages received from a remote host. Untrusted
2719 users may in some circumstances use &%-f%&, but can never set the other values
2720 that are available to trusted users.
2721 .next
2722 .cindex "user" "admin definition of"
2723 .cindex "admin user" "definition of"
2724 The admin users are root, the Exim user, and any user that is a member of the
2725 Exim group or of any group listed in the &%admin_groups%& configuration option.
2726 The current group does not have to be one of these groups.
2727
2728 Admin users are permitted to list the queue, and to carry out certain
2729 operations on messages, for example, to force delivery failures. It is also
2730 necessary to be an admin user in order to see the full information provided by
2731 the Exim monitor, and full debugging output.
2732
2733 By default, the use of the &%-M%&, &%-q%&, &%-R%&, and &%-S%& options to cause
2734 Exim to attempt delivery of messages on its queue is restricted to admin users.
2735 However, this restriction can be relaxed by setting the &%prod_requires_admin%&
2736 option false (that is, specifying &%no_prod_requires_admin%&).
2737
2738 Similarly, the use of the &%-bp%& option to list all the messages in the queue
2739 is restricted to admin users unless &%queue_list_requires_admin%& is set
2740 false.
2741 .endlist
2742
2743
2744 &*Warning*&: If you configure your system so that admin users are able to
2745 edit Exim's configuration file, you are giving those users an easy way of
2746 getting root. There is further discussion of this issue at the start of chapter
2747 &<<CHAPconf>>&.
2748
2749
2750
2751
2752 .section "Command line options" "SECID39"
2753 Exim's command line options are described in alphabetical order below. If none
2754 of the options that specifies a specific action (such as starting the daemon or
2755 a queue runner, or testing an address, or receiving a message in a specific
2756 format, or listing the queue) are present, and there is at least one argument
2757 on the command line, &%-bm%& (accept a local message on the standard input,
2758 with the arguments specifying the recipients) is assumed. Otherwise, Exim
2759 outputs a brief message about itself and exits.
2760
2761 . ////////////////////////////////////////////////////////////////////////////
2762 . Insert a stylized XML comment here, to identify the start of the command line
2763 . options. This is for the benefit of the Perl script that automatically
2764 . creates a man page for the options.
2765 . ////////////////////////////////////////////////////////////////////////////
2766
2767 .literal xml
2768 <!-- === Start of command line options === -->
2769 .literal off
2770
2771
2772 .vlist
2773 .vitem &%--%&
2774 .oindex "--"
2775 .cindex "options" "command line; terminating"
2776 This is a pseudo-option whose only purpose is to terminate the options and
2777 therefore to cause subsequent command line items to be treated as arguments
2778 rather than options, even if they begin with hyphens.
2779
2780 .vitem &%--help%&
2781 .oindex "&%--help%&"
2782 This option causes Exim to output a few sentences stating what it is.
2783 The same output is generated if the Exim binary is called with no options and
2784 no arguments.
2785
2786 .vitem &%--version%&
2787 .oindex "&%--version%&"
2788 This option is an alias for &%-bV%& and causes version information to be
2789 displayed.
2790
2791 .vitem &%-Ac%& &&&
2792        &%-Am%&
2793 .oindex "&%-Ac%&"
2794 .oindex "&%-Am%&"
2795 These options are used by Sendmail for selecting configuration files and are
2796 ignored by Exim.
2797
2798 .vitem &%-B%&<&'type'&>
2799 .oindex "&%-B%&"
2800 .cindex "8-bit characters"
2801 .cindex "Sendmail compatibility" "8-bit characters"
2802 This is a Sendmail option for selecting 7 or 8 bit processing. Exim is 8-bit
2803 clean; it ignores this option.
2804
2805 .vitem &%-bd%&
2806 .oindex "&%-bd%&"
2807 .cindex "daemon"
2808 .cindex "SMTP" "listener"
2809 .cindex "queue runner"
2810 This option runs Exim as a daemon, awaiting incoming SMTP connections. Usually
2811 the &%-bd%& option is combined with the &%-q%&<&'time'&> option, to specify
2812 that the daemon should also initiate periodic queue runs.
2813
2814 The &%-bd%& option can be used only by an admin user. If either of the &%-d%&
2815 (debugging) or &%-v%& (verifying) options are set, the daemon does not
2816 disconnect from the controlling terminal. When running this way, it can be
2817 stopped by pressing ctrl-C.
2818
2819 By default, Exim listens for incoming connections to the standard SMTP port on
2820 all the host's running interfaces. However, it is possible to listen on other
2821 ports, on multiple ports, and only on specific interfaces. Chapter
2822 &<<CHAPinterfaces>>& contains a description of the options that control this.
2823
2824 When a listening daemon
2825 .cindex "daemon" "process id (pid)"
2826 .cindex "pid (process id)" "of daemon"
2827 is started without the use of &%-oX%& (that is, without overriding the normal
2828 configuration), it writes its process id to a file called &_exim-daemon.pid_&
2829 in Exim's spool directory. This location can be overridden by setting
2830 PID_FILE_PATH in &_Local/Makefile_&. The file is written while Exim is still
2831 running as root.
2832
2833 When &%-oX%& is used on the command line to start a listening daemon, the
2834 process id is not written to the normal pid file path. However, &%-oP%& can be
2835 used to specify a path on the command line if a pid file is required.
2836
2837 The SIGHUP signal
2838 .cindex "SIGHUP"
2839 .cindex restart "on HUP signal"
2840 .cindex signal "HUP, to restart"
2841 .cindex "daemon" "restarting"
2842 .cindex signal "to reload configuration"
2843 .cindex daemon "reload configuration"
2844 .cindex reload configuration
2845 can be used to cause the daemon to re-execute itself. This should be done
2846 whenever Exim's configuration file, or any file that is incorporated into it by
2847 means of the &%.include%& facility, is changed, and also whenever a new version
2848 of Exim is installed. It is not necessary to do this when other files that are
2849 referenced from the configuration (for example, alias files) are changed,
2850 because these are reread each time they are used.
2851
2852 .vitem &%-bdf%&
2853 .oindex "&%-bdf%&"
2854 This option has the same effect as &%-bd%& except that it never disconnects
2855 from the controlling terminal, even when no debugging is specified.
2856
2857 .vitem &%-be%&
2858 .oindex "&%-be%&"
2859 .cindex "testing" "string expansion"
2860 .cindex "expansion" "testing"
2861 Run Exim in expansion testing mode. Exim discards its root privilege, to
2862 prevent ordinary users from using this mode to read otherwise inaccessible
2863 files. If no arguments are given, Exim runs interactively, prompting for lines
2864 of data. Otherwise, it processes each argument in turn.
2865
2866 If Exim was built with USE_READLINE=yes in &_Local/Makefile_&, it tries
2867 to load the &%libreadline%& library dynamically whenever the &%-be%& option is
2868 used without command line arguments. If successful, it uses the &[readline()]&
2869 function, which provides extensive line-editing facilities, for reading the
2870 test data. A line history is supported.
2871
2872 Long expansion expressions can be split over several lines by using backslash
2873 continuations. As in Exim's runtime configuration, white space at the start of
2874 continuation lines is ignored. Each argument or data line is passed through the
2875 string expansion mechanism, and the result is output. Variable values from the
2876 configuration file (for example, &$qualify_domain$&) are available, but no
2877 message-specific values (such as &$message_exim_id$&) are set, because no message
2878 is being processed (but see &%-bem%& and &%-Mset%&).
2879
2880 &*Note*&: If you use this mechanism to test lookups, and you change the data
2881 files or databases you are using, you must exit and restart Exim before trying
2882 the same lookup again. Otherwise, because each Exim process caches the results
2883 of lookups, you will just get the same result as before.
2884
2885 Macro processing is done on lines before string-expansion: new macros can be
2886 defined and macros will be expanded.
2887 Because macros in the config file are often used for secrets, those are only
2888 available to admin users.
2889
2890 .vitem &%-bem%&&~<&'filename'&>
2891 .oindex "&%-bem%&"
2892 .cindex "testing" "string expansion"
2893 .cindex "expansion" "testing"
2894 This option operates like &%-be%& except that it must be followed by the name
2895 of a file. For example:
2896 .code
2897 exim -bem /tmp/testmessage
2898 .endd
2899 The file is read as a message (as if receiving a locally-submitted non-SMTP
2900 message) before any of the test expansions are done. Thus, message-specific
2901 variables such as &$message_size$& and &$header_from:$& are available. However,
2902 no &'Received:'& header is added to the message. If the &%-t%& option is set,
2903 recipients are read from the headers in the normal way, and are shown in the
2904 &$recipients$& variable. Note that recipients cannot be given on the command
2905 line, because further arguments are taken as strings to expand (just like
2906 &%-be%&).
2907
2908 .vitem &%-bF%&&~<&'filename'&>
2909 .oindex "&%-bF%&"
2910 .cindex "system filter" "testing"
2911 .cindex "testing" "system filter"
2912 This option is the same as &%-bf%& except that it assumes that the filter being
2913 tested is a system filter. The additional commands that are available only in
2914 system filters are recognized.
2915
2916 .vitem &%-bf%&&~<&'filename'&>
2917 .oindex "&%-bf%&"
2918 .cindex "filter" "testing"
2919 .cindex "testing" "filter file"
2920 .cindex "forward file" "testing"
2921 .cindex "testing" "forward file"
2922 .cindex "Sieve filter" "testing"
2923 This option runs Exim in user filter testing mode; the file is the filter file
2924 to be tested, and a test message must be supplied on the standard input. If
2925 there are no message-dependent tests in the filter, an empty file can be
2926 supplied.
2927
2928 If you want to test a system filter file, use &%-bF%& instead of &%-bf%&. You
2929 can use both &%-bF%& and &%-bf%& on the same command, in order to test a system
2930 filter and a user filter in the same run. For example:
2931 .code
2932 exim -bF /system/filter -bf /user/filter </test/message
2933 .endd
2934 This is helpful when the system filter adds header lines or sets filter
2935 variables that are used by the user filter.
2936
2937 If the test filter file does not begin with one of the special lines
2938 .code
2939 # Exim filter
2940 # Sieve filter
2941 .endd
2942 it is taken to be a normal &_.forward_& file, and is tested for validity under
2943 that interpretation. See sections &<<SECTitenonfilred>>& to
2944 &<<SECTspecitredli>>& for a description of the possible contents of non-filter
2945 redirection lists.
2946
2947 The result of an Exim command that uses &%-bf%&, provided no errors are
2948 detected, is a list of the actions that Exim would try to take if presented
2949 with the message for real. More details of filter testing are given in the
2950 separate document entitled &'Exim's interfaces to mail filtering'&.
2951
2952 When testing a filter file,
2953 .cindex "&""From""& line"
2954 .cindex "envelope from"
2955 .cindex "envelope sender"
2956 .oindex "&%-f%&" "for filter testing"
2957 the envelope sender can be set by the &%-f%& option,
2958 or by a &"From&~"& line at the start of the test message. Various parameters
2959 that would normally be taken from the envelope recipient address of the message
2960 can be set by means of additional command line options (see the next four
2961 options).
2962
2963 .vitem &%-bfd%&&~<&'domain'&>
2964 .oindex "&%-bfd%&"
2965 .vindex "&$qualify_domain$&"
2966 This sets the domain of the recipient address when a filter file is being
2967 tested by means of the &%-bf%& option. The default is the value of
2968 &$qualify_domain$&.
2969
2970 .vitem &%-bfl%&&~<&'local&~part'&>
2971 .oindex "&%-bfl%&"
2972 This sets the local part of the recipient address when a filter file is being
2973 tested by means of the &%-bf%& option. The default is the username of the
2974 process that calls Exim. A local part should be specified with any prefix or
2975 suffix stripped, because that is how it appears to the filter when a message is
2976 actually being delivered.
2977
2978 .vitem &%-bfp%&&~<&'prefix'&>
2979 .oindex "&%-bfp%&"
2980 .cindex affix "filter testing"
2981 This sets the prefix of the local part of the recipient address when a filter
2982 file is being tested by means of the &%-bf%& option. The default is an empty
2983 prefix.
2984
2985 .vitem &%-bfs%&&~<&'suffix'&>
2986 .oindex "&%-bfs%&"
2987 .cindex affix "filter testing"
2988 This sets the suffix of the local part of the recipient address when a filter
2989 file is being tested by means of the &%-bf%& option. The default is an empty
2990 suffix.
2991
2992 .vitem &%-bh%&&~<&'IP&~address'&>
2993 .oindex "&%-bh%&"
2994 .cindex "testing" "incoming SMTP"
2995 .cindex "SMTP" "testing incoming"
2996 .cindex "testing" "relay control"
2997 .cindex "relaying" "testing configuration"
2998 .cindex "policy control" "testing"
2999 .cindex "debugging" "&%-bh%& option"
3000 This option runs a fake SMTP session as if from the given IP address, using the
3001 standard input and output. The IP address may include a port number at the end,
3002 after a full stop. For example:
3003 .code
3004 exim -bh 10.9.8.7.1234
3005 exim -bh fe80::a00:20ff:fe86:a061.5678
3006 .endd
3007 When an IPv6 address is given, it is converted into canonical form. In the case
3008 of the second example above, the value of &$sender_host_address$& after
3009 conversion to the canonical form is
3010 &`fe80:0000:0000:0a00:20ff:fe86:a061.5678`&.
3011
3012 Comments as to what is going on are written to the standard error file. These
3013 include lines beginning with &"LOG"& for anything that would have been logged.
3014 This facility is provided for testing configuration options for incoming
3015 messages, to make sure they implement the required policy. For example, you can
3016 test your relay controls using &%-bh%&.
3017
3018 &*Warning 1*&:
3019 .cindex "RFC 1413"
3020 You can test features of the configuration that rely on ident (RFC 1413)
3021 information by using the &%-oMt%& option. However, Exim cannot actually perform
3022 an ident callout when testing using &%-bh%& because there is no incoming SMTP
3023 connection.
3024
3025 &*Warning 2*&: Address verification callouts (see section &<<SECTcallver>>&)
3026 are also skipped when testing using &%-bh%&. If you want these callouts to
3027 occur, use &%-bhc%& instead.
3028
3029 Messages supplied during the testing session are discarded, and nothing is
3030 written to any of the real log files. There may be pauses when DNS (and other)
3031 lookups are taking place, and of course these may time out. The &%-oMi%& option
3032 can be used to specify a specific IP interface and port if this is important,
3033 and &%-oMaa%& and &%-oMai%& can be used to set parameters as if the SMTP
3034 session were authenticated.
3035
3036 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%& whose
3037 output just states whether a given recipient address from a given host is
3038 acceptable or not. See section &<<SECTcheckaccess>>&.
3039
3040 Features such as authentication and encryption, where the client input is not
3041 plain text, cannot easily be tested with &%-bh%&. Instead, you should use a
3042 specialized SMTP test program such as
3043 &url(https://www.jetmore.org/john/code/swaks/,swaks).
3044
3045 .vitem &%-bhc%&&~<&'IP&~address'&>
3046 .oindex "&%-bhc%&"
3047 This option operates in the same way as &%-bh%&, except that address
3048 verification callouts are performed if required. This includes consulting and
3049 updating the callout cache database.
3050
3051 .vitem &%-bi%&
3052 .oindex "&%-bi%&"
3053 .cindex "alias file" "building"
3054 .cindex "building alias file"
3055 .cindex "Sendmail compatibility" "&%-bi%& option"
3056 Sendmail interprets the &%-bi%& option as a request to rebuild its alias file.
3057 Exim does not have the concept of a single alias file, and so it cannot mimic
3058 this behaviour. However, calls to &_/usr/lib/sendmail_& with the &%-bi%& option
3059 tend to appear in various scripts such as NIS make files, so the option must be
3060 recognized.
3061
3062 If &%-bi%& is encountered, the command specified by the &%bi_command%&
3063 configuration option is run, under the uid and gid of the caller of Exim. If
3064 the &%-oA%& option is used, its value is passed to the command as an argument.
3065 The command set by &%bi_command%& may not contain arguments. The command can
3066 use the &'exim_dbmbuild'& utility, or some other means, to rebuild alias files
3067 if this is required. If the &%bi_command%& option is not set, calling Exim with
3068 &%-bi%& is a no-op.
3069
3070 . // Keep :help first, then the rest in alphabetical order
3071 .vitem &%-bI:help%&
3072 .oindex "&%-bI:help%&"
3073 .cindex "querying exim information"
3074 We shall provide various options starting &`-bI:`& for querying Exim for
3075 information.  The output of many of these will be intended for machine
3076 consumption.  This one is not.  The &%-bI:help%& option asks Exim for a
3077 synopsis of supported options beginning &`-bI:`&.  Use of any of these
3078 options shall cause Exim to exit after producing the requested output.
3079
3080 .vitem &%-bI:dscp%&
3081 .oindex "&%-bI:dscp%&"
3082 .cindex "DSCP" "values"
3083 This option causes Exim to emit an alphabetically sorted list of all
3084 recognised DSCP names.
3085
3086 .vitem &%-bI:sieve%&
3087 .oindex "&%-bI:sieve%&"
3088 .cindex "Sieve filter" "capabilities"
3089 This option causes Exim to emit an alphabetically sorted list of all supported
3090 Sieve protocol extensions on stdout, one per line.  This is anticipated to be
3091 useful for ManageSieve (RFC 5804) implementations, in providing that protocol's
3092 &`SIEVE`& capability response line.  As the precise list may depend upon
3093 compile-time build options, which this option will adapt to, this is the only
3094 way to guarantee a correct response.
3095
3096 .vitem &%-bm%&
3097 .oindex "&%-bm%&"
3098 .cindex "local message reception"
3099 This option runs an Exim receiving process that accepts an incoming,
3100 locally-generated message on the standard input. The recipients are given as the
3101 command arguments (except when &%-t%& is also present &-- see below). Each
3102 argument can be a comma-separated list of RFC 2822 addresses. This is the
3103 default option for selecting the overall action of an Exim call; it is assumed
3104 if no other conflicting option is present.
3105
3106 If any addresses in the message are unqualified (have no domain), they are
3107 qualified by the values of the &%qualify_domain%& or &%qualify_recipient%&
3108 options, as appropriate. The &%-bnq%& option (see below) provides a way of
3109 suppressing this for special cases.
3110
3111 Policy checks on the contents of local messages can be enforced by means of
3112 the non-SMTP ACL. See chapter &<<CHAPACL>>& for details.
3113
3114 .cindex "return code" "for &%-bm%&"
3115 The return code is zero if the message is successfully accepted. Otherwise, the
3116 action is controlled by the &%-oe%&&'x'& option setting &-- see below.
3117
3118 The format
3119 .cindex "message" "format"
3120 .cindex "format" "message"
3121 .cindex "&""From""& line"
3122 .cindex "UUCP" "&""From""& line"
3123 .cindex "Sendmail compatibility" "&""From""& line"
3124 of the message must be as defined in RFC 2822, except that, for
3125 compatibility with Sendmail and Smail, a line in one of the forms
3126 .code
3127 From sender Fri Jan  5 12:55 GMT 1997
3128 From sender Fri, 5 Jan 97 12:55:01
3129 .endd
3130 (with the weekday optional, and possibly with additional text after the date)
3131 is permitted to appear at the start of the message. There appears to be no
3132 authoritative specification of the format of this line. Exim recognizes it by
3133 matching against the regular expression defined by the &%uucp_from_pattern%&
3134 option, which can be changed if necessary.
3135
3136 .oindex "&%-f%&" "overriding &""From""& line"
3137 The specified sender is treated as if it were given as the argument to the
3138 &%-f%& option, but if a &%-f%& option is also present, its argument is used in
3139 preference to the address taken from the message. The caller of Exim must be a
3140 trusted user for the sender of a message to be set in this way.
3141
3142 .vitem &%-bmalware%&&~<&'filename'&>
3143 .oindex "&%-bmalware%&"
3144 .cindex "testing", "malware"
3145 .cindex "malware scan test"
3146 This debugging option causes Exim to scan the given file or directory
3147 (depending on the used scanner interface),
3148 using the malware scanning framework.  The option of &%av_scanner%& influences
3149 this option, so if &%av_scanner%&'s value is dependent upon an expansion then
3150 the expansion should have defaults which apply to this invocation.  ACLs are
3151 not invoked, so if &%av_scanner%& references an ACL variable then that variable
3152 will never be populated and &%-bmalware%& will fail.
3153
3154 Exim will have changed working directory before resolving the filename, so
3155 using fully qualified pathnames is advisable.  Exim will be running as the Exim
3156 user when it tries to open the file, rather than as the invoking user.
3157 This option requires admin privileges.
3158
3159 The &%-bmalware%& option will not be extended to be more generally useful,
3160 there are better tools for file-scanning.  This option exists to help
3161 administrators verify their Exim and AV scanner configuration.
3162
3163 .vitem &%-bnq%&
3164 .oindex "&%-bnq%&"
3165 .cindex "address qualification, suppressing"
3166 By default, Exim automatically qualifies unqualified addresses (those
3167 without domains) that appear in messages that are submitted locally (that
3168 is, not over TCP/IP). This qualification applies both to addresses in
3169 envelopes, and addresses in header lines. Sender addresses are qualified using
3170 &%qualify_domain%&, and recipient addresses using &%qualify_recipient%& (which
3171 defaults to the value of &%qualify_domain%&).
3172
3173 Sometimes, qualification is not wanted. For example, if &%-bS%& (batch SMTP) is
3174 being used to re-submit messages that originally came from remote hosts after
3175 content scanning, you probably do not want to qualify unqualified addresses in
3176 header lines. (Such lines will be present only if you have not enabled a header
3177 syntax check in the appropriate ACL.)
3178
3179 The &%-bnq%& option suppresses all qualification of unqualified addresses in
3180 messages that originate on the local host. When this is used, unqualified
3181 addresses in the envelope provoke errors (causing message rejection) and
3182 unqualified addresses in header lines are left alone.
3183
3184
3185 .vitem &%-bP%&
3186 .oindex "&%-bP%&"
3187 .cindex "configuration options" "extracting"
3188 .cindex "options" "configuration &-- extracting"
3189 If this option is given with no arguments, it causes the values of all Exim's
3190 main configuration options to be written to the standard output. The values
3191 of one or more specific options can be requested by giving their names as
3192 arguments, for example:
3193 .code
3194 exim -bP qualify_domain hold_domains
3195 .endd
3196 .cindex "hiding configuration option values"
3197 .cindex "configuration options" "hiding value of"
3198 .cindex "options" "hiding value of"
3199 However, any option setting that is preceded by the word &"hide"& in the
3200 configuration file is not shown in full, except to an admin user. For other
3201 users, the output is as in this example:
3202 .code
3203 mysql_servers = <value not displayable>
3204 .endd
3205 If &%config%& is given as an argument, the config is
3206 output, as it was parsed, any include file resolved, any comment removed.
3207
3208 If &%config_file%& is given as an argument, the name of the runtime
3209 configuration file is output. (&%configure_file%& works too, for
3210 backward compatibility.)
3211 If a list of configuration files was supplied, the value that is output here
3212 is the name of the file that was actually used.
3213
3214 .cindex "options" "hiding name of"
3215 If the &%-n%& flag is given, then for most modes of &%-bP%& operation the
3216 name will not be output.
3217
3218 .cindex "daemon" "process id (pid)"
3219 .cindex "pid (process id)" "of daemon"
3220 If &%log_file_path%& or &%pid_file_path%& are given, the names of the
3221 directories where log files and daemon pid files are written are output,
3222 respectively. If these values are unset, log files are written in a
3223 sub-directory of the spool directory called &%log%&, and the pid file is
3224 written directly into the spool directory.
3225
3226 If &%-bP%& is followed by a name preceded by &`+`&, for example,
3227 .code
3228 exim -bP +local_domains
3229 .endd
3230 it searches for a matching named list of any type (domain, host, address, or
3231 local part) and outputs what it finds.
3232
3233 .cindex "options" "router &-- extracting"
3234 .cindex "options" "transport &-- extracting"
3235 .cindex "options" "authenticator &-- extracting"
3236 If one of the words &%router%&, &%transport%&, or &%authenticator%& is given,
3237 followed by the name of an appropriate driver instance, the option settings for
3238 that driver are output. For example:
3239 .code
3240 exim -bP transport local_delivery
3241 .endd
3242 The generic driver options are output first, followed by the driver's private
3243 options. A list of the names of drivers of a particular type can be obtained by
3244 using one of the words &%router_list%&, &%transport_list%&, or
3245 &%authenticator_list%&, and a complete list of all drivers with their option
3246 settings can be obtained by using &%routers%&, &%transports%&, or
3247 &%authenticators%&.
3248
3249 .cindex "environment"
3250 If &%environment%& is given as an argument, the set of environment
3251 variables is output, line by line. Using the &%-n%& flag suppresses the value of the
3252 variables.
3253
3254 .cindex "options" "macro &-- extracting"
3255 If invoked by an admin user, then &%macro%&, &%macro_list%& and &%macros%&
3256 are available, similarly to the drivers.  Because macros are sometimes used
3257 for storing passwords, this option is restricted.
3258 The output format is one item per line.
3259 For the "-bP macro <name>" form, if no such macro is found
3260 the exit status will be nonzero.
3261
3262 .vitem &%-bp%&
3263 .oindex "&%-bp%&"
3264 .cindex "queue" "listing messages in"
3265 .cindex "listing" "messages in the queue"
3266 This option requests a listing of the contents of the mail queue on the
3267 standard output. If the &%-bp%& option is followed by a list of message ids,
3268 just those messages are listed. By default, this option can be used only by an
3269 admin user. However, the &%queue_list_requires_admin%& option can be set false
3270 to allow any user to see the queue.
3271
3272 Each message in the queue is displayed as in the following example:
3273 .code
3274 25m  2.9K 0t5C6f-0000c8-00 <alice@wonderland.fict.example>
3275           red.king@looking-glass.fict.example
3276           <other addresses>
3277 .endd
3278 .cindex "message" "size in queue listing"
3279 .cindex "size" "of message"
3280 The first line contains the length of time the message has been in the queue
3281 (in this case 25 minutes), the size of the message (2.9K), the unique local
3282 identifier for the message, and the message sender, as contained in the
3283 envelope. For bounce messages, the sender address is empty, and appears as
3284 &"<>"&. If the message was submitted locally by an untrusted user who overrode
3285 the default sender address, the user's login name is shown in parentheses
3286 before the sender address.
3287
3288 .cindex "frozen messages" "in queue listing"
3289 If the message is frozen (attempts to deliver it are suspended) then the text
3290 &"*** frozen ***"& is displayed at the end of this line.
3291
3292 The recipients of the message (taken from the envelope, not the headers) are
3293 displayed on subsequent lines. Those addresses to which the message has already
3294 been delivered are marked with the letter D. If an original address gets
3295 expanded into several addresses via an alias or forward file, the original is
3296 displayed with a D only when deliveries for all of its child addresses are
3297 complete.
3298
3299
3300 .vitem &%-bpa%&
3301 .oindex "&%-bpa%&"
3302 This option operates like &%-bp%&, but in addition it shows delivered addresses
3303 that were generated from the original top level address(es) in each message by
3304 alias or forwarding operations. These addresses are flagged with &"+D"& instead
3305 of just &"D"&.
3306
3307
3308 .vitem &%-bpc%&
3309 .oindex "&%-bpc%&"
3310 .cindex "queue" "count of messages on"
3311 This option counts the number of messages in the queue, and writes the total
3312 to the standard output. It is restricted to admin users, unless
3313 &%queue_list_requires_admin%& is set false.
3314
3315
3316 .vitem &%-bpr%&
3317 .oindex "&%-bpr%&"
3318 This option operates like &%-bp%&, but the output is not sorted into
3319 chronological order of message arrival. This can speed it up when there are
3320 lots of messages in the queue, and is particularly useful if the output is
3321 going to be post-processed in a way that doesn't need the sorting.
3322
3323 .vitem &%-bpra%&
3324 .oindex "&%-bpra%&"
3325 This option is a combination of &%-bpr%& and &%-bpa%&.
3326
3327 .vitem &%-bpru%&
3328 .oindex "&%-bpru%&"
3329 This option is a combination of &%-bpr%& and &%-bpu%&.
3330
3331
3332 .vitem &%-bpu%&
3333 .oindex "&%-bpu%&"
3334 This option operates like &%-bp%& but shows only undelivered top-level
3335 addresses for each message displayed. Addresses generated by aliasing or
3336 forwarding are not shown, unless the message was deferred after processing by a
3337 router with the &%one_time%& option set.
3338
3339
3340 .vitem &%-brt%&
3341 .oindex "&%-brt%&"
3342 .cindex "testing" "retry configuration"
3343 .cindex "retry" "configuration testing"
3344 This option is for testing retry rules, and it must be followed by up to three
3345 arguments. It causes Exim to look for a retry rule that matches the values
3346 and to write it to the standard output. For example:
3347 .code
3348 exim -brt bach.comp.mus.example
3349 Retry rule: *.comp.mus.example  F,2h,15m; F,4d,30m;
3350 .endd
3351 See chapter &<<CHAPretry>>& for a description of Exim's retry rules. The first
3352 argument, which is required, can be a complete address in the form
3353 &'local_part@domain'&, or it can be just a domain name. If the second argument
3354 contains a dot, it is interpreted as an optional second domain name; if no
3355 retry rule is found for the first argument, the second is tried. This ties in
3356 with Exim's behaviour when looking for retry rules for remote hosts &-- if no
3357 rule is found that matches the host, one that matches the mail domain is
3358 sought. Finally, an argument that is the name of a specific delivery error, as
3359 used in setting up retry rules, can be given. For example:
3360 .code
3361 exim -brt haydn.comp.mus.example quota_3d
3362 Retry rule: *@haydn.comp.mus.example quota_3d  F,1h,15m
3363 .endd
3364
3365 .vitem &%-brw%&
3366 .oindex "&%-brw%&"
3367 .cindex "testing" "rewriting"
3368 .cindex "rewriting" "testing"
3369 This option is for testing address rewriting rules, and it must be followed by
3370 a single argument, consisting of either a local part without a domain, or a
3371 complete address with a fully qualified domain. Exim outputs how this address
3372 would be rewritten for each possible place it might appear. See chapter
3373 &<<CHAPrewrite>>& for further details.
3374
3375 .vitem &%-bS%&
3376 .oindex "&%-bS%&"
3377 .cindex "SMTP" "batched incoming"
3378 .cindex "batched SMTP input"
3379 This option is used for batched SMTP input, which is an alternative interface
3380 for non-interactive local message submission. A number of messages can be
3381 submitted in a single run. However, despite its name, this is not really SMTP
3382 input. Exim reads each message's envelope from SMTP commands on the standard
3383 input, but generates no responses. If the caller is trusted, or
3384 &%untrusted_set_sender%& is set, the senders in the SMTP MAIL commands are
3385 believed; otherwise the sender is always the caller of Exim.
3386
3387 The message itself is read from the standard input, in SMTP format (leading
3388 dots doubled), terminated by a line containing just a single dot. An error is
3389 provoked if the terminating dot is missing. A further message may then follow.
3390
3391 As for other local message submissions, the contents of incoming batch SMTP
3392 messages can be checked using the non-SMTP ACL (see chapter &<<CHAPACL>>&).
3393 Unqualified addresses are automatically qualified using &%qualify_domain%& and
3394 &%qualify_recipient%&, as appropriate, unless the &%-bnq%& option is used.
3395
3396 Some other SMTP commands are recognized in the input. HELO and EHLO act
3397 as RSET; VRFY, EXPN, ETRN, and HELP act as NOOP;
3398 QUIT quits, ignoring the rest of the standard input.
3399
3400 .cindex "return code" "for &%-bS%&"
3401 If any error is encountered, reports are written to the standard output and
3402 error streams, and Exim gives up immediately. The return code is 0 if no error
3403 was detected; it is 1 if one or more messages were accepted before the error
3404 was detected; otherwise it is 2.
3405
3406 More details of input using batched SMTP are given in section
3407 &<<SECTincomingbatchedSMTP>>&.
3408
3409 .vitem &%-bs%&
3410 .oindex "&%-bs%&"
3411 .cindex "SMTP" "local input"
3412 .cindex "local SMTP input"
3413 This option causes Exim to accept one or more messages by reading SMTP commands
3414 on the standard input, and producing SMTP replies on the standard output. SMTP
3415 policy controls, as defined in ACLs (see chapter &<<CHAPACL>>&) are applied.
3416 Some user agents use this interface as a way of passing locally-generated
3417 messages to the MTA.
3418
3419 In
3420 .cindex "sender" "source of"
3421 this usage, if the caller of Exim is trusted, or &%untrusted_set_sender%& is
3422 set, the senders of messages are taken from the SMTP MAIL commands.
3423 Otherwise the content of these commands is ignored and the sender is set up as
3424 the calling user. Unqualified addresses are automatically qualified using
3425 &%qualify_domain%& and &%qualify_recipient%&, as appropriate, unless the
3426 &%-bnq%& option is used.
3427
3428 .cindex "inetd"
3429 The
3430 &%-bs%& option is also used to run Exim from &'inetd'&, as an alternative to
3431 using a listening daemon. Exim can distinguish the two cases by checking
3432 whether the standard input is a TCP/IP socket. When Exim is called from
3433 &'inetd'&, the source of the mail is assumed to be remote, and the comments
3434 above concerning senders and qualification do not apply. In this situation,
3435 Exim behaves in exactly the same way as it does when receiving a message via
3436 the listening daemon.
3437
3438 .vitem &%-bt%&
3439 .oindex "&%-bt%&"
3440 .cindex "testing" "addresses"
3441 .cindex "address" "testing"
3442 This option runs Exim in address testing mode, in which each argument is taken
3443 as a recipient address to be tested for deliverability. The results are
3444 written to the standard output. If a test fails, and the caller is not an admin
3445 user, no details of the failure are output, because these might contain
3446 sensitive information such as usernames and passwords for database lookups.
3447
3448 If no arguments are given, Exim runs in an interactive manner, prompting with a
3449 right angle bracket for addresses to be tested.
3450
3451 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3452 &[readline()]& function, because it is running as &'root'& and there are
3453 security issues.
3454
3455 Each address is handled as if it were the recipient address of a message
3456 (compare the &%-bv%& option). It is passed to the routers and the result is
3457 written to the standard output. However, any router that has
3458 &%no_address_test%& set is bypassed. This can make &%-bt%& easier to use for
3459 genuine routing tests if your first router passes everything to a scanner
3460 program.
3461
3462 .cindex "return code" "for &%-bt%&"
3463 The return code is 2 if any address failed outright; it is 1 if no address
3464 failed outright but at least one could not be resolved for some reason. Return
3465 code 0 is given only when all addresses succeed.
3466
3467 .cindex "duplicate addresses"
3468 &*Note*&: When actually delivering a message, Exim removes duplicate recipient
3469 addresses after routing is complete, so that only one delivery takes place.
3470 This does not happen when testing with &%-bt%&; the full results of routing are
3471 always shown.
3472
3473 &*Warning*&: &%-bt%& can only do relatively simple testing. If any of the
3474 routers in the configuration makes any tests on the sender address of a
3475 message,
3476 .oindex "&%-f%&" "for address testing"
3477 you can use the &%-f%& option to set an appropriate sender when running
3478 &%-bt%& tests. Without it, the sender is assumed to be the calling user at the
3479 default qualifying domain. However, if you have set up (for example) routers
3480 whose behaviour depends on the contents of an incoming message, you cannot test
3481 those conditions using &%-bt%&. The &%-N%& option provides a possible way of
3482 doing such tests.
3483
3484 .vitem &%-bV%&
3485 .oindex "&%-bV%&"
3486 .cindex "version number of Exim"
3487 This option causes Exim to write the current version number, compilation
3488 number, and compilation date of the &'exim'& binary to the standard output.
3489 It also lists the DBM library that is being used, the optional modules (such as
3490 specific lookup types), the drivers that are included in the binary, and the
3491 name of the runtime configuration file that is in use.
3492
3493 As part of its operation, &%-bV%& causes Exim to read and syntax check its
3494 configuration file. However, this is a static check only. It cannot check
3495 values that are to be expanded. For example, although a misspelt ACL verb is
3496 detected, an error in the verb's arguments is not. You cannot rely on &%-bV%&
3497 alone to discover (for example) all the typos in the configuration; some
3498 realistic testing is needed. The &%-bh%& and &%-N%& options provide more
3499 dynamic testing facilities.
3500
3501 .vitem &%-bv%&
3502 .oindex "&%-bv%&"
3503 .cindex "verifying address" "using &%-bv%&"
3504 .cindex "address" "verification"
3505 This option runs Exim in address verification mode, in which each argument is
3506 taken as a recipient address to be verified by the routers. (This does
3507 not involve any verification callouts). During normal operation, verification
3508 happens mostly as a consequence processing a &%verify%& condition in an ACL
3509 (see chapter &<<CHAPACL>>&). If you want to test an entire ACL, possibly
3510 including callouts, see the &%-bh%& and &%-bhc%& options.
3511
3512 If verification fails, and the caller is not an admin user, no details of the
3513 failure are output, because these might contain sensitive information such as
3514 usernames and passwords for database lookups.
3515
3516 If no arguments are given, Exim runs in an interactive manner, prompting with a
3517 right angle bracket for addresses to be verified.
3518
3519 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3520 &[readline()]& function, because it is running as &'exim'& and there are
3521 security issues.
3522
3523 Verification differs from address testing (the &%-bt%& option) in that routers
3524 that have &%no_verify%& set are skipped, and if the address is accepted by a
3525 router that has &%fail_verify%& set, verification fails. The address is
3526 verified as a recipient if &%-bv%& is used; to test verification for a sender
3527 address, &%-bvs%& should be used.
3528
3529 If the &%-v%& option is not set, the output consists of a single line for each
3530 address, stating whether it was verified or not, and giving a reason in the
3531 latter case. Without &%-v%&, generating more than one address by redirection
3532 causes verification to end successfully, without considering the generated
3533 addresses. However, if just one address is generated, processing continues,
3534 and the generated address must verify successfully for the overall verification
3535 to succeed.
3536
3537 When &%-v%& is set, more details are given of how the address has been handled,
3538 and in the case of address redirection, all the generated addresses are also
3539 considered. Verification may succeed for some and fail for others.
3540
3541 The
3542 .cindex "return code" "for &%-bv%&"
3543 return code is 2 if any address failed outright; it is 1 if no address
3544 failed outright but at least one could not be resolved for some reason. Return
3545 code 0 is given only when all addresses succeed.
3546
3547 If any of the routers in the configuration makes any tests on the sender
3548 address of a message, you should use the &%-f%& option to set an appropriate
3549 sender when running &%-bv%& tests. Without it, the sender is assumed to be the
3550 calling user at the default qualifying domain.
3551
3552 .vitem &%-bvs%&
3553 .oindex "&%-bvs%&"
3554 This option acts like &%-bv%&, but verifies the address as a sender rather
3555 than a recipient address. This affects any rewriting and qualification that
3556 might happen.
3557
3558 .vitem &%-bw%&
3559 .oindex "&%-bw%&"
3560 .cindex "daemon"
3561 .cindex "inetd"
3562 .cindex "inetd" "wait mode"
3563 This option runs Exim as a daemon, awaiting incoming SMTP connections,
3564 similarly to the &%-bd%& option.  All port specifications on the command-line
3565 and in the configuration file are ignored.  Queue-running may not be specified.
3566
3567 In this mode, Exim expects to be passed a socket as fd 0 (stdin) which is
3568 listening for connections.  This permits the system to start up and have
3569 inetd (or equivalent) listen on the SMTP ports, starting an Exim daemon for
3570 each port only when the first connection is received.
3571
3572 If the option is given as &%-bw%&<&'time'&> then the time is a timeout, after
3573 which the daemon will exit, which should cause inetd to listen once more.
3574
3575 .vitem &%-C%&&~<&'filelist'&>
3576 .oindex "&%-C%&"
3577 .cindex "configuration file" "alternate"
3578 .cindex "CONFIGURE_FILE"
3579 .cindex "alternate configuration file"
3580 This option causes Exim to find the runtime configuration file from the given
3581 list instead of from the list specified by the CONFIGURE_FILE
3582 compile-time setting. Usually, the list will consist of just a single filename,
3583 but it can be a colon-separated list of names. In this case, the first
3584 file that exists is used. Failure to open an existing file stops Exim from
3585 proceeding any further along the list, and an error is generated.
3586
3587 When this option is used by a caller other than root, and the list is different
3588 from the compiled-in list, Exim gives up its root privilege immediately, and
3589 runs with the real and effective uid and gid set to those of the caller.
3590 However, if a TRUSTED_CONFIG_LIST file is defined in &_Local/Makefile_&, that
3591 file contains a list of full pathnames, one per line, for configuration files
3592 which are trusted. Root privilege is retained for any configuration file so
3593 listed, as long as the caller is the Exim user (or the user specified in the
3594 CONFIGURE_OWNER option, if any), and as long as the configuration file is
3595 not writeable by inappropriate users or groups.
3596
3597 Leaving TRUSTED_CONFIG_LIST unset precludes the possibility of testing a
3598 configuration using &%-C%& right through message reception and delivery,
3599 even if the caller is root. The reception works, but by that time, Exim is
3600 running as the Exim user, so when it re-executes to regain privilege for the
3601 delivery, the use of &%-C%& causes privilege to be lost. However, root can
3602 test reception and delivery using two separate commands (one to put a message
3603 in the queue, using &%-odq%&, and another to do the delivery, using &%-M%&).
3604
3605 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
3606 prefix string with which any file named in a &%-C%& command line option
3607 must start. In addition, the filename must not contain the sequence &`/../`&.
3608 However, if the value of the &%-C%& option is identical to the value of
3609 CONFIGURE_FILE in &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as
3610 usual. There is no default setting for ALT_CONFIG_PREFIX; when it is
3611 unset, any filename can be used with &%-C%&.
3612
3613 ALT_CONFIG_PREFIX can be used to confine alternative configuration files
3614 to a directory to which only root has access. This prevents someone who has
3615 broken into the Exim account from running a privileged Exim with an arbitrary
3616 configuration file.
3617
3618 The &%-C%& facility is useful for ensuring that configuration files are
3619 syntactically correct, but cannot be used for test deliveries, unless the
3620 caller is privileged, or unless it is an exotic configuration that does not
3621 require privilege. No check is made on the owner or group of the files
3622 specified by this option.
3623
3624
3625 .vitem &%-D%&<&'macro'&>=<&'value'&>
3626 .oindex "&%-D%&"
3627 .cindex "macro" "setting on command line"
3628 This option can be used to override macro definitions in the configuration file
3629 (see section &<<SECTmacrodefs>>&). However, like &%-C%&, if it is used by an
3630 unprivileged caller, it causes Exim to give up its root privilege.
3631 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
3632 completely disabled, and its use causes an immediate error exit.
3633
3634 If WHITELIST_D_MACROS is defined in &_Local/Makefile_& then it should be a
3635 colon-separated list of macros which are considered safe and, if &%-D%& only
3636 supplies macros from this list, and the values are acceptable, then Exim will
3637 not give up root privilege if the caller is root, the Exim run-time user, or
3638 the CONFIGURE_OWNER, if set.  This is a transition mechanism and is expected
3639 to be removed in the future.  Acceptable values for the macros satisfy the
3640 regexp: &`^[A-Za-z0-9_/.-]*$`&
3641
3642 The entire option (including equals sign if present) must all be within one
3643 command line item. &%-D%& can be used to set the value of a macro to the empty
3644 string, in which case the equals sign is optional. These two commands are
3645 synonymous:
3646 .code
3647 exim -DABC  ...
3648 exim -DABC= ...
3649 .endd
3650 To include spaces in a macro definition item, quotes must be used. If you use
3651 quotes, spaces are permitted around the macro name and the equals sign. For
3652 example:
3653 .code
3654 exim '-D ABC = something' ...
3655 .endd
3656 &%-D%& may be repeated up to 10 times on a command line.
3657 Only macro names up to 22 letters long can be set.
3658
3659
3660 .vitem &%-d%&<&'debug&~options'&>
3661 .oindex "&%-d%&"
3662 .cindex "debugging" "list of selectors"
3663 .cindex "debugging" "&%-d%& option"
3664 This option causes debugging information to be written to the standard
3665 error stream. It is restricted to admin users because debugging output may show
3666 database queries that contain password information. Also, the details of users'
3667 filter files should be protected. If a non-admin user uses &%-d%&, Exim
3668 writes an error message to the standard error stream and exits with a non-zero
3669 return code.
3670
3671 When &%-d%& is used, &%-v%& is assumed. If &%-d%& is given on its own, a lot of
3672 standard debugging data is output. This can be reduced, or increased to include
3673 some more rarely needed information, by directly following &%-d%& with a string
3674 made up of names preceded by plus or minus characters. These add or remove sets
3675 of debugging data, respectively. For example, &%-d+filter%& adds filter
3676 debugging, whereas &%-d-all+filter%& selects only filter debugging. Note that
3677 no spaces are allowed in the debug setting. The available debugging categories
3678 are:
3679 .display
3680 &`acl            `& ACL interpretation
3681 &`auth           `& authenticators
3682 &`deliver        `& general delivery logic
3683 &`dns            `& DNS lookups (see also resolver)
3684 &`dnsbl          `& DNS black list (aka RBL) code
3685 &`exec           `& arguments for &[execv()]& calls
3686 &`expand         `& detailed debugging for string expansions
3687 &`filter         `& filter handling
3688 &`hints_lookup   `& hints data lookups
3689 &`host_lookup    `& all types of name-to-IP address handling
3690 &`ident          `& ident lookup
3691 &`interface      `& lists of local interfaces
3692 &`lists          `& matching things in lists
3693 &`load           `& system load checks
3694 &`local_scan     `& can be used by &[local_scan()]& (see chapter &&&
3695                     &<<CHAPlocalscan>>&)
3696 &`lookup         `& general lookup code and all lookups
3697 &`memory         `& memory handling
3698 &`noutf8         `& modifier: avoid UTF-8 line-drawing
3699 &`pid            `& modifier: add pid to debug output lines
3700 &`process_info   `& setting info for the process log
3701 &`queue_run      `& queue runs
3702 &`receive        `& general message reception logic
3703 &`resolver       `& turn on the DNS resolver's debugging output
3704 &`retry          `& retry handling
3705 &`rewrite        `& address rewriting
3706 &`route          `& address routing
3707 &`timestamp      `& modifier: add timestamp to debug output lines
3708 &`tls            `& TLS logic
3709 &`transport      `& transports
3710 &`uid            `& changes of uid/gid and looking up uid/gid
3711 &`verify         `& address verification logic
3712 &`all            `& almost all of the above (see below), and also &%-v%&
3713 .endd
3714 The &`all`& option excludes &`memory`& when used as &`+all`&, but includes it
3715 for &`-all`&. The reason for this is that &`+all`& is something that people
3716 tend to use when generating debug output for Exim maintainers. If &`+memory`&
3717 is included, an awful lot of output that is very rarely of interest is
3718 generated, so it now has to be explicitly requested. However, &`-all`& does
3719 turn everything off.
3720
3721 .cindex "resolver, debugging output"
3722 .cindex "DNS resolver, debugging output"
3723 The &`resolver`& option produces output only if the DNS resolver was compiled
3724 with DEBUG enabled. This is not the case in some operating systems. Also,
3725 unfortunately, debugging output from the DNS resolver is written to stdout
3726 rather than stderr.
3727
3728 The default (&%-d%& with no argument) omits &`expand`&, &`filter`&,
3729 &`interface`&, &`load`&, &`memory`&, &`pid`&, &`resolver`&, and &`timestamp`&.
3730 However, the &`pid`& selector is forced when debugging is turned on for a
3731 daemon, which then passes it on to any re-executed Exims. Exim also
3732 automatically adds the pid to debug lines when several remote deliveries are
3733 run in parallel.
3734
3735 The &`timestamp`& selector causes the current time to be inserted at the start
3736 of all debug output lines. This can be useful when trying to track down delays
3737 in processing.
3738
3739 .cindex debugging "UTF-8 in"
3740 .cindex UTF-8 "in debug output"
3741 The &`noutf8`& selector disables the use of
3742 UTF-8 line-drawing characters to group related information.
3743 When disabled. ascii-art is used instead.
3744 Using the &`+all`& option does not set this modifier,
3745
3746 If the &%debug_print%& option is set in any driver, it produces output whenever
3747 any debugging is selected, or if &%-v%& is used.
3748
3749 .vitem &%-dd%&<&'debug&~options'&>
3750 .oindex "&%-dd%&"
3751 This option behaves exactly like &%-d%& except when used on a command that
3752 starts a daemon process. In that case, debugging is turned off for the
3753 subprocesses that the daemon creates. Thus, it is useful for monitoring the
3754 behaviour of the daemon without creating as much output as full debugging does.
3755
3756 .vitem &%-dropcr%&
3757 .oindex "&%-dropcr%&"
3758 This is an obsolete option that is now a no-op. It used to affect the way Exim
3759 handled CR and LF characters in incoming messages. What happens now is
3760 described in section &<<SECTlineendings>>&.
3761
3762 .vitem &%-E%&
3763 .oindex "&%-E%&"
3764 .cindex "bounce message" "generating"
3765 This option specifies that an incoming message is a locally-generated delivery
3766 failure report. It is used internally by Exim when handling delivery failures
3767 and is not intended for external use. Its only effect is to stop Exim
3768 generating certain messages to the postmaster, as otherwise message cascades
3769 could occur in some situations. As part of the same option, a message id may
3770 follow the characters &%-E%&. If it does, the log entry for the receipt of the
3771 new message contains the id, following &"R="&, as a cross-reference.
3772
3773 .vitem &%-e%&&'x'&
3774 .oindex "&%-e%&&'x'&"
3775 There are a number of Sendmail options starting with &%-oe%& which seem to be
3776 called by various programs without the leading &%o%& in the option. For
3777 example, the &%vacation%& program uses &%-eq%&. Exim treats all options of the
3778 form &%-e%&&'x'& as synonymous with the corresponding &%-oe%&&'x'& options.
3779
3780 .vitem &%-F%&&~<&'string'&>
3781 .oindex "&%-F%&"
3782 .cindex "sender" "name"
3783 .cindex "name" "of sender"
3784 This option sets the sender's full name for use when a locally-generated
3785 message is being accepted. In the absence of this option, the user's &'gecos'&
3786 entry from the password data is used. As users are generally permitted to alter
3787 their &'gecos'& entries, no security considerations are involved. White space
3788 between &%-F%& and the <&'string'&> is optional.
3789
3790 .vitem &%-f%&&~<&'address'&>
3791 .oindex "&%-f%&"
3792 .cindex "sender" "address"
3793 .cindex "address" "sender"
3794 .cindex "trusted users"
3795 .cindex "envelope from"
3796 .cindex "envelope sender"
3797 .cindex "user" "trusted"
3798 This option sets the address of the envelope sender of a locally-generated
3799 message (also known as the return path). The option can normally be used only
3800 by a trusted user, but &%untrusted_set_sender%& can be set to allow untrusted
3801 users to use it.
3802
3803 Processes running as root or the Exim user are always trusted. Other
3804 trusted users are defined by the &%trusted_users%& or &%trusted_groups%&
3805 options. In the absence of &%-f%&, or if the caller is not trusted, the sender
3806 of a local message is set to the caller's login name at the default qualify
3807 domain.
3808
3809 There is one exception to the restriction on the use of &%-f%&: an empty sender
3810 can be specified by any user, trusted or not, to create a message that can
3811 never provoke a bounce. An empty sender can be specified either as an empty
3812 string, or as a pair of angle brackets with nothing between them, as in these
3813 examples of shell commands:
3814 .code
3815 exim -f '<>' user@domain
3816 exim -f "" user@domain
3817 .endd
3818 In addition, the use of &%-f%& is not restricted when testing a filter file
3819 with &%-bf%& or when testing or verifying addresses using the &%-bt%& or
3820 &%-bv%& options.
3821
3822 Allowing untrusted users to change the sender address does not of itself make
3823 it possible to send anonymous mail. Exim still checks that the &'From:'& header
3824 refers to the local user, and if it does not, it adds a &'Sender:'& header,
3825 though this can be overridden by setting &%no_local_from_check%&.
3826
3827 White
3828 .cindex "&""From""& line"
3829 space between &%-f%& and the <&'address'&> is optional (that is, they can be
3830 given as two arguments or one combined argument). The sender of a
3831 locally-generated message can also be set (when permitted) by an initial
3832 &"From&~"& line in the message &-- see the description of &%-bm%& above &-- but
3833 if &%-f%& is also present, it overrides &"From&~"&.
3834
3835 .vitem &%-G%&
3836 .oindex "&%-G%&"
3837 .cindex "submission fixups, suppressing (command-line)"
3838 This option is equivalent to an ACL applying:
3839 .code
3840 control = suppress_local_fixups
3841 .endd
3842 for every message received.  Note that Sendmail will complain about such
3843 bad formatting, where Exim silently just does not fix it up.  This may change
3844 in future.
3845
3846 As this affects audit information, the caller must be a trusted user to use
3847 this option.
3848
3849 .vitem &%-h%&&~<&'number'&>
3850 .oindex "&%-h%&"
3851 .cindex "Sendmail compatibility" "&%-h%& option ignored"
3852 This option is accepted for compatibility with Sendmail, but has no effect. (In
3853 Sendmail it overrides the &"hop count"& obtained by counting &'Received:'&
3854 headers.)
3855
3856 .vitem &%-i%&
3857 .oindex "&%-i%&"
3858 .cindex "Solaris" "&'mail'& command"
3859 .cindex "dot" "in incoming non-SMTP message"
3860 This option, which has the same effect as &%-oi%&, specifies that a dot on a
3861 line by itself should not terminate an incoming, non-SMTP message.
3862 Solaris 2.4 (SunOS 5.4) Sendmail has a similar &%-i%& processing option
3863 &url(https://docs.oracle.com/cd/E19457-01/801-6680-1M/801-6680-1M.pdf),
3864 p. 1M-529), and therefore a &%-oi%& command line option, which both are used
3865 by its &'mailx'& command.
3866
3867 .vitem &%-L%&&~<&'tag'&>
3868 .oindex "&%-L%&"
3869 .cindex "syslog" "process name; set with flag"
3870 This option is equivalent to setting &%syslog_processname%& in the config
3871 file and setting &%log_file_path%& to &`syslog`&.
3872 Its use is restricted to administrators.  The configuration file has to be
3873 read and parsed, to determine access rights, before this is set and takes
3874 effect, so early configuration file errors will not honour this flag.
3875
3876 The tag should not be longer than 32 characters.
3877
3878 .vitem &%-M%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3879 .oindex "&%-M%&"
3880 .cindex "forcing delivery"
3881 .cindex "delivery" "forcing attempt"
3882 .cindex "frozen messages" "forcing delivery"
3883 This option requests Exim to run a delivery attempt on each message in turn. If
3884 any of the messages are frozen, they are automatically thawed before the
3885 delivery attempt. The settings of &%queue_domains%&, &%queue_smtp_domains%&,
3886 and &%hold_domains%& are ignored.
3887
3888 Retry
3889 .cindex "hints database" "overriding retry hints"
3890 hints for any of the addresses are overridden &-- Exim tries to deliver even if
3891 the normal retry time has not yet been reached. This option requires the caller
3892 to be an admin user. However, there is an option called &%prod_requires_admin%&
3893 which can be set false to relax this restriction (and also the same requirement
3894 for the &%-q%&, &%-R%&, and &%-S%& options).
3895
3896 The deliveries happen synchronously, that is, the original Exim process does
3897 not terminate until all the delivery attempts have finished. No output is
3898 produced unless there is a serious error. If you want to see what is happening,
3899 use the &%-v%& option as well, or inspect Exim's main log.
3900
3901 .vitem &%-Mar%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3902 .oindex "&%-Mar%&"
3903 .cindex "message" "adding recipients"
3904 .cindex "recipient" "adding"
3905 This option requests Exim to add the addresses to the list of recipients of the
3906 message (&"ar"& for &"add recipients"&). The first argument must be a message
3907 id, and the remaining ones must be email addresses. However, if the message is
3908 active (in the middle of a delivery attempt), it is not altered. This option
3909 can be used only by an admin user.
3910
3911 .vitem "&%-MC%&&~<&'transport'&>&~<&'hostname'&>&&&
3912         &~<&'host&~IP'&>&&&
3913         &~<&'sequence&~number'&>&&&
3914         &~<&'message&~id'&>"
3915 .oindex "&%-MC%&"
3916 .cindex "SMTP" "passed connection"
3917 .cindex "SMTP" "multiple deliveries"
3918 .cindex "multiple SMTP deliveries"
3919 This option is not intended for use by external callers. It is used internally
3920 by Exim to invoke another instance of itself to deliver a waiting message using
3921 an existing SMTP connection, which is passed as the standard input. Details are
3922 given in chapter &<<CHAPSMTP>>&. This must be the final option, and the caller
3923 must be root or the Exim user in order to use it.
3924
3925 .vitem &%-MCA%&
3926 .oindex "&%-MCA%&"
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 connection to the remote host has been authenticated.
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 &%-MC%& option. It signifies that the
3935 remote host supports the ESMTP &_DSN_& extension.
3936
3937 .vitem &%-MCd%&
3938 .oindex "&%-MCd%&"
3939 This option is not intended for use by external callers. It is used internally
3940 by Exim in conjunction with the &%-d%& option
3941 to pass on an information string on the purpose of the process.
3942
3943 .vitem &%-MCG%&&~<&'queue&~name'&>
3944 .oindex "&%-MCG%&"
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 an
3947 alternate queue is used, named by the following argument.
3948
3949 .vitem &%-MCK%&
3950 .oindex "&%-MCK%&"
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 a
3953 remote host supports the ESMTP &_CHUNKING_& extension.
3954
3955 .new
3956 .vitem &%-MCL%&
3957 .oindex "&%-MCL%&"
3958 This option is not intended for use by external callers. It is used internally
3959 by Exim in conjunction with the &%-MC%& option. It signifies that the server to
3960 which Exim is connected advertised limits on numbers of mails, recipients or
3961 recipient domains.
3962 The limits are given by the following three arguments.
3963 .wen
3964
3965 .vitem &%-MCP%&
3966 .oindex "&%-MCP%&"
3967 This option is not intended for use by external callers. It is used internally
3968 by Exim in conjunction with the &%-MC%& option. It signifies that the server to
3969 which Exim is connected supports pipelining.
3970
3971 .new
3972 .vitem &%-MCp%&
3973 .oindex "&%-MCp%&"
3974 This option is not intended for use by external callers. It is used internally
3975 by Exim in conjunction with the &%-MC%& option. It signifies that the connection
3976 t a remote server is via a SOCKS proxy, using addresses and ports given by
3977 the following four arguments.
3978 .wen
3979
3980 .vitem &%-MCQ%&&~<&'process&~id'&>&~<&'pipe&~fd'&>
3981 .oindex "&%-MCQ%&"
3982 This option is not intended for use by external callers. It is used internally
3983 by Exim in conjunction with the &%-MC%& option when the original delivery was
3984 started by a queue runner. It passes on the process id of the queue runner,
3985 together with the file descriptor number of an open pipe. Closure of the pipe
3986 signals the final completion of the sequence of processes that are passing
3987 messages through the same SMTP connection.
3988
3989 .new
3990 .vitem &%-MCq%&&~<&'recipient&~address'&>&~<&'size'&>
3991 .oindex "&%-MCq%&"
3992 This option is not intended for use by external callers. It is used internally
3993 by Exim to implement quota checking for local users.
3994 .wen
3995
3996 .vitem &%-MCS%&
3997 .oindex "&%-MCS%&"
3998 This option is not intended for use by external callers. It is used internally
3999 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
4000 ESMTP SIZE option should be used on messages delivered down the existing
4001 connection.
4002
4003 .vitem &%-MCT%&
4004 .oindex "&%-MCT%&"
4005 This option is not intended for use by external callers. It is used internally
4006 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
4007 host to which Exim is connected supports TLS encryption.
4008
4009 .new
4010 .vitem &%-MCr%&&~<&'SNI'&> &&&
4011        &%-MCs%&&~<&'SNI'&>
4012 .oindex "&%-MCs%&"
4013 .oindex "&%-MCr%&"
4014 These options are not intended for use by external callers. It is used internally
4015 by Exim in conjunction with the &%-MCt%& option, and passes on the fact that
4016 a TLS Server Name Indication was sent as part of the channel establishment.
4017 The argument gives the SNI string.
4018 The "r" variant indicates a DANE-verified connection.
4019 .wen
4020
4021 .vitem &%-MCt%&&~<&'IP&~address'&>&~<&'port'&>&~<&'cipher'&>
4022 .oindex "&%-MCt%&"
4023 This option is not intended for use by external callers. It is used internally
4024 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
4025 connection is being proxied by a parent process for handling TLS encryption.
4026 The arguments give the local address and port being proxied, and the TLS cipher.
4027
4028 .vitem &%-Mc%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
4029 .oindex "&%-Mc%&"
4030 .cindex "hints database" "not overridden by &%-Mc%&"
4031 .cindex "delivery" "manually started &-- not forced"
4032 This option requests Exim to run a delivery attempt on each message, in turn,
4033 but unlike the &%-M%& option, it does check for retry hints, and respects any
4034 that are found. This option is not very useful to external callers. It is
4035 provided mainly for internal use by Exim when it needs to re-invoke itself in
4036 order to regain root privilege for a delivery (see chapter &<<CHAPsecurity>>&).
4037 However, &%-Mc%& can be useful when testing, in order to run a delivery that
4038 respects retry times and other options such as &%hold_domains%& that are
4039 overridden when &%-M%& is used. Such a delivery does not count as a queue run.
4040 If you want to run a specific delivery as if in a queue run, you should use
4041 &%-q%& with a message id argument. A distinction between queue run deliveries
4042 and other deliveries is made in one or two places.
4043
4044 .vitem &%-Mes%&&~<&'message&~id'&>&~<&'address'&>
4045 .oindex "&%-Mes%&"
4046 .cindex "message" "changing sender"
4047 .cindex "sender" "changing"
4048 This option requests Exim to change the sender address in the message to the
4049 given address, which must be a fully qualified address or &"<>"& (&"es"& for
4050 &"edit sender"&). There must be exactly two arguments. The first argument must
4051 be a message id, and the second one an email address. However, if the message
4052 is active (in the middle of a delivery attempt), its status is not altered.
4053 This option can be used only by an admin user.
4054
4055 .vitem &%-Mf%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
4056 .oindex "&%-Mf%&"
4057 .cindex "freezing messages"
4058 .cindex "message" "manually freezing"
4059 This option requests Exim to mark each listed message as &"frozen"&. This
4060 prevents any delivery attempts taking place until the message is &"thawed"&,
4061 either manually or as a result of the &%auto_thaw%& configuration option.
4062 However, if any of the messages are active (in the middle of a delivery
4063 attempt), their status is not altered. This option can be used only by an admin
4064 user.
4065
4066 .vitem &%-Mg%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
4067 .oindex "&%-Mg%&"
4068 .cindex "giving up on messages"
4069 .cindex "message" "abandoning delivery attempts"
4070 .cindex "delivery" "abandoning further attempts"
4071 This option requests Exim to give up trying to deliver the listed messages,
4072 including any that are frozen. However, if any of the messages are active,
4073 their status is not altered. For non-bounce messages, a delivery error message
4074 is sent to the sender, containing the text &"cancelled by administrator"&.
4075 Bounce messages are just discarded. This option can be used only by an admin
4076 user.
4077
4078 .vitem &%-MG%&&~<&'queue&~name'&>&~<&'message&~id'&>&~<&'message&~id'&>&~...
4079 .oindex "&%-MG%&"
4080 .cindex queue named
4081 .cindex "named queues" "moving messages"
4082 .cindex "queue" "moving messages"
4083 This option requests that each listed message be moved from its current
4084 queue to the given named queue.
4085 The destination queue name argument is required, but can be an empty
4086 string to define the default queue.
4087 If the messages are not currently located in the default queue,
4088 a &%-qG<name>%& option will be required to define the source queue.
4089
4090 .vitem &%-Mmad%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
4091 .oindex "&%-Mmad%&"
4092 .cindex "delivery" "cancelling all"
4093 This option requests Exim to mark all the recipient addresses in the messages
4094 as already delivered (&"mad"& for &"mark all delivered"&). However, if any
4095 message is active (in the middle of a delivery attempt), its status is not
4096 altered. This option can be used only by an admin user.
4097
4098 .vitem &%-Mmd%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
4099 .oindex "&%-Mmd%&"
4100 .cindex "delivery" "cancelling by address"
4101 .cindex "recipient" "removing"
4102 .cindex "removing recipients"
4103 This option requests Exim to mark the given addresses as already delivered
4104 (&"md"& for &"mark delivered"&). The first argument must be a message id, and
4105 the remaining ones must be email addresses. These are matched to recipient
4106 addresses in the message in a case-sensitive manner. If the message is active
4107 (in the middle of a delivery attempt), its status is not altered. This option
4108 can be used only by an admin user.
4109
4110 .vitem &%-Mrm%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
4111 .oindex "&%-Mrm%&"
4112 .cindex "removing messages"
4113 .cindex "abandoning mail"
4114 .cindex "message" "manually discarding"
4115 This option requests Exim to remove the given messages from the queue. No
4116 bounce messages are sent; each message is simply forgotten. However, if any of
4117 the messages are active, their status is not altered. This option can be used
4118 only by an admin user or by the user who originally caused the message to be
4119 placed in the queue.
4120
4121 . .new
4122 . .vitem &%-MS%&
4123 . .oindex "&%-MS%&"
4124 . .cindex REQUIRETLS
4125 . This option is used to request REQUIRETLS processing on the message.
4126 . It is used internally by Exim in conjunction with -E when generating
4127 . a bounce message.
4128 . .wen
4129
4130 .vitem &%-Mset%&&~<&'message&~id'&>
4131 .oindex "&%-Mset%&"
4132 .cindex "testing" "string expansion"
4133 .cindex "expansion" "testing"
4134 This option is useful only in conjunction with &%-be%& (that is, when testing
4135 string expansions). Exim loads the given message from its spool before doing
4136 the test expansions, thus setting message-specific variables such as
4137 &$message_size$& and the header variables. The &$recipients$& variable is made
4138 available. This feature is provided to make it easier to test expansions that
4139 make use of these variables. However, this option can be used only by an admin
4140 user. See also &%-bem%&.
4141
4142 .vitem &%-Mt%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
4143 .oindex "&%-Mt%&"
4144 .cindex "thawing messages"
4145 .cindex "unfreezing messages"
4146 .cindex "frozen messages" "thawing"
4147 .cindex "message" "thawing frozen"
4148 This option requests Exim to &"thaw"& any of the listed messages that are
4149 &"frozen"&, so that delivery attempts can resume. However, if any of the
4150 messages are active, their status is not altered. This option can be used only
4151 by an admin user.
4152
4153 .vitem &%-Mvb%&&~<&'message&~id'&>
4154 .oindex "&%-Mvb%&"
4155 .cindex "listing" "message body"
4156 .cindex "message" "listing body of"
4157 This option causes the contents of the message body (-D) spool file to be
4158 written to the standard output. This option can be used only by an admin user.
4159
4160 .vitem &%-Mvc%&&~<&'message&~id'&>
4161 .oindex "&%-Mvc%&"
4162 .cindex "message" "listing in RFC 2822 format"
4163 .cindex "listing" "message in RFC 2822 format"
4164 This option causes a copy of the complete message (header lines plus body) to
4165 be written to the standard output in RFC 2822 format. This option can be used
4166 only by an admin user.
4167
4168 .vitem &%-Mvh%&&~<&'message&~id'&>
4169 .oindex "&%-Mvh%&"
4170 .cindex "listing" "message headers"
4171 .cindex "header lines" "listing"
4172 .cindex "message" "listing header lines"
4173 This option causes the contents of the message headers (-H) spool file to be
4174 written to the standard output. This option can be used only by an admin user.
4175
4176 .vitem &%-Mvl%&&~<&'message&~id'&>
4177 .oindex "&%-Mvl%&"
4178 .cindex "listing" "message log"
4179 .cindex "message" "listing message log"
4180 This option causes the contents of the message log spool file to be written to
4181 the standard output. This option can be used only by an admin user.
4182
4183 .vitem &%-m%&
4184 .oindex "&%-m%&"
4185 This is a synonym for &%-om%& that is accepted by Sendmail
4186 (&url(https://docs.oracle.com/cd/E19457-01/801-6680-1M/801-6680-1M.pdf)
4187 p. 1M-258), so Exim treats it that way too.
4188
4189 .vitem &%-N%&
4190 .oindex "&%-N%&"
4191 .cindex "debugging" "&%-N%& option"
4192 .cindex "debugging" "suppressing delivery"
4193 This is a debugging option that inhibits delivery of a message at the transport
4194 level. It implies &%-v%&. Exim goes through many of the motions of delivery &--
4195 it just doesn't actually transport the message, but instead behaves as if it
4196 had successfully done so. However, it does not make any updates to the retry
4197 database, and the log entries for deliveries are flagged with &"*>"& rather
4198 than &"=>"&.
4199
4200 Because &%-N%& discards any message to which it applies, only root or the Exim
4201 user are allowed to use it with &%-bd%&, &%-q%&, &%-R%& or &%-M%&. In other
4202 words, an ordinary user can use it only when supplying an incoming message to
4203 which it will apply. Although transportation never fails when &%-N%& is set, an
4204 address may be deferred because of a configuration problem on a transport, or a
4205 routing problem. Once &%-N%& has been used for a delivery attempt, it sticks to
4206 the message, and applies to any subsequent delivery attempts that may happen
4207 for that message.
4208
4209 .vitem &%-n%&
4210 .oindex "&%-n%&"
4211 This option is interpreted by Sendmail to mean &"no aliasing"&.
4212 For normal modes of operation, it is ignored by Exim.
4213 When combined with &%-bP%& it makes the output more terse (suppresses
4214 option names, environment values and config pretty printing).
4215
4216 .vitem &%-O%&&~<&'data'&>
4217 .oindex "&%-O%&"
4218 This option is interpreted by Sendmail to mean &`set option`&. It is ignored by
4219 Exim.
4220
4221 .vitem &%-oA%&&~<&'file&~name'&>
4222 .oindex "&%-oA%&"
4223 .cindex "Sendmail compatibility" "&%-oA%& option"
4224 This option is used by Sendmail in conjunction with &%-bi%& to specify an
4225 alternative alias filename. Exim handles &%-bi%& differently; see the
4226 description above.
4227
4228 .vitem &%-oB%&&~<&'n'&>
4229 .oindex "&%-oB%&"
4230 .cindex "SMTP" "passed connection"
4231 .cindex "SMTP" "multiple deliveries"
4232 .cindex "multiple SMTP deliveries"
4233 This is a debugging option which limits the maximum number of messages that can
4234 be delivered down one SMTP connection, overriding the value set in any &(smtp)&
4235 transport. If <&'n'&> is omitted, the limit is set to 1.
4236
4237 .vitem &%-odb%&
4238 .oindex "&%-odb%&"
4239 .cindex "background delivery"
4240 .cindex "delivery" "in the background"
4241 This option applies to all modes in which Exim accepts incoming messages,
4242 including the listening daemon. It requests &"background"& delivery of such
4243 messages, which means that the accepting process automatically starts a
4244 delivery process for each message received, but does not wait for the delivery
4245 processes to finish.
4246
4247 When all the messages have been received, the reception process exits,
4248 leaving the delivery processes to finish in their own time. The standard output
4249 and error streams are closed at the start of each delivery process.
4250 This is the default action if none of the &%-od%& options are present.
4251
4252 If one of the queueing options in the configuration file
4253 (&%queue_only%& or &%queue_only_file%&, for example) is in effect, &%-odb%&
4254 overrides it if &%queue_only_override%& is set true, which is the default
4255 setting. If &%queue_only_override%& is set false, &%-odb%& has no effect.
4256
4257 .vitem &%-odf%&
4258 .oindex "&%-odf%&"
4259 .cindex "foreground delivery"
4260 .cindex "delivery" "in the foreground"
4261 This option requests &"foreground"& (synchronous) delivery when Exim has
4262 accepted a locally-generated message. (For the daemon it is exactly the same as
4263 &%-odb%&.) A delivery process is automatically started to deliver the message,
4264 and Exim waits for it to complete before proceeding.
4265
4266 The original Exim reception process does not finish until the delivery
4267 process for the final message has ended. The standard error stream is left open
4268 during deliveries.
4269
4270 However, like &%-odb%&, this option has no effect if &%queue_only_override%& is
4271 false and one of the queueing options in the configuration file is in effect.
4272
4273 If there is a temporary delivery error during foreground delivery, the
4274 message is left in the queue for later delivery, and the original reception
4275 process exits. See chapter &<<CHAPnonqueueing>>& for a way of setting up a
4276 restricted configuration that never queues messages.
4277
4278
4279 .vitem &%-odi%&
4280 .oindex "&%-odi%&"
4281 This option is synonymous with &%-odf%&. It is provided for compatibility with
4282 Sendmail.
4283
4284 .vitem &%-odq%&
4285 .oindex "&%-odq%&"
4286 .cindex "non-immediate delivery"
4287 .cindex "delivery" "suppressing immediate"
4288 .cindex "queueing incoming messages"
4289 This option applies to all modes in which Exim accepts incoming messages,
4290 including the listening daemon. It specifies that the accepting process should
4291 not automatically start a delivery process for each message received. Messages
4292 are placed in the queue, and remain there until a subsequent queue runner
4293 process encounters them. There are several configuration options (such as
4294 &%queue_only%&) that can be used to queue incoming messages under certain
4295 conditions. This option overrides all of them and also &%-odqs%&. It always
4296 forces queueing.
4297
4298 .vitem &%-odqs%&
4299 .oindex "&%-odqs%&"
4300 .cindex "SMTP" "delaying delivery"
4301 .cindex "first pass routing"
4302 This option is a hybrid between &%-odb%&/&%-odi%& and &%-odq%&.
4303 However, like &%-odb%& and &%-odi%&, this option has no effect if
4304 &%queue_only_override%& is false and one of the queueing options in the
4305 configuration file is in effect.
4306
4307 When &%-odqs%& does operate, a delivery process is started for each incoming
4308 message, in the background by default, but in the foreground if &%-odi%& is
4309 also present. The recipient addresses are routed, and local deliveries are done
4310 in the normal way. However, if any SMTP deliveries are required, they are not
4311 done at this time, so the message remains in the queue until a subsequent queue
4312 runner process encounters it. Because routing was done, Exim knows which
4313 messages are waiting for which hosts, and so a number of messages for the same
4314 host can be sent in a single SMTP connection. The &%queue_smtp_domains%&
4315 configuration option has the same effect for specific domains. See also the
4316 &%-qq%& option.
4317
4318 .vitem &%-oee%&
4319 .oindex "&%-oee%&"
4320 .cindex "error" "reporting"
4321 If an error is detected while a non-SMTP message is being received (for
4322 example, a malformed address), the error is reported to the sender in a mail
4323 message.
4324
4325 .cindex "return code" "for &%-oee%&"
4326 Provided
4327 this error message is successfully sent, the Exim receiving process
4328 exits with a return code of zero. If not, the return code is 2 if the problem
4329 is that the original message has no recipients, or 1 for any other error.
4330 This is the default &%-oe%&&'x'& option if Exim is called as &'rmail'&.
4331
4332 .vitem &%-oem%&
4333 .oindex "&%-oem%&"
4334 .cindex "error" "reporting"
4335 .cindex "return code" "for &%-oem%&"
4336 This is the same as &%-oee%&, except that Exim always exits with a non-zero
4337 return code, whether or not the error message was successfully sent.
4338 This is the default &%-oe%&&'x'& option, unless Exim is called as &'rmail'&.
4339
4340 .vitem &%-oep%&
4341 .oindex "&%-oep%&"
4342 .cindex "error" "reporting"
4343 If an error is detected while a non-SMTP message is being received, the
4344 error is reported by writing a message to the standard error file (stderr).
4345 .cindex "return code" "for &%-oep%&"
4346 The return code is 1 for all errors.
4347
4348 .vitem &%-oeq%&
4349 .oindex "&%-oeq%&"
4350 .cindex "error" "reporting"
4351 This option is supported for compatibility with Sendmail, but has the same
4352 effect as &%-oep%&.
4353
4354 .vitem &%-oew%&
4355 .oindex "&%-oew%&"
4356 .cindex "error" "reporting"
4357 This option is supported for compatibility with Sendmail, but has the same
4358 effect as &%-oem%&.
4359
4360 .vitem &%-oi%&
4361 .oindex "&%-oi%&"
4362 .cindex "dot" "in incoming non-SMTP message"
4363 This option, which has the same effect as &%-i%&, specifies that a dot on a
4364 line by itself should not terminate an incoming, non-SMTP message. Otherwise, a
4365 single dot does terminate, though Exim does no special processing for other
4366 lines that start with a dot. This option is set by default if Exim is called as
4367 &'rmail'&. See also &%-ti%&.
4368
4369 .vitem &%-oitrue%&
4370 .oindex "&%-oitrue%&"
4371 This option is treated as synonymous with &%-oi%&.
4372
4373 .vitem &%-oMa%&&~<&'host&~address'&>
4374 .oindex "&%-oMa%&"
4375 .cindex "sender" "host address, specifying for local message"
4376 A number of options starting with &%-oM%& can be used to set values associated
4377 with remote hosts on locally-submitted messages (that is, messages not received
4378 over TCP/IP). These options can be used by any caller in conjunction with the
4379 &%-bh%&, &%-be%&, &%-bf%&, &%-bF%&, &%-bt%&, or &%-bv%& testing options. In
4380 other circumstances, they are ignored unless the caller is trusted.
4381
4382 The &%-oMa%& option sets the sender host address. This may include a port
4383 number at the end, after a full stop (period). For example:
4384 .code
4385 exim -bs -oMa 10.9.8.7.1234
4386 .endd
4387 An alternative syntax is to enclose the IP address in square brackets,
4388 followed by a colon and the port number:
4389 .code
4390 exim -bs -oMa [10.9.8.7]:1234
4391 .endd
4392 The IP address is placed in the &$sender_host_address$& variable, and the
4393 port, if present, in &$sender_host_port$&. If both &%-oMa%& and &%-bh%&
4394 are present on the command line, the sender host IP address is taken from
4395 whichever one is last.
4396
4397 .vitem &%-oMaa%&&~<&'name'&>
4398 .oindex "&%-oMaa%&"
4399 .cindex "authentication" "name, specifying for local message"
4400 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMaa%&
4401 option sets the value of &$sender_host_authenticated$& (the authenticator
4402 name). See chapter &<<CHAPSMTPAUTH>>& for a discussion of SMTP authentication.
4403 This option can be used with &%-bh%& and &%-bs%& to set up an
4404 authenticated SMTP session without actually using the SMTP AUTH command.
4405
4406 .vitem &%-oMai%&&~<&'string'&>
4407 .oindex "&%-oMai%&"
4408 .cindex "authentication" "id, specifying for local message"
4409 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMai%&
4410 option sets the value of &$authenticated_id$& (the id that was authenticated).
4411 This overrides the default value (the caller's login id, except with &%-bh%&,
4412 where there is no default) for messages from local sources. See chapter
4413 &<<CHAPSMTPAUTH>>& for a discussion of authenticated ids.
4414
4415 .vitem &%-oMas%&&~<&'address'&>
4416 .oindex "&%-oMas%&"
4417 .cindex "authentication" "sender, specifying for local message"
4418 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMas%&
4419 option sets the authenticated sender value in &$authenticated_sender$&. It
4420 overrides the sender address that is created from the caller's login id for
4421 messages from local sources, except when &%-bh%& is used, when there is no
4422 default. For both &%-bh%& and &%-bs%&, an authenticated sender that is
4423 specified on a MAIL command overrides this value. See chapter
4424 &<<CHAPSMTPAUTH>>& for a discussion of authenticated senders.
4425
4426 .vitem &%-oMi%&&~<&'interface&~address'&>
4427 .oindex "&%-oMi%&"
4428 .cindex "interface" "address, specifying for local message"
4429 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMi%&
4430 option sets the IP interface address value. A port number may be included,
4431 using the same syntax as for &%-oMa%&. The interface address is placed in
4432 &$received_ip_address$& and the port number, if present, in &$received_port$&.
4433
4434 .vitem &%-oMm%&&~<&'message&~reference'&>
4435 .oindex "&%-oMm%&"
4436 .cindex "message reference" "message reference, specifying for local message"
4437 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMm%&
4438 option sets the message reference, e.g. message-id, and is logged during
4439 delivery. This is useful when some kind of audit trail is required to tie
4440 messages together. The format of the message reference is checked and will
4441 abort if the format is invalid. The option will only be accepted if exim is
4442 running in trusted mode, not as any regular user.
4443
4444 The best example of a message reference is when Exim sends a bounce message.
4445 The message reference is the message-id of the original message for which Exim
4446 is sending the bounce.
4447
4448 .vitem &%-oMr%&&~<&'protocol&~name'&>
4449 .oindex "&%-oMr%&"
4450 .cindex "protocol, specifying for local message"
4451 .vindex "&$received_protocol$&"
4452 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMr%&
4453 option sets the received protocol value that is stored in
4454 &$received_protocol$&. However, it does not apply (and is ignored) when &%-bh%&
4455 or &%-bs%& is used. For &%-bh%&, the protocol is forced to one of the standard
4456 SMTP protocol names (see the description of &$received_protocol$& in section
4457 &<<SECTexpvar>>&). For &%-bs%&, the protocol is always &"local-"& followed by
4458 one of those same names. For &%-bS%& (batched SMTP) however, the protocol can
4459 be set by &%-oMr%&. Repeated use of this option is not supported.
4460
4461 .vitem &%-oMs%&&~<&'host&~name'&>
4462 .oindex "&%-oMs%&"
4463 .cindex "sender" "host name, specifying for local message"
4464 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMs%&
4465 option sets the sender host name in &$sender_host_name$&. When this option is
4466 present, Exim does not attempt to look up a host name from an IP address; it
4467 uses the name it is given.
4468
4469 .vitem &%-oMt%&&~<&'ident&~string'&>
4470 .oindex "&%-oMt%&"
4471 .cindex "sender" "ident string, specifying for local message"
4472 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMt%&
4473 option sets the sender ident value in &$sender_ident$&. The default setting for
4474 local callers is the login id of the calling process, except when &%-bh%& is
4475 used, when there is no default.
4476
4477 .vitem &%-om%&
4478 .oindex "&%-om%&"
4479 .cindex "Sendmail compatibility" "&%-om%& option ignored"
4480 In Sendmail, this option means &"me too"&, indicating that the sender of a
4481 message should receive a copy of the message if the sender appears in an alias
4482 expansion. Exim always does this, so the option does nothing.
4483
4484 .vitem &%-oo%&
4485 .oindex "&%-oo%&"
4486 .cindex "Sendmail compatibility" "&%-oo%& option ignored"
4487 This option is ignored. In Sendmail it specifies &"old style headers"&,
4488 whatever that means.
4489
4490 .vitem &%-oP%&&~<&'path'&>
4491 .oindex "&%-oP%&"
4492 .cindex "pid (process id)" "of daemon"
4493 .cindex "daemon" "process id (pid)"
4494 This option is useful only in conjunction with &%-bd%& or &%-q%& with a time
4495 value. The option specifies the file to which the process id of the daemon is
4496 written. When &%-oX%& is used with &%-bd%&, or when &%-q%& with a time is used
4497 without &%-bd%&, this is the only way of causing Exim to write a pid file,
4498 because in those cases, the normal pid file is not used.
4499
4500 .vitem &%-oPX%&
4501 .oindex "&%-oPX%&"
4502 .cindex "pid (process id)" "of daemon"
4503 .cindex "daemon" "process id (pid)"
4504 This option is not intended for general use.
4505 The daemon uses it when terminating due to a SIGTEM, possibly in
4506 combination with &%-oP%&&~<&'path'&>.
4507 It causes the pid file to be removed.
4508
4509 .vitem &%-or%&&~<&'time'&>
4510 .oindex "&%-or%&"
4511 .cindex "timeout" "for non-SMTP input"
4512 This option sets a timeout value for incoming non-SMTP messages. If it is not
4513 set, Exim will wait forever for the standard input. The value can also be set
4514 by the &%receive_timeout%& option. The format used for specifying times is
4515 described in section &<<SECTtimeformat>>&.
4516
4517 .vitem &%-os%&&~<&'time'&>
4518 .oindex "&%-os%&"
4519 .cindex "timeout" "for SMTP input"
4520 .cindex "SMTP" "input timeout"
4521 This option sets a timeout value for incoming SMTP messages. The timeout
4522 applies to each SMTP command and block of data. The value can also be set by
4523 the &%smtp_receive_timeout%& option; it defaults to 5 minutes. The format used
4524 for specifying times is described in section &<<SECTtimeformat>>&.
4525
4526 .vitem &%-ov%&
4527 .oindex "&%-ov%&"
4528 This option has exactly the same effect as &%-v%&.
4529
4530 .vitem &%-oX%&&~<&'number&~or&~string'&>
4531 .oindex "&%-oX%&"
4532 .cindex "TCP/IP" "setting listening ports"
4533 .cindex "TCP/IP" "setting listening interfaces"
4534 .cindex "port" "receiving TCP/IP"
4535 This option is relevant only when the &%-bd%& (start listening daemon) option
4536 is also given. It controls which ports and interfaces the daemon uses. Details
4537 of the syntax, and how it interacts with configuration file options, are given
4538 in chapter &<<CHAPinterfaces>>&. When &%-oX%& is used to start a daemon, no pid
4539 file is written unless &%-oP%& is also present to specify a pid filename.
4540
4541 .new
4542 .vitem &%-oY%&
4543 .oindex &%-oY%&
4544 .cindex "daemon notifier socket"
4545 This option controls the creation of an inter-process communications endpoint
4546 by the Exim daemon.
4547 It is only relevant when the &%-bd%& (start listening daemon) option is also
4548 given.
4549 Normally the daemon creates this socket, unless a &%-oX%& and &*no*& &%-oP%&
4550 option is also present.
4551 If this option is given then the socket will not be created.  This could be
4552 required if the system is running multiple daemons.
4553
4554 The socket is currently used for
4555 .ilist
4556 fast ramp-up of queue runner processes
4557 .next
4558 obtaining a current queue size
4559 .endlist
4560 .wen
4561
4562 .vitem &%-pd%&
4563 .oindex "&%-pd%&"
4564 .cindex "Perl" "starting the interpreter"
4565 This option applies when an embedded Perl interpreter is linked with Exim (see
4566 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4567 option, forcing the starting of the interpreter to be delayed until it is
4568 needed.
4569
4570 .vitem &%-ps%&
4571 .oindex "&%-ps%&"
4572 .cindex "Perl" "starting the interpreter"
4573 This option applies when an embedded Perl interpreter is linked with Exim (see
4574 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4575 option, forcing the starting of the interpreter to occur as soon as Exim is
4576 started.
4577
4578 .vitem &%-p%&<&'rval'&>:<&'sval'&>
4579 .oindex "&%-p%&"
4580 For compatibility with Sendmail, this option is equivalent to
4581 .display
4582 &`-oMr`& <&'rval'&> &`-oMs`& <&'sval'&>
4583 .endd
4584 It sets the incoming protocol and host name (for trusted callers). The
4585 host name and its colon can be omitted when only the protocol is to be set.
4586 Note the Exim already has two private options, &%-pd%& and &%-ps%&, that refer
4587 to embedded Perl. It is therefore impossible to set a protocol value of &`d`&
4588 or &`s`& using this option (but that does not seem a real limitation).
4589 Repeated use of this option is not supported.
4590
4591 .vitem &%-q%&
4592 .oindex "&%-q%&"
4593 .cindex "queue runner" "starting manually"
4594 This option is normally restricted to admin users. However, there is a
4595 configuration option called &%prod_requires_admin%& which can be set false to
4596 relax this restriction (and also the same requirement for the &%-M%&, &%-R%&,
4597 and &%-S%& options).
4598
4599 .cindex "queue runner" "description of operation"
4600 If other commandline options do not specify an action,
4601 the &%-q%& option starts one queue runner process. This scans the queue of
4602 waiting messages, and runs a delivery process for each one in turn. It waits
4603 for each delivery process to finish before starting the next one. A delivery
4604 process may not actually do any deliveries if the retry times for the addresses
4605 have not been reached. Use &%-qf%& (see below) if you want to override this.
4606
4607 If
4608 .cindex "SMTP" "passed connection"
4609 .cindex "SMTP" "multiple deliveries"
4610 .cindex "multiple SMTP deliveries"
4611 the delivery process spawns other processes to deliver other messages down
4612 passed SMTP connections, the queue runner waits for these to finish before
4613 proceeding.
4614
4615 When all the queued messages have been considered, the original queue runner
4616 process terminates. In other words, a single pass is made over the waiting
4617 mail, one message at a time. Use &%-q%& with a time (see below) if you want
4618 this to be repeated periodically.
4619
4620 Exim processes the waiting messages in an unpredictable order. It isn't very
4621 random, but it is likely to be different each time, which is all that matters.
4622 If one particular message screws up a remote MTA, other messages to the same
4623 MTA have a chance of getting through if they get tried first.
4624
4625 It is possible to cause the messages to be processed in lexical message id
4626 order, which is essentially the order in which they arrived, by setting the
4627 &%queue_run_in_order%& option, but this is not recommended for normal use.
4628
4629 .vitem &%-q%&<&'qflags'&>
4630 The &%-q%& option may be followed by one or more flag letters that change its
4631 behaviour. They are all optional, but if more than one is present, they must
4632 appear in the correct order. Each flag is described in a separate item below.
4633
4634 .vitem &%-qq...%&
4635 .oindex "&%-qq%&"
4636 .cindex "queue" "double scanning"
4637 .cindex "queue" "routing"
4638 .cindex "routing" "whole queue before delivery"
4639 .cindex "first pass routing"
4640 .cindex "queue runner" "two phase"
4641 An option starting with &%-qq%& requests a two-stage queue run. In the first
4642 stage, the queue is scanned as if the &%queue_smtp_domains%& option matched
4643 every domain. Addresses are routed, local deliveries happen, but no remote
4644 transports are run.
4645
4646 Performance will be best if the &%queue_run_in_order%& option is false.
4647 If that is so and the &%queue_fast_ramp%& option is true then
4648 in the first phase of the run,
4649 once a threshold number of messages are routed for a given host,
4650 a delivery process is forked in parallel with the rest of the scan.
4651
4652 .cindex "hints database" "remembering routing"
4653 The hints database that remembers which messages are waiting for specific hosts
4654 is updated, as if delivery to those hosts had been deferred. After this is
4655 complete, a second, normal queue scan happens, with routing and delivery taking
4656 place as normal. Messages that are routed to the same host should mostly be
4657 delivered down a single SMTP
4658 .cindex "SMTP" "passed connection"
4659 .cindex "SMTP" "multiple deliveries"
4660 .cindex "multiple SMTP deliveries"
4661 connection because of the hints that were set up during the first queue scan.
4662 This option may be useful for hosts that are connected to the Internet
4663 intermittently.
4664
4665 .vitem &%-q[q]i...%&
4666 .oindex "&%-qi%&"
4667 .cindex "queue" "initial delivery"
4668 If the &'i'& flag is present, the queue runner runs delivery processes only for
4669 those messages that haven't previously been tried. (&'i'& stands for &"initial
4670 delivery"&.) This can be helpful if you are putting messages in the queue using
4671 &%-odq%& and want a queue runner just to process the new messages.
4672
4673 .vitem &%-q[q][i]f...%&
4674 .oindex "&%-qf%&"
4675 .cindex "queue" "forcing delivery"
4676 .cindex "delivery" "forcing in queue run"
4677 If one &'f'& flag is present, a delivery attempt is forced for each non-frozen
4678 message, whereas without &'f'& only those non-frozen addresses that have passed
4679 their retry times are tried.
4680
4681 .vitem &%-q[q][i]ff...%&
4682 .oindex "&%-qff%&"
4683 .cindex "frozen messages" "forcing delivery"
4684 If &'ff'& is present, a delivery attempt is forced for every message, whether
4685 frozen or not.
4686
4687 .vitem &%-q[q][i][f[f]]l%&
4688 .oindex "&%-ql%&"
4689 .cindex "queue" "local deliveries only"
4690 The &'l'& (the letter &"ell"&) flag specifies that only local deliveries are to
4691 be done. If a message requires any remote deliveries, it remains in the queue
4692 for later delivery.
4693
4694 .vitem &%-q[q][i][f[f]][l][G<name>[/<time>]]]%&
4695 .oindex "&%-qG%&"
4696 .cindex queue named
4697 .cindex "named queues"  "deliver from"
4698 .cindex "queue" "delivering specific messages"
4699 If the &'G'& flag and a name is present, the queue runner operates on the
4700 queue with the given name rather than the default queue.
4701 The name should not contain a &'/'& character.
4702 For a periodic queue run (see below)
4703 append to the name a slash and a time value.
4704
4705 If other commandline options specify an action, a &'-qG<name>'& option
4706 will specify a queue to operate on.
4707 For example:
4708 .code
4709 exim -bp -qGquarantine
4710 mailq -qGquarantine
4711 exim -qGoffpeak -Rf @special.domain.example
4712 .endd
4713
4714 .vitem &%-q%&<&'qflags'&>&~<&'start&~id'&>&~<&'end&~id'&>
4715 When scanning the queue, Exim can be made to skip over messages whose ids are
4716 lexically less than a given value by following the &%-q%& option with a
4717 starting message id. For example:
4718 .code
4719 exim -q 0t5C6f-0000c8-00
4720 .endd
4721 Messages that arrived earlier than &`0t5C6f-0000c8-00`& are not inspected. If a
4722 second message id is given, messages whose ids are lexically greater than it
4723 are also skipped. If the same id is given twice, for example,
4724 .code
4725 exim -q 0t5C6f-0000c8-00 0t5C6f-0000c8-00
4726 .endd
4727 just one delivery process is started, for that message. This differs from
4728 &%-M%& in that retry data is respected, and it also differs from &%-Mc%& in
4729 that it counts as a delivery from a queue run. Note that the selection
4730 mechanism does not affect the order in which the messages are scanned. There
4731 are also other ways of selecting specific sets of messages for delivery in a
4732 queue run &-- see &%-R%& and &%-S%&.
4733
4734 .vitem &%-q%&<&'qflags'&><&'time'&>
4735 .cindex "queue runner" "starting periodically"
4736 .cindex "periodic queue running"
4737 When a time value is present, the &%-q%& option causes Exim to run as a daemon,
4738 starting a queue runner process at intervals specified by the given time value
4739 (whose format is described in section &<<SECTtimeformat>>&). This form of the
4740 &%-q%& option is commonly combined with the &%-bd%& option, in which case a
4741 single daemon process handles both functions. A common way of starting up a
4742 combined daemon at system boot time is to use a command such as
4743 .code
4744 /usr/exim/bin/exim -bd -q30m
4745 .endd
4746 Such a daemon listens for incoming SMTP calls, and also starts a queue runner
4747 process every 30 minutes.
4748
4749 When a daemon is started by &%-q%& with a time value, but without &%-bd%&, no
4750 pid file is written unless one is explicitly requested by the &%-oP%& option.
4751
4752 .vitem &%-qR%&<&'rsflags'&>&~<&'string'&>
4753 .oindex "&%-qR%&"
4754 This option is synonymous with &%-R%&. It is provided for Sendmail
4755 compatibility.
4756
4757 .vitem &%-qS%&<&'rsflags'&>&~<&'string'&>
4758 .oindex "&%-qS%&"
4759 This option is synonymous with &%-S%&.
4760
4761 .vitem &%-R%&<&'rsflags'&>&~<&'string'&>
4762 .oindex "&%-R%&"
4763 .cindex "queue runner" "for specific recipients"
4764 .cindex "delivery" "to given domain"
4765 .cindex "domain" "delivery to"
4766 The <&'rsflags'&> may be empty, in which case the white space before the string
4767 is optional, unless the string is &'f'&, &'ff'&, &'r'&, &'rf'&, or &'rff'&,
4768 which are the possible values for <&'rsflags'&>. White space is required if
4769 <&'rsflags'&> is not empty.
4770
4771 This option is similar to &%-q%& with no time value, that is, it causes Exim to
4772 perform a single queue run, except that, when scanning the messages on the
4773 queue, Exim processes only those that have at least one undelivered recipient
4774 address containing the given string, which is checked in a case-independent
4775 way. If the <&'rsflags'&> start with &'r'&, <&'string'&> is interpreted as a
4776 regular expression; otherwise it is a literal string.
4777
4778 If you want to do periodic queue runs for messages with specific recipients,
4779 you can combine &%-R%& with &%-q%& and a time value. For example:
4780 .code
4781 exim -q25m -R @special.domain.example
4782 .endd
4783 This example does a queue run for messages with recipients in the given domain
4784 every 25 minutes. Any additional flags that are specified with &%-q%& are
4785 applied to each queue run.
4786
4787 Once a message is selected for delivery by this mechanism, all its addresses
4788 are processed. For the first selected message, Exim overrides any retry
4789 information and forces a delivery attempt for each undelivered address. This
4790 means that if delivery of any address in the first message is successful, any
4791 existing retry information is deleted, and so delivery attempts for that
4792 address in subsequently selected messages (which are processed without forcing)
4793 will run. However, if delivery of any address does not succeed, the retry
4794 information is updated, and in subsequently selected messages, the failing
4795 address will be skipped.
4796
4797 .cindex "frozen messages" "forcing delivery"
4798 If the <&'rsflags'&> contain &'f'& or &'ff'&, the delivery forcing applies to
4799 all selected messages, not just the first; frozen messages are included when
4800 &'ff'& is present.
4801
4802 The &%-R%& option makes it straightforward to initiate delivery of all messages
4803 to a given domain after a host has been down for some time. When the SMTP
4804 command ETRN is accepted by its ACL (see chapter &<<CHAPACL>>&), its default
4805 effect is to run Exim with the &%-R%& option, but it can be configured to run
4806 an arbitrary command instead.
4807
4808 .vitem &%-r%&
4809 .oindex "&%-r%&"
4810 This is a documented (for Sendmail) obsolete alternative name for &%-f%&.
4811
4812 .vitem &%-S%&<&'rsflags'&>&~<&'string'&>
4813 .oindex "&%-S%&"
4814 .cindex "delivery" "from given sender"
4815 .cindex "queue runner" "for specific senders"
4816 This option acts like &%-R%& except that it checks the string against each
4817 message's sender instead of against the recipients. If &%-R%& is also set, both
4818 conditions must be met for a message to be selected. If either of the options
4819 has &'f'& or &'ff'& in its flags, the associated action is taken.
4820
4821 .vitem &%-Tqt%&&~<&'times'&>
4822 .oindex "&%-Tqt%&"
4823 This is an option that is exclusively for use by the Exim testing suite. It is not
4824 recognized when Exim is run normally. It allows for the setting up of explicit
4825 &"queue times"& so that various warning/retry features can be tested.
4826
4827 .vitem &%-t%&
4828 .oindex "&%-t%&"
4829 .cindex "recipient" "extracting from header lines"
4830 .chindex Bcc:
4831 .chindex Cc:
4832 .chindex To:
4833 When Exim is receiving a locally-generated, non-SMTP message on its standard
4834 input, the &%-t%& option causes the recipients of the message to be obtained
4835 from the &'To:'&, &'Cc:'&, and &'Bcc:'& header lines in the message instead of
4836 from the command arguments. The addresses are extracted before any rewriting
4837 takes place and the &'Bcc:'& header line, if present, is then removed.
4838
4839 .cindex "Sendmail compatibility" "&%-t%& option"
4840 If the command has any arguments, they specify addresses to which the message
4841 is &'not'& to be delivered. That is, the argument addresses are removed from
4842 the recipients list obtained from the headers. This is compatible with Smail 3
4843 and in accordance with the documented behaviour of several versions of
4844 Sendmail, as described in man pages on a number of operating systems (e.g.
4845 Solaris 8, IRIX 6.5, HP-UX 11). However, some versions of Sendmail &'add'&
4846 argument addresses to those obtained from the headers, and the O'Reilly
4847 Sendmail book documents it that way. Exim can be made to add argument addresses
4848 instead of subtracting them by setting the option
4849 &%extract_addresses_remove_arguments%& false.
4850
4851 .cindex "&%Resent-%& header lines" "with &%-t%&"
4852 If there are any &%Resent-%& header lines in the message, Exim extracts
4853 recipients from all &'Resent-To:'&, &'Resent-Cc:'&, and &'Resent-Bcc:'& header
4854 lines instead of from &'To:'&, &'Cc:'&, and &'Bcc:'&. This is for compatibility
4855 with Sendmail and other MTAs. (Prior to release 4.20, Exim gave an error if
4856 &%-t%& was used in conjunction with &%Resent-%& header lines.)
4857
4858 RFC 2822 talks about different sets of &%Resent-%& header lines (for when a
4859 message is resent several times). The RFC also specifies that they should be
4860 added at the front of the message, and separated by &'Received:'& lines. It is
4861 not at all clear how &%-t%& should operate in the present of multiple sets,
4862 nor indeed exactly what constitutes a &"set"&.
4863 In practice, it seems that MUAs do not follow the RFC. The &%Resent-%& lines
4864 are often added at the end of the header, and if a message is resent more than
4865 once, it is common for the original set of &%Resent-%& headers to be renamed as
4866 &%X-Resent-%& when a new set is added. This removes any possible ambiguity.
4867
4868 .vitem &%-ti%&
4869 .oindex "&%-ti%&"
4870 This option is exactly equivalent to &%-t%& &%-i%&. It is provided for
4871 compatibility with Sendmail.
4872
4873 .vitem &%-tls-on-connect%&
4874 .oindex "&%-tls-on-connect%&"
4875 .cindex "TLS" "use without STARTTLS"
4876 .cindex "TLS" "automatic start"
4877 This option is available when Exim is compiled with TLS support. It forces all
4878 incoming SMTP connections to behave as if the incoming port is listed in the
4879 &%tls_on_connect_ports%& option. See section &<<SECTsupobssmt>>& and chapter
4880 &<<CHAPTLS>>& for further details.
4881
4882
4883 .vitem &%-U%&
4884 .oindex "&%-U%&"
4885 .cindex "Sendmail compatibility" "&%-U%& option ignored"
4886 Sendmail uses this option for &"initial message submission"&, and its
4887 documentation states that in future releases, it may complain about
4888 syntactically invalid messages rather than fixing them when this flag is not
4889 set. Exim ignores this option.
4890
4891 .vitem &%-v%&
4892 .oindex "&%-v%&"
4893 This option causes Exim to write information to the standard error stream,
4894 describing what it is doing. In particular, it shows the log lines for
4895 receiving and delivering a message, and if an SMTP connection is made, the SMTP
4896 dialogue is shown. Some of the log lines shown may not actually be written to
4897 the log if the setting of &%log_selector%& discards them. Any relevant
4898 selectors are shown with each log line. If none are shown, the logging is
4899 unconditional.
4900
4901 .vitem &%-x%&
4902 .oindex "&%-x%&"
4903 AIX uses &%-x%& for a private purpose (&"mail from a local mail program has
4904 National Language Support extended characters in the body of the mail item"&).
4905 It sets &%-x%& when calling the MTA from its &%mail%& command. Exim ignores
4906 this option.
4907
4908 .vitem &%-X%&&~<&'logfile'&>
4909 .oindex "&%-X%&"
4910 This option is interpreted by Sendmail to cause debug information to be sent
4911 to the named file.  It is ignored by Exim.
4912
4913 .vitem &%-z%&&~<&'log-line'&>
4914 .oindex "&%-z%&"
4915 This option writes its argument to Exim's logfile.
4916 Use is restricted to administrators; the intent is for operational notes.
4917 Quotes should be used to maintain a multi-word item as a single argument,
4918 under most shells.
4919 .endlist
4920
4921 .ecindex IIDclo1
4922 .ecindex IIDclo2
4923
4924
4925 . ////////////////////////////////////////////////////////////////////////////
4926 . Insert a stylized DocBook comment here, to identify the end of the command
4927 . line options. This is for the benefit of the Perl script that automatically
4928 . creates a man page for the options.
4929 . ////////////////////////////////////////////////////////////////////////////
4930
4931 .literal xml
4932 <!-- === End of command line options === -->
4933 .literal off
4934
4935
4936
4937
4938
4939 . ////////////////////////////////////////////////////////////////////////////
4940 . ////////////////////////////////////////////////////////////////////////////
4941
4942
4943 .chapter "The Exim runtime configuration file" "CHAPconf" &&&
4944          "The runtime configuration file"
4945
4946 .cindex "runtime configuration"
4947 .cindex "configuration file" "general description"
4948 .cindex "CONFIGURE_FILE"
4949 .cindex "configuration file" "errors in"
4950 .cindex "error" "in configuration file"
4951 .cindex "return code" "for bad configuration"
4952 Exim uses a single runtime configuration file that is read whenever an Exim
4953 binary is executed. Note that in normal operation, this happens frequently,
4954 because Exim is designed to operate in a distributed manner, without central
4955 control.
4956
4957 If a syntax error is detected while reading the configuration file, Exim
4958 writes a message on the standard error, and exits with a non-zero return code.
4959 The message is also written to the panic log. &*Note*&: Only simple syntax
4960 errors can be detected at this time. The values of any expanded options are
4961 not checked until the expansion happens, even when the expansion does not
4962 actually alter the string.
4963
4964 The name of the configuration file is compiled into the binary for security
4965 reasons, and is specified by the CONFIGURE_FILE compilation option. In
4966 most configurations, this specifies a single file. However, it is permitted to
4967 give a colon-separated list of filenames, in which case Exim uses the first
4968 existing file in the list.
4969
4970 .cindex "EXIM_USER"
4971 .cindex "EXIM_GROUP"
4972 .cindex "CONFIGURE_OWNER"
4973 .cindex "CONFIGURE_GROUP"
4974 .cindex "configuration file" "ownership"
4975 .cindex "ownership" "configuration file"
4976 The runtime configuration file must be owned by root or by the user that is
4977 specified at compile time by the CONFIGURE_OWNER option (if set). The
4978 configuration file must not be world-writeable, or group-writeable unless its
4979 group is the root group or the one specified at compile time by the
4980 CONFIGURE_GROUP option.
4981
4982 &*Warning*&: In a conventional configuration, where the Exim binary is setuid
4983 to root, anybody who is able to edit the runtime configuration file has an
4984 easy way to run commands as root. If you specify a user or group in the
4985 CONFIGURE_OWNER or CONFIGURE_GROUP options, then that user and/or any users
4986 who are members of that group will trivially be able to obtain root privileges.
4987
4988 Up to Exim version 4.72, the runtime configuration file was also permitted to
4989 be writeable by the Exim user and/or group. That has been changed in Exim 4.73
4990 since it offered a simple privilege escalation for any attacker who managed to
4991 compromise the Exim user account.
4992
4993 A default configuration file, which will work correctly in simple situations,
4994 is provided in the file &_src/configure.default_&. If CONFIGURE_FILE
4995 defines just one filename, the installation process copies the default
4996 configuration to a new file of that name if it did not previously exist. If
4997 CONFIGURE_FILE is a list, no default is automatically installed. Chapter
4998 &<<CHAPdefconfil>>& is a &"walk-through"& discussion of the default
4999 configuration.
5000
5001
5002
5003 .section "Using a different configuration file" "SECID40"
5004 .cindex "configuration file" "alternate"
5005 A one-off alternate configuration can be specified by the &%-C%& command line
5006 option, which may specify a single file or a list of files. However, when
5007 &%-C%& is used, Exim gives up its root privilege, unless called by root (or
5008 unless the argument for &%-C%& is identical to the built-in value from
5009 CONFIGURE_FILE), or is listed in the TRUSTED_CONFIG_LIST file and the caller
5010 is the Exim user or the user specified in the CONFIGURE_OWNER setting. &%-C%&
5011 is useful mainly for checking the syntax of configuration files before
5012 installing them. No owner or group checks are done on a configuration file
5013 specified by &%-C%&, if root privilege has been dropped.
5014
5015 Even the Exim user is not trusted to specify an arbitrary configuration file
5016 with the &%-C%& option to be used with root privileges, unless that file is
5017 listed in the TRUSTED_CONFIG_LIST file. This locks out the possibility of
5018 testing a configuration using &%-C%& right through message reception and
5019 delivery, even if the caller is root. The reception works, but by that time,
5020 Exim is running as the Exim user, so when it re-execs to regain privilege for
5021 the delivery, the use of &%-C%& causes privilege to be lost. However, root
5022 can test reception and delivery using two separate commands (one to put a
5023 message in the queue, using &%-odq%&, and another to do the delivery, using
5024 &%-M%&).
5025
5026 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
5027 prefix string with which any file named in a &%-C%& command line option must
5028 start. In addition, the filename must not contain the sequence &"&`/../`&"&.
5029 There is no default setting for ALT_CONFIG_PREFIX; when it is unset, any
5030 filename can be used with &%-C%&.
5031
5032 One-off changes to a configuration can be specified by the &%-D%& command line
5033 option, which defines and overrides values for macros used inside the
5034 configuration file. However, like &%-C%&, the use of this option by a
5035 non-privileged user causes Exim to discard its root privilege.
5036 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
5037 completely disabled, and its use causes an immediate error exit.
5038
5039 The WHITELIST_D_MACROS option in &_Local/Makefile_& permits the binary builder
5040 to declare certain macro names trusted, such that root privilege will not
5041 necessarily be discarded.
5042 WHITELIST_D_MACROS defines a colon-separated list of macros which are
5043 considered safe and, if &%-D%& only supplies macros from this list, and the
5044 values are acceptable, then Exim will not give up root privilege if the caller
5045 is root, the Exim run-time user, or the CONFIGURE_OWNER, if set.  This is a
5046 transition mechanism and is expected to be removed in the future.  Acceptable
5047 values for the macros satisfy the regexp: &`^[A-Za-z0-9_/.-]*$`&
5048
5049 Some sites may wish to use the same Exim binary on different machines that
5050 share a file system, but to use different configuration files on each machine.
5051 If CONFIGURE_FILE_USE_NODE is defined in &_Local/Makefile_&, Exim first
5052 looks for a file whose name is the configuration filename followed by a dot
5053 and the machine's node name, as obtained from the &[uname()]& function. If this
5054 file does not exist, the standard name is tried. This processing occurs for
5055 each filename in the list given by CONFIGURE_FILE or &%-C%&.
5056
5057 In some esoteric situations different versions of Exim may be run under
5058 different effective uids and the CONFIGURE_FILE_USE_EUID is defined to
5059 help with this. See the comments in &_src/EDITME_& for details.
5060
5061
5062
5063 .section "Configuration file format" "SECTconffilfor"
5064 .cindex "configuration file" "format of"
5065 .cindex "format" "configuration file"
5066 Exim's configuration file is divided into a number of different parts. General
5067 option settings must always appear at the start of the file. The other parts
5068 are all optional, and may appear in any order. Each part other than the first
5069 is introduced by the word &"begin"& followed by at least one literal
5070 space, and the name of the part. The optional parts are:
5071
5072 .ilist
5073 &'ACL'&: Access control lists for controlling incoming SMTP mail (see chapter
5074 &<<CHAPACL>>&).
5075 .next
5076 .cindex "AUTH" "configuration"
5077 &'authenticators'&: Configuration settings for the authenticator drivers. These
5078 are concerned with the SMTP AUTH command (see chapter &<<CHAPSMTPAUTH>>&).
5079 .next
5080 &'routers'&: Configuration settings for the router drivers. Routers process
5081 addresses and determine how the message is to be delivered (see chapters
5082 &<<CHAProutergeneric>>&&--&<<CHAPredirect>>&).
5083 .next
5084 &'transports'&: Configuration settings for the transport drivers. Transports
5085 define mechanisms for copying messages to destinations (see chapters
5086 &<<CHAPtransportgeneric>>&&--&<<CHAPsmtptrans>>&).
5087 .next
5088 &'retry'&: Retry rules, for use when a message cannot be delivered immediately.
5089 If there is no retry section, or if it is empty (that is, no retry rules are
5090 defined), Exim will not retry deliveries. In this situation, temporary errors
5091 are treated the same as permanent errors. Retry rules are discussed in chapter
5092 &<<CHAPretry>>&.
5093 .next
5094 &'rewrite'&: Global address rewriting rules, for use when a message arrives and
5095 when new addresses are generated during delivery. Rewriting is discussed in
5096 chapter &<<CHAPrewrite>>&.
5097 .next
5098 &'local_scan'&: Private options for the &[local_scan()]& function. If you
5099 want to use this feature, you must set
5100 .code
5101 LOCAL_SCAN_HAS_OPTIONS=yes
5102 .endd
5103 in &_Local/Makefile_& before building Exim. Details of the &[local_scan()]&
5104 facility are given in chapter &<<CHAPlocalscan>>&.
5105 .endlist
5106
5107 .cindex "configuration file" "leading white space in"
5108 .cindex "configuration file" "trailing white space in"
5109 .cindex "white space" "in configuration file"
5110 Leading and trailing white space in configuration lines is always ignored.
5111
5112 Blank lines in the file, and lines starting with a # character (ignoring
5113 leading white space) are treated as comments and are ignored. &*Note*&: A
5114 # character other than at the beginning of a line is not treated specially,
5115 and does not introduce a comment.
5116
5117 Any non-comment line can be continued by ending it with a backslash. Note that
5118 the general rule for white space means that trailing white space after the
5119 backslash and leading white space at the start of continuation
5120 lines is ignored. Comment lines beginning with # (but not empty lines) may
5121 appear in the middle of a sequence of continuation lines.
5122
5123 A convenient way to create a configuration file is to start from the
5124 default, which is supplied in &_src/configure.default_&, and add, delete, or
5125 change settings as required.
5126
5127 The ACLs, retry rules, and rewriting rules have their own syntax which is
5128 described in chapters &<<CHAPACL>>&, &<<CHAPretry>>&, and &<<CHAPrewrite>>&,
5129 respectively. The other parts of the configuration file have some syntactic
5130 items in common, and these are described below, from section &<<SECTcos>>&
5131 onwards. Before that, the inclusion, macro, and conditional facilities are
5132 described.
5133
5134
5135
5136 .section "File inclusions in the configuration file" "SECID41"
5137 .cindex "inclusions in configuration file"
5138 .cindex "configuration file" "including other files"
5139 .cindex "&`.include`& in configuration file"
5140 .cindex "&`.include_if_exists`& in configuration file"
5141 You can include other files inside Exim's runtime configuration file by
5142 using this syntax:
5143 .display
5144 &`.include`& <&'filename'&>
5145 &`.include_if_exists`& <&'filename'&>
5146 .endd
5147 on a line by itself. Double quotes round the filename are optional. If you use
5148 the first form, a configuration error occurs if the file does not exist; the
5149 second form does nothing for non-existent files.
5150 The first form allows a relative name. It is resolved relative to
5151 the directory of the including file. For the second form an absolute filename
5152 is required.
5153
5154 Includes may be nested to any depth, but remember that Exim reads its
5155 configuration file often, so it is a good idea to keep them to a minimum.
5156 If you change the contents of an included file, you must HUP the daemon,
5157 because an included file is read only when the configuration itself is read.
5158
5159 The processing of inclusions happens early, at a physical line level, so, like
5160 comment lines, an inclusion can be used in the middle of an option setting,
5161 for example:
5162 .code
5163 hosts_lookup = a.b.c \
5164                .include /some/file
5165 .endd
5166 Include processing happens after macro processing (see below). Its effect is to
5167 process the lines of the included file as if they occurred inline where the
5168 inclusion appears.
5169
5170
5171
5172 .section "Macros in the configuration file" "SECTmacrodefs"
5173 .cindex "macro" "description of"
5174 .cindex "configuration file" "macros"
5175 If a line in the main part of the configuration (that is, before the first
5176 &"begin"& line) begins with an upper case letter, it is taken as a macro
5177 definition, and must be of the form
5178 .display
5179 <&'name'&> = <&'rest of line'&>
5180 .endd
5181 The name must consist of letters, digits, and underscores, and need not all be
5182 in upper case, though that is recommended. The rest of the line, including any
5183 continuations, is the replacement text, and has leading and trailing white
5184 space removed. Quotes are not removed. The replacement text can never end with
5185 a backslash character, but this doesn't seem to be a serious limitation.
5186
5187 Macros may also be defined between router, transport, authenticator, or ACL
5188 definitions. They may not, however, be defined within an individual driver or
5189 ACL, or in the &%local_scan%&, retry, or rewrite sections of the configuration.
5190
5191 .section "Macro substitution" "SECID42"
5192 Once a macro is defined, all subsequent lines in the file (and any included
5193 files) are scanned for the macro name; if there are several macros, the line is
5194 scanned for each, in turn, in the order in which the macros are defined. The
5195 replacement text is not re-scanned for the current macro, though it is scanned
5196 for subsequently defined macros. For this reason, a macro name may not contain
5197 the name of a previously defined macro as a substring. You could, for example,
5198 define
5199 .display
5200 &`ABCD_XYZ = `&<&'something'&>
5201 &`ABCD = `&<&'something else'&>
5202 .endd
5203 but putting the definitions in the opposite order would provoke a configuration
5204 error. Macro expansion is applied to individual physical lines from the file,
5205 before checking for line continuation or file inclusion (see above). If a line
5206 consists solely of a macro name, and the expansion of the macro is empty, the
5207 line is ignored. A macro at the start of a line may turn the line into a
5208 comment line or a &`.include`& line.
5209
5210
5211 .section "Redefining macros" "SECID43"
5212 Once defined, the value of a macro can be redefined later in the configuration
5213 (or in an included file). Redefinition is specified by using &'=='& instead of
5214 &'='&. For example:
5215 .code
5216 MAC =  initial value
5217 ...
5218 MAC == updated value
5219 .endd
5220 Redefinition does not alter the order in which the macros are applied to the
5221 subsequent lines of the configuration file. It is still the same order in which
5222 the macros were originally defined. All that changes is the macro's value.
5223 Redefinition makes it possible to accumulate values. For example:
5224 .code
5225 MAC =  initial value
5226 ...
5227 MAC == MAC and something added
5228 .endd
5229 This can be helpful in situations where the configuration file is built
5230 from a number of other files.
5231
5232 .section "Overriding macro values" "SECID44"
5233 The values set for macros in the configuration file can be overridden by the
5234 &%-D%& command line option, but Exim gives up its root privilege when &%-D%& is
5235 used, unless called by root or the Exim user. A definition on the command line
5236 using the &%-D%& option causes all definitions and redefinitions within the
5237 file to be ignored.
5238
5239
5240
5241 .section "Example of macro usage" "SECID45"
5242 As an example of macro usage, consider a configuration where aliases are looked
5243 up in a MySQL database. It helps to keep the file less cluttered if long
5244 strings such as SQL statements are defined separately as macros, for example:
5245 .code
5246 ALIAS_QUERY = select mailbox from user where \
5247               login='${quote_mysql:$local_part}';
5248 .endd
5249 This can then be used in a &(redirect)& router setting like this:
5250 .code
5251 data = ${lookup mysql{ALIAS_QUERY}}
5252 .endd
5253 In earlier versions of Exim macros were sometimes used for domain, host, or
5254 address lists. In Exim 4 these are handled better by named lists &-- see
5255 section &<<SECTnamedlists>>&.
5256
5257
5258 .section "Builtin macros" "SECTbuiltinmacros"
5259 Exim defines some macros depending on facilities available, which may
5260 differ due to build-time definitions and from one release to another.
5261 All of these macros start with an underscore.
5262 They can be used to conditionally include parts of a configuration
5263 (see below).
5264
5265 The following classes of macros are defined:
5266 .display
5267 &` _HAVE_*                    `&  build-time defines
5268 &` _DRIVER_ROUTER_*           `&  router drivers
5269 &` _DRIVER_TRANSPORT_*        `&  transport drivers
5270 &` _DRIVER_AUTHENTICATOR_*    `&  authenticator drivers
5271 &` _LOG_*                     `&  log_selector values
5272 &` _OPT_MAIN_*                `&  main config options
5273 &` _OPT_ROUTERS_*             `&  generic router options
5274 &` _OPT_TRANSPORTS_*          `&  generic transport options
5275 &` _OPT_AUTHENTICATORS_*      `&  generic authenticator options
5276 &` _OPT_ROUTER_*_*            `&  private router options
5277 &` _OPT_TRANSPORT_*_*         `&  private transport options
5278 &` _OPT_AUTHENTICATOR_*_*     `&  private authenticator options
5279 .endd
5280
5281 Use an &"exim -bP macros"& command to get the list of macros.
5282
5283
5284 .section "Conditional skips in the configuration file" "SECID46"
5285 .cindex "configuration file" "conditional skips"
5286 .cindex "&`.ifdef`&"
5287 You can use the directives &`.ifdef`&, &`.ifndef`&, &`.elifdef`&,
5288 &`.elifndef`&, &`.else`&, and &`.endif`& to dynamically include or exclude
5289 portions of the configuration file. The processing happens whenever the file is
5290 read (that is, when an Exim binary starts to run).
5291
5292 The implementation is very simple. Instances of the first four directives must
5293 be followed by text that includes the names of one or macros. The condition
5294 that is tested is whether or not any macro substitution has taken place in the
5295 line. Thus:
5296 .code
5297 .ifdef AAA
5298 message_size_limit = 50M
5299 .else
5300 message_size_limit = 100M
5301 .endif
5302 .endd
5303 sets a message size limit of 50M if the macro &`AAA`& is defined
5304 (or &`A`& or &`AA`&), and 100M
5305 otherwise. If there is more than one macro named on the line, the condition
5306 is true if any of them are defined. That is, it is an &"or"& condition. To
5307 obtain an &"and"& condition, you need to use nested &`.ifdef`&s.
5308
5309 Although you can use a macro expansion to generate one of these directives,
5310 it is not very useful, because the condition &"there was a macro substitution
5311 in this line"& will always be true.
5312
5313 Text following &`.else`& and &`.endif`& is ignored, and can be used as comment
5314 to clarify complicated nestings.
5315
5316
5317
5318 .section "Common option syntax" "SECTcos"
5319 .cindex "common option syntax"
5320 .cindex "syntax of common options"
5321 .cindex "configuration file" "common option syntax"
5322 For the main set of options, driver options, and &[local_scan()]& options,
5323 each setting is on a line by itself, and starts with a name consisting of
5324 lower-case letters and underscores. Many options require a data value, and in
5325 these cases the name must be followed by an equals sign (with optional white
5326 space) and then the value. For example:
5327 .code
5328 qualify_domain = mydomain.example.com
5329 .endd
5330 .cindex "hiding configuration option values"
5331 .cindex "configuration options" "hiding value of"
5332 .cindex "options" "hiding value of"
5333 Some option settings may contain sensitive data, for example, passwords for
5334 accessing databases. To stop non-admin users from using the &%-bP%& command
5335 line option to read these values, you can precede the option settings with the
5336 word &"hide"&. For example:
5337 .code
5338 hide mysql_servers = localhost/users/admin/secret-password
5339 .endd
5340 For non-admin users, such options are displayed like this:
5341 .code
5342 mysql_servers = <value not displayable>
5343 .endd
5344 If &"hide"& is used on a driver option, it hides the value of that option on
5345 all instances of the same driver.
5346
5347 The following sections describe the syntax used for the different data types
5348 that are found in option settings.
5349
5350
5351 .section "Boolean options" "SECID47"
5352 .cindex "format" "boolean"
5353 .cindex "boolean configuration values"
5354 .oindex "&%no_%&&'xxx'&"
5355 .oindex "&%not_%&&'xxx'&"
5356 Options whose type is given as boolean are on/off switches. There are two
5357 different ways of specifying such options: with and without a data value. If
5358 the option name is specified on its own without data, the switch is turned on;
5359 if it is preceded by &"no_"& or &"not_"& the switch is turned off. However,
5360 boolean options may be followed by an equals sign and one of the words
5361 &"true"&, &"false"&, &"yes"&, or &"no"&, as an alternative syntax. For example,
5362 the following two settings have exactly the same effect:
5363 .code
5364 queue_only
5365 queue_only = true
5366 .endd
5367 The following two lines also have the same (opposite) effect:
5368 .code
5369 no_queue_only
5370 queue_only = false
5371 .endd
5372 You can use whichever syntax you prefer.
5373
5374
5375
5376
5377 .section "Integer values" "SECID48"
5378 .cindex "integer configuration values"
5379 .cindex "format" "integer"
5380 If an option's type is given as &"integer"&, the value can be given in decimal,
5381 hexadecimal, or octal. If it starts with a digit greater than zero, a decimal
5382 number is assumed. Otherwise, it is treated as an octal number unless it starts
5383 with the characters &"0x"&, in which case the remainder is interpreted as a
5384 hexadecimal number.
5385
5386 If an integer value is followed by the letter K, it is multiplied by 1024; if
5387 it is followed by the letter M, it is multiplied by 1024x1024;
5388 if by the letter G, 1024x1024x1024.
5389 When the values
5390 of integer option settings are output, values which are an exact multiple of
5391 1024 or 1024x1024 are sometimes, but not always, printed using the letters K
5392 and M. The printing style is independent of the actual input format that was
5393 used.
5394
5395
5396 .section "Octal integer values" "SECID49"
5397 .cindex "integer format"
5398 .cindex "format" "octal integer"
5399 If an option's type is given as &"octal integer"&, its value is always
5400 interpreted as an octal number, whether or not it starts with the digit zero.
5401 Such options are always output in octal.
5402
5403
5404 .section "Fixed point numbers" "SECID50"
5405 .cindex "fixed point configuration values"
5406 .cindex "format" "fixed point"
5407 If an option's type is given as &"fixed-point"&, its value must be a decimal
5408 integer, optionally followed by a decimal point and up to three further digits.
5409
5410
5411
5412 .section "Time intervals" "SECTtimeformat"
5413 .cindex "time interval" "specifying in configuration"
5414 .cindex "format" "time interval"
5415 A time interval is specified as a sequence of numbers, each followed by one of
5416 the following letters, with no intervening white space:
5417
5418 .table2 30pt
5419 .irow &%s%& seconds
5420 .irow &%m%& minutes
5421 .irow &%h%& hours
5422 .irow &%d%& days
5423 .irow &%w%& weeks
5424 .endtable
5425
5426 For example, &"3h50m"& specifies 3 hours and 50 minutes. The values of time
5427 intervals are output in the same format. Exim does not restrict the values; it
5428 is perfectly acceptable, for example, to specify &"90m"& instead of &"1h30m"&.
5429
5430
5431
5432 .section "String values" "SECTstrings"
5433 .cindex "string" "format of configuration values"
5434 .cindex "format" "string"
5435 If an option's type is specified as &"string"&, the value can be specified with
5436 or without double-quotes. If it does not start with a double-quote, the value
5437 consists of the remainder of the line plus any continuation lines, starting at
5438 the first character after any leading white space, with trailing white space
5439 removed, and with no interpretation of the characters in the string. Because
5440 Exim removes comment lines (those beginning with #) at an early stage, they can
5441 appear in the middle of a multi-line string. The following two settings are
5442 therefore equivalent:
5443 .code
5444 trusted_users = uucp:mail
5445 trusted_users = uucp:\
5446                 # This comment line is ignored
5447                 mail
5448 .endd
5449 .cindex "string" "quoted"
5450 .cindex "escape characters in quoted strings"
5451 If a string does start with a double-quote, it must end with a closing
5452 double-quote, and any backslash characters other than those used for line
5453 continuation are interpreted as escape characters, as follows:
5454
5455 .table2 100pt
5456 .irow &`\\`&                     "single backslash"
5457 .irow &`\n`&                     "newline"
5458 .irow &`\r`&                     "carriage return"
5459 .irow &`\t`&                     "tab"
5460 .irow "&`\`&<&'octal digits'&>"  "up to 3 octal digits specify one character"
5461 .irow "&`\x`&<&'hex digits'&>"   "up to 2 hexadecimal digits specify one &&&
5462                                    character"
5463 .endtable
5464
5465 If a backslash is followed by some other character, including a double-quote
5466 character, that character replaces the pair.
5467
5468 Quoting is necessary only if you want to make use of the backslash escapes to
5469 insert special characters, or if you need to specify a value with leading or
5470 trailing spaces. These cases are rare, so quoting is almost never needed in
5471 current versions of Exim. In versions of Exim before 3.14, quoting was required
5472 in order to continue lines, so you may come across older configuration files
5473 and examples that apparently quote unnecessarily.
5474
5475
5476 .section "Expanded strings" "SECID51"
5477 .cindex "expansion" "definition of"
5478 Some strings in the configuration file are subjected to &'string expansion'&,
5479 by which means various parts of the string may be changed according to the
5480 circumstances (see chapter &<<CHAPexpand>>&). The input syntax for such strings
5481 is as just described; in particular, the handling of backslashes in quoted
5482 strings is done as part of the input process, before expansion takes place.
5483 However, backslash is also an escape character for the expander, so any
5484 backslashes that are required for that reason must be doubled if they are
5485 within a quoted configuration string.
5486
5487
5488 .section "User and group names" "SECID52"
5489 .cindex "user name" "format of"
5490 .cindex "format" "user name"
5491 .cindex "groups" "name format"
5492 .cindex "format" "group name"
5493 User and group names are specified as strings, using the syntax described
5494 above, but the strings are interpreted specially. A user or group name must
5495 either consist entirely of digits, or be a name that can be looked up using the
5496 &[getpwnam()]& or &[getgrnam()]& function, as appropriate.
5497
5498
5499 .section "List construction" "SECTlistconstruct"
5500 .cindex "list" "syntax of in configuration"
5501 .cindex "format" "list item in configuration"
5502 .cindex "string" "list, definition of"
5503 The data for some configuration options is a list of items, with colon as the
5504 default separator. Many of these options are shown with type &"string list"& in
5505 the descriptions later in this document. Others are listed as &"domain list"&,
5506 &"host list"&, &"address list"&, or &"local part list"&. Syntactically, they
5507 are all the same; however, those other than &"string list"& are subject to
5508 particular kinds of interpretation, as described in chapter
5509 &<<CHAPdomhosaddlists>>&.
5510
5511 In all these cases, the entire list is treated as a single string as far as the
5512 input syntax is concerned. The &%trusted_users%& setting in section
5513 &<<SECTstrings>>& above is an example. If a colon is actually needed in an item
5514 in a list, it must be entered as two colons. Leading and trailing white space
5515 on each item in a list is ignored. This makes it possible to include items that
5516 start with a colon, and in particular, certain forms of IPv6 address. For
5517 example, the list
5518 .code
5519 local_interfaces = 127.0.0.1 : ::::1
5520 .endd
5521 contains two IP addresses, the IPv4 address 127.0.0.1 and the IPv6 address ::1.
5522
5523 &*Note*&: Although leading and trailing white space is ignored in individual
5524 list items, it is not ignored when parsing the list. The spaces around the first
5525 colon in the example above are necessary. If they were not there, the list would
5526 be interpreted as the two items 127.0.0.1:: and 1.
5527
5528 .section "Changing list separators" "SECTlistsepchange"
5529 .cindex "list separator" "changing"
5530 .cindex "IPv6" "addresses in lists"
5531 Doubling colons in IPv6 addresses is an unwelcome chore, so a mechanism was
5532 introduced to allow the separator character to be changed. If a list begins
5533 with a left angle bracket, followed by any punctuation character, that
5534 character is used instead of colon as the list separator. For example, the list
5535 above can be rewritten to use a semicolon separator like this:
5536 .code
5537 local_interfaces = <; 127.0.0.1 ; ::1
5538 .endd
5539 This facility applies to all lists, with the exception of the list in
5540 &%log_file_path%&. It is recommended that the use of non-colon separators be
5541 confined to circumstances where they really are needed.
5542
5543 .cindex "list separator" "newline as"
5544 .cindex "newline" "as list separator"
5545 It is also possible to use newline and other control characters (those with
5546 code values less than 32, plus DEL) as separators in lists. Such separators
5547 must be provided literally at the time the list is processed. For options that
5548 are string-expanded, you can write the separator using a normal escape
5549 sequence. This will be processed by the expander before the string is
5550 interpreted as a list. For example, if a newline-separated list of domains is
5551 generated by a lookup, you can process it directly by a line such as this:
5552 .code
5553 domains = <\n ${lookup mysql{.....}}
5554 .endd
5555 This avoids having to change the list separator in such data. You are unlikely
5556 to want to use a control character as a separator in an option that is not
5557 expanded, because the value is literal text. However, it can be done by giving
5558 the value in quotes. For example:
5559 .code
5560 local_interfaces = "<\n 127.0.0.1 \n ::1"
5561 .endd
5562 Unlike printing character separators, which can be included in list items by
5563 doubling, it is not possible to include a control character as data when it is
5564 set as the separator. Two such characters in succession are interpreted as
5565 enclosing an empty list item.
5566
5567
5568
5569 .section "Empty items in lists" "SECTempitelis"
5570 .cindex "list" "empty item in"
5571 An empty item at the end of a list is always ignored. In other words, trailing
5572 separator characters are ignored. Thus, the list in
5573 .code
5574 senders = user@domain :
5575 .endd
5576 contains only a single item. If you want to include an empty string as one item
5577 in a list, it must not be the last item. For example, this list contains three
5578 items, the second of which is empty:
5579 .code
5580 senders = user1@domain : : user2@domain
5581 .endd
5582 &*Note*&: There must be white space between the two colons, as otherwise they
5583 are interpreted as representing a single colon data character (and the list
5584 would then contain just one item). If you want to specify a list that contains
5585 just one, empty item, you can do it as in this example:
5586 .code
5587 senders = :
5588 .endd
5589 In this case, the first item is empty, and the second is discarded because it
5590 is at the end of the list.
5591
5592
5593
5594
5595 .section "Format of driver configurations" "SECTfordricon"
5596 .cindex "drivers" "configuration format"
5597 There are separate parts in the configuration for defining routers, transports,
5598 and authenticators. In each part, you are defining a number of driver
5599 instances, each with its own set of options. Each driver instance is defined by
5600 a sequence of lines like this:
5601 .display
5602 <&'instance name'&>:
5603   <&'option'&>
5604   ...
5605   <&'option'&>
5606 .endd
5607 In the following example, the instance name is &(localuser)&, and it is
5608 followed by three options settings:
5609 .code
5610 localuser:
5611   driver = accept
5612   check_local_user
5613   transport = local_delivery
5614 .endd
5615 For each driver instance, you specify which Exim code module it uses &-- by the
5616 setting of the &%driver%& option &-- and (optionally) some configuration
5617 settings. For example, in the case of transports, if you want a transport to
5618 deliver with SMTP you would use the &(smtp)& driver; if you want to deliver to
5619 a local file you would use the &(appendfile)& driver. Each of the drivers is
5620 described in detail in its own separate chapter later in this manual.
5621
5622 You can have several routers, transports, or authenticators that are based on
5623 the same underlying driver (each must have a different instance name).
5624
5625 The order in which routers are defined is important, because addresses are
5626 passed to individual routers one by one, in order. The order in which
5627 transports are defined does not matter at all. The order in which
5628 authenticators are defined is used only when Exim, as a client, is searching
5629 them to find one that matches an authentication mechanism offered by the
5630 server.
5631
5632 .cindex "generic options"
5633 .cindex "options" "generic &-- definition of"
5634 Within a driver instance definition, there are two kinds of option: &'generic'&
5635 and &'private'&. The generic options are those that apply to all drivers of the
5636 same type (that is, all routers, all transports or all authenticators). The
5637 &%driver%& option is a generic option that must appear in every definition.
5638 .cindex "private options"
5639 The private options are special for each driver, and none need appear, because
5640 they all have default values.
5641
5642 The options may appear in any order, except that the &%driver%& option must
5643 precede any private options, since these depend on the particular driver. For
5644 this reason, it is recommended that &%driver%& always be the first option.
5645
5646 Driver instance names, which are used for reference in log entries and
5647 elsewhere, can be any sequence of letters, digits, and underscores (starting
5648 with a letter) and must be unique among drivers of the same type. A router and
5649 a transport (for example) can each have the same name, but no two router
5650 instances can have the same name. The name of a driver instance should not be
5651 confused with the name of the underlying driver module. For example, the
5652 configuration lines:
5653 .code
5654 remote_smtp:
5655   driver = smtp
5656 .endd
5657 create an instance of the &(smtp)& transport driver whose name is
5658 &(remote_smtp)&. The same driver code can be used more than once, with
5659 different instance names and different option settings each time. A second
5660 instance of the &(smtp)& transport, with different options, might be defined
5661 thus:
5662 .code
5663 special_smtp:
5664   driver = smtp
5665   port = 1234
5666   command_timeout = 10s
5667 .endd
5668 The names &(remote_smtp)& and &(special_smtp)& would be used to reference
5669 these transport instances from routers, and these names would appear in log
5670 lines.
5671
5672 Comment lines may be present in the middle of driver specifications. The full
5673 list of option settings for any particular driver instance, including all the
5674 defaulted values, can be extracted by making use of the &%-bP%& command line
5675 option.
5676
5677
5678
5679
5680
5681
5682 . ////////////////////////////////////////////////////////////////////////////
5683 . ////////////////////////////////////////////////////////////////////////////
5684
5685 .chapter "The default configuration file" "CHAPdefconfil"
5686 .scindex IIDconfiwal "configuration file" "default &""walk through""&"
5687 .cindex "default" "configuration file &""walk through""&"
5688 The default configuration file supplied with Exim as &_src/configure.default_&
5689 is sufficient for a host with simple mail requirements. As an introduction to
5690 the way Exim is configured, this chapter &"walks through"& the default
5691 configuration, giving brief explanations of the settings. Detailed descriptions
5692 of the options are given in subsequent chapters. The default configuration file
5693 itself contains extensive comments about ways you might want to modify the
5694 initial settings. However, note that there are many options that are not
5695 mentioned at all in the default configuration.
5696
5697
5698
5699 .section "Macros" "SECTdefconfmacros"
5700 All macros should be defined before any options.
5701
5702 One macro is specified, but commented out, in the default configuration:
5703 .code
5704 # ROUTER_SMARTHOST=MAIL.HOSTNAME.FOR.CENTRAL.SERVER.EXAMPLE
5705 .endd
5706 If all off-site mail is expected to be delivered to a "smarthost", then set the
5707 hostname here and uncomment the macro.  This will affect which router is used
5708 later on.  If this is left commented out, then Exim will perform direct-to-MX
5709 deliveries using a &(dnslookup)& router.
5710
5711 In addition to macros defined here, Exim includes a number of built-in macros
5712 to enable configuration to be guarded by a binary built with support for a
5713 given feature.  See section &<<SECTbuiltinmacros>>& for more details.
5714
5715
5716 .section "Main configuration settings" "SECTdefconfmain"
5717 The main (global) configuration option settings section must always come first
5718 in the file, after the macros.
5719 The first thing you'll see in the file, after some initial comments, is the line
5720 .code
5721 # primary_hostname =
5722 .endd
5723 This is a commented-out setting of the &%primary_hostname%& option. Exim needs
5724 to know the official, fully qualified name of your host, and this is where you
5725 can specify it. However, in most cases you do not need to set this option. When
5726 it is unset, Exim uses the &[uname()]& system function to obtain the host name.
5727
5728 The first three non-comment configuration lines are as follows:
5729 .code
5730 domainlist local_domains    = @
5731 domainlist relay_to_domains =
5732 hostlist   relay_from_hosts = 127.0.0.1
5733 .endd
5734 These are not, in fact, option settings. They are definitions of two named
5735 domain lists and one named host list. Exim allows you to give names to lists of
5736 domains, hosts, and email addresses, in order to make it easier to manage the
5737 configuration file (see section &<<SECTnamedlists>>&).
5738
5739 The first line defines a domain list called &'local_domains'&; this is used
5740 later in the configuration to identify domains that are to be delivered
5741 on the local host.
5742
5743 .cindex "@ in a domain list"
5744 There is just one item in this list, the string &"@"&. This is a special form
5745 of entry which means &"the name of the local host"&. Thus, if the local host is
5746 called &'a.host.example'&, mail to &'any.user@a.host.example'& is expected to
5747 be delivered locally. Because the local host's name is referenced indirectly,
5748 the same configuration file can be used on different hosts.
5749
5750 The second line defines a domain list called &'relay_to_domains'&, but the
5751 list itself is empty. Later in the configuration we will come to the part that
5752 controls mail relaying through the local host; it allows relaying to any
5753 domains in this list. By default, therefore, no relaying on the basis of a mail
5754 domain is permitted.
5755
5756 The third line defines a host list called &'relay_from_hosts'&. This list is
5757 used later in the configuration to permit relaying from any host or IP address
5758 that matches the list. The default contains just the IP address of the IPv4
5759 loopback interface, which means that processes on the local host are able to
5760 submit mail for relaying by sending it over TCP/IP to that interface. No other
5761 hosts are permitted to submit messages for relaying.
5762
5763 Just to be sure there's no misunderstanding: at this point in the configuration
5764 we aren't actually setting up any controls. We are just defining some domains
5765 and hosts that will be used in the controls that are specified later.
5766
5767 The next two configuration lines are genuine option settings:
5768 .code
5769 acl_smtp_rcpt = acl_check_rcpt
5770 acl_smtp_data = acl_check_data
5771 .endd
5772 These options specify &'Access Control Lists'& (ACLs) that are to be used
5773 during an incoming SMTP session for every recipient of a message (every RCPT
5774 command), and after the contents of the message have been received,
5775 respectively. The names of the lists are &'acl_check_rcpt'& and
5776 &'acl_check_data'&, and we will come to their definitions below, in the ACL
5777 section of the configuration. The RCPT ACL controls which recipients are
5778 accepted for an incoming message &-- if a configuration does not provide an ACL
5779 to check recipients, no SMTP mail can be accepted. The DATA ACL allows the
5780 contents of a message to be checked.
5781
5782 Two commented-out option settings are next:
5783 .code
5784 # av_scanner = clamd:/tmp/clamd
5785 # spamd_address = 127.0.0.1 783
5786 .endd
5787 These are example settings that can be used when Exim is compiled with the
5788 content-scanning extension. The first specifies the interface to the virus
5789 scanner, and the second specifies the interface to SpamAssassin. Further
5790 details are given in chapter &<<CHAPexiscan>>&.
5791
5792 Three more commented-out option settings follow:
5793 .code
5794 # tls_advertise_hosts = *
5795 # tls_certificate = /etc/ssl/exim.crt
5796 # tls_privatekey = /etc/ssl/exim.pem
5797 .endd
5798 These are example settings that can be used when Exim is compiled with
5799 support for TLS (aka SSL) as described in section &<<SECTinctlsssl>>&. The
5800 first one specifies the list of clients that are allowed to use TLS when
5801 connecting to this server; in this case, the wildcard means all clients. The
5802 other options specify where Exim should find its TLS certificate and private
5803 key, which together prove the server's identity to any clients that connect.
5804 More details are given in chapter &<<CHAPTLS>>&.
5805
5806 Another two commented-out option settings follow:
5807 .code
5808 # daemon_smtp_ports = 25 : 465 : 587
5809 # tls_on_connect_ports = 465
5810 .endd
5811 .cindex "port" "465 and 587"
5812 .cindex "port" "for message submission"
5813 .cindex "message" "submission, ports for"
5814 .cindex "submissions protocol"
5815 .cindex "smtps protocol"
5816 .cindex "ssmtp protocol"
5817 .cindex "SMTP" "submissions protocol"
5818 .cindex "SMTP" "ssmtp protocol"
5819 .cindex "SMTP" "smtps protocol"
5820 These options provide better support for roaming users who wish to use this
5821 server for message submission. They are not much use unless you have turned on
5822 TLS (as described in the previous paragraph) and authentication (about which
5823 more in section &<<SECTdefconfauth>>&).
5824 Mail submission from mail clients (MUAs) should be separate from inbound mail
5825 to your domain (MX delivery) for various good reasons (eg, ability to impose
5826 much saner TLS protocol and ciphersuite requirements without unintended
5827 consequences).
5828 RFC 6409 (previously 4409) specifies use of port 587 for SMTP Submission,
5829 which uses STARTTLS, so this is the &"submission"& port.
5830 RFC 8314 specifies use of port 465 as the &"submissions"& protocol,
5831 which should be used in preference to 587.
5832 You should also consider deploying SRV records to help clients find
5833 these ports.
5834 Older names for &"submissions"& are &"smtps"& and &"ssmtp"&.
5835
5836 Two more commented-out options settings follow:
5837 .code
5838 # qualify_domain =
5839 # qualify_recipient =
5840 .endd
5841 The first of these specifies a domain that Exim uses when it constructs a
5842 complete email address from a local login name. This is often needed when Exim
5843 receives a message from a local process. If you do not set &%qualify_domain%&,
5844 the value of &%primary_hostname%& is used. If you set both of these options,
5845 you can have different qualification domains for sender and recipient
5846 addresses. If you set only the first one, its value is used in both cases.
5847
5848 .cindex "domain literal" "recognizing format"
5849 The following line must be uncommented if you want Exim to recognize
5850 addresses of the form &'user@[10.11.12.13]'& that is, with a &"domain literal"&
5851 (an IP address within square brackets) instead of a named domain.
5852 .code
5853 # allow_domain_literals
5854 .endd
5855 The RFCs still require this form, but many people think that in the modern
5856 Internet it makes little sense to permit mail to be sent to specific hosts by
5857 quoting their IP addresses. This ancient format has been used by people who
5858 try to abuse hosts by using them for unwanted relaying. However, some
5859 people believe there are circumstances (for example, messages addressed to
5860 &'postmaster'&) where domain literals are still useful.
5861
5862 The next configuration line is a kind of trigger guard:
5863 .code
5864 never_users = root
5865 .endd
5866 It specifies that no delivery must ever be run as the root user. The normal
5867 convention is to set up &'root'& as an alias for the system administrator. This
5868 setting is a guard against slips in the configuration.
5869 The list of users specified by &%never_users%& is not, however, the complete
5870 list; the build-time configuration in &_Local/Makefile_& has an option called
5871 FIXED_NEVER_USERS specifying a list that cannot be overridden. The
5872 contents of &%never_users%& are added to this list. By default
5873 FIXED_NEVER_USERS also specifies root.
5874
5875 When a remote host connects to Exim in order to send mail, the only information
5876 Exim has about the host's identity is its IP address. The next configuration
5877 line,
5878 .code
5879 host_lookup = *
5880 .endd
5881 specifies that Exim should do a reverse DNS lookup on all incoming connections,
5882 in order to get a host name. This improves the quality of the logging
5883 information, but if you feel it is too expensive, you can remove it entirely,
5884 or restrict the lookup to hosts on &"nearby"& networks.
5885 Note that it is not always possible to find a host name from an IP address,
5886 because not all DNS reverse zones are maintained, and sometimes DNS servers are
5887 unreachable.
5888
5889 The next two lines are concerned with &'ident'& callbacks, as defined by RFC
5890 1413 (hence their names):
5891 .code
5892 rfc1413_hosts = *
5893 rfc1413_query_timeout = 0s
5894 .endd
5895 These settings cause Exim to avoid ident callbacks for all incoming SMTP calls.
5896 Few hosts offer RFC1413 service these days; calls have to be
5897 terminated by a timeout and this needlessly delays the startup
5898 of an incoming SMTP connection.
5899 If you have hosts for which you trust RFC1413 and need this
5900 information, you can change this.
5901
5902 This line enables an efficiency SMTP option.  It is negotiated by clients
5903 and not expected to cause problems but can be disabled if needed.
5904 .code
5905 prdr_enable = true
5906 .endd
5907
5908 When Exim receives messages over SMTP connections, it expects all addresses to
5909 be fully qualified with a domain, as required by the SMTP definition. However,
5910 if you are running a server to which simple clients submit messages, you may
5911 find that they send unqualified addresses. The two commented-out options:
5912 .code
5913 # sender_unqualified_hosts =
5914 # recipient_unqualified_hosts =
5915 .endd
5916 show how you can specify hosts that are permitted to send unqualified sender
5917 and recipient addresses, respectively.
5918
5919 The &%log_selector%& option is used to increase the detail of logging
5920 over the default:
5921 .code
5922 log_selector = +smtp_protocol_error +smtp_syntax_error \
5923                +tls_certificate_verified
5924 .endd
5925
5926 The &%percent_hack_domains%& option is also commented out:
5927 .code
5928 # percent_hack_domains =
5929 .endd
5930 It provides a list of domains for which the &"percent hack"& is to operate.
5931 This is an almost obsolete form of explicit email routing. If you do not know
5932 anything about it, you can safely ignore this topic.
5933
5934 The next two settings in the main part of the default configuration are
5935 concerned with messages that have been &"frozen"& on Exim's queue. When a
5936 message is frozen, Exim no longer continues to try to deliver it. Freezing
5937 occurs when a bounce message encounters a permanent failure because the sender
5938 address of the original message that caused the bounce is invalid, so the
5939 bounce cannot be delivered. This is probably the most common case, but there
5940 are also other conditions that cause freezing, and frozen messages are not
5941 always bounce messages.
5942 .code
5943 ignore_bounce_errors_after = 2d
5944 timeout_frozen_after = 7d
5945 .endd
5946 The first of these options specifies that failing bounce messages are to be
5947 discarded after 2 days in the queue. The second specifies that any frozen
5948 message (whether a bounce message or not) is to be timed out (and discarded)
5949 after a week. In this configuration, the first setting ensures that no failing
5950 bounce message ever lasts a week.
5951
5952 Exim queues it's messages in a spool directory. If you expect to have
5953 large queues, you may consider using this option. It splits the spool
5954 directory into subdirectories to avoid file system degradation from
5955 many files in a single directory, resulting in better performance.
5956 Manual manipulation of queued messages becomes more complex (though fortunately
5957 not often needed).
5958 .code
5959 # split_spool_directory = true
5960 .endd
5961
5962 In an ideal world everybody follows the standards. For non-ASCII
5963 messages RFC 2047 is a standard, allowing a maximum line length of 76
5964 characters. Exim adheres that standard and won't process messages which
5965 violate this standard. (Even ${rfc2047:...} expansions will fail.)
5966 In particular, the Exim maintainers have had multiple reports of
5967 problems from Russian administrators of issues until they disable this
5968 check, because of some popular, yet buggy, mail composition software.
5969 .code
5970 # check_rfc2047_length = false
5971 .endd
5972
5973 If you need to be strictly RFC compliant you may wish to disable the
5974 8BITMIME advertisement. Use this, if you exchange mails with systems
5975 that are not 8-bit clean.
5976 .code
5977 # accept_8bitmime = false
5978 .endd
5979
5980 Libraries you use may depend on specific environment settings.  This
5981 imposes a security risk (e.g. PATH). There are two lists:
5982 &%keep_environment%& for the variables to import as they are, and
5983 &%add_environment%& for variables we want to set to a fixed value.
5984 Note that TZ is handled separately, by the &%timezone%& runtime
5985 option and by the TIMEZONE_DEFAULT buildtime option.
5986 .code
5987 # keep_environment = ^LDAP
5988 # add_environment = PATH=/usr/bin::/bin
5989 .endd
5990
5991
5992 .section "ACL configuration" "SECID54"
5993 .cindex "default" "ACLs"
5994 .cindex "&ACL;" "default configuration"
5995 In the default configuration, the ACL section follows the main configuration.
5996 It starts with the line
5997 .code
5998 begin acl
5999 .endd
6000 and it contains the definitions of two ACLs, called &'acl_check_rcpt'& and
6001 &'acl_check_data'&, that were referenced in the settings of &%acl_smtp_rcpt%&
6002 and &%acl_smtp_data%& above.
6003
6004 .cindex "RCPT" "ACL for"
6005 The first ACL is used for every RCPT command in an incoming SMTP message. Each
6006 RCPT command specifies one of the message's recipients. The ACL statements
6007 are considered in order, until the recipient address is either accepted or
6008 rejected. The RCPT command is then accepted or rejected, according to the
6009 result of the ACL processing.
6010 .code
6011 acl_check_rcpt:
6012 .endd
6013 This line, consisting of a name terminated by a colon, marks the start of the
6014 ACL, and names it.
6015 .code
6016 accept  hosts = :
6017 .endd
6018 This ACL statement accepts the recipient if the sending host matches the list.
6019 But what does that strange list mean? It doesn't actually contain any host
6020 names or IP addresses. The presence of the colon puts an empty item in the
6021 list; Exim matches this only if the incoming message did not come from a remote
6022 host, because in that case, the remote hostname is empty. The colon is
6023 important. Without it, the list itself is empty, and can never match anything.
6024
6025 What this statement is doing is to accept unconditionally all recipients in
6026 messages that are submitted by SMTP from local processes using the standard
6027 input and output (that is, not using TCP/IP). A number of MUAs operate in this
6028 manner.
6029 .code
6030 deny    domains       = +local_domains
6031         local_parts   = ^[.] : ^.*[@%!/|]
6032         message       = Restricted characters in address
6033
6034 deny    domains       = !+local_domains
6035         local_parts   = ^[./|] : ^.*[@%!] : ^.*/\\.\\./
6036         message       = Restricted characters in address
6037 .endd
6038 These statements are concerned with local parts that contain any of the
6039 characters &"@"&, &"%"&, &"!"&, &"/"&, &"|"&, or dots in unusual places.
6040 Although these characters are entirely legal in local parts (in the case of
6041 &"@"& and leading dots, only if correctly quoted), they do not commonly occur
6042 in Internet mail addresses.
6043
6044 The first three have in the past been associated with explicitly routed
6045 addresses (percent is still sometimes used &-- see the &%percent_hack_domains%&
6046 option). Addresses containing these characters are regularly tried by spammers
6047 in an attempt to bypass relaying restrictions, and also by open relay testing
6048 programs. Unless you really need them it is safest to reject these characters
6049 at this early stage. This configuration is heavy-handed in rejecting these
6050 characters for all messages it accepts from remote hosts. This is a deliberate
6051 policy of being as safe as possible.
6052
6053 The first rule above is stricter, and is applied to messages that are addressed
6054 to one of the local domains handled by this host. This is implemented by the
6055 first condition, which restricts it to domains that are listed in the
6056 &'local_domains'& domain list. The &"+"& character is used to indicate a
6057 reference to a named list. In this configuration, there is just one domain in
6058 &'local_domains'&, but in general there may be many.
6059
6060 The second condition on the first statement uses two regular expressions to
6061 block local parts that begin with a dot or contain &"@"&, &"%"&, &"!"&, &"/"&,
6062 or &"|"&. If you have local accounts that include these characters, you will
6063 have to modify this rule.
6064
6065 Empty components (two dots in a row) are not valid in RFC 2822, but Exim
6066 allows them because they have been encountered in practice. (Consider the
6067 common convention of local parts constructed as
6068 &"&'first-initial.second-initial.family-name'&"& when applied to someone like
6069 the author of Exim, who has no second initial.) However, a local part starting
6070 with a dot or containing &"/../"& can cause trouble if it is used as part of a
6071 filename (for example, for a mailing list). This is also true for local parts
6072 that contain slashes. A pipe symbol can also be troublesome if the local part
6073 is incorporated unthinkingly into a shell command line.
6074
6075 The second rule above applies to all other domains, and is less strict. This
6076 allows your own users to send outgoing messages to sites that use slashes
6077 and vertical bars in their local parts. It blocks local parts that begin
6078 with a dot, slash, or vertical bar, but allows these characters within the
6079 local part. However, the sequence &"/../"& is barred. The use of &"@"&, &"%"&,
6080 and &"!"& is blocked, as before. The motivation here is to prevent your users
6081 (or your users' viruses) from mounting certain kinds of attack on remote sites.
6082 .code
6083 accept  local_parts   = postmaster
6084         domains       = +local_domains
6085 .endd
6086 This statement, which has two conditions, accepts an incoming address if the
6087 local part is &'postmaster'& and the domain is one of those listed in the
6088 &'local_domains'& domain list. The &"+"& character is used to indicate a
6089 reference to a named list. In this configuration, there is just one domain in
6090 &'local_domains'&, but in general there may be many.
6091
6092 The presence of this statement means that mail to postmaster is never blocked
6093 by any of the subsequent tests. This can be helpful while sorting out problems
6094 in cases where the subsequent tests are incorrectly denying access.
6095 .code
6096 require verify        = sender
6097 .endd
6098 This statement requires the sender address to be verified before any subsequent
6099 ACL statement can be used. If verification fails, the incoming recipient
6100 address is refused. Verification consists of trying to route the address, to
6101 see if a bounce message could be delivered to it. In the case of remote
6102 addresses, basic verification checks only the domain, but &'callouts'& can be
6103 used for more verification if required. Section &<<SECTaddressverification>>&
6104 discusses the details of address verification.
6105 .code
6106 accept  hosts         = +relay_from_hosts
6107         control       = submission
6108 .endd
6109 This statement accepts the address if the message is coming from one of the
6110 hosts that are defined as being allowed to relay through this host. Recipient
6111 verification is omitted here, because in many cases the clients are dumb MUAs
6112 that do not cope well with SMTP error responses. For the same reason, the
6113 second line specifies &"submission mode"& for messages that are accepted. This
6114 is described in detail in section &<<SECTsubmodnon>>&; it causes Exim to fix
6115 messages that are deficient in some way, for example, because they lack a
6116 &'Date:'& header line. If you are actually relaying out from MTAs, you should
6117 probably add recipient verification here, and disable submission mode.
6118 .code
6119 accept  authenticated = *
6120         control       = submission
6121 .endd
6122 This statement accepts the address if the client host has authenticated itself.
6123 Submission mode is again specified, on the grounds that such messages are most
6124 likely to come from MUAs. The default configuration does not define any
6125 authenticators, though it does include some nearly complete commented-out
6126 examples described in &<<SECTdefconfauth>>&. This means that no client can in
6127 fact authenticate until you complete the authenticator definitions.
6128 .code
6129 require message = relay not permitted
6130         domains = +local_domains : +relay_to_domains
6131 .endd
6132 This statement rejects the address if its domain is neither a local domain nor
6133 one of the domains for which this host is a relay.
6134 .code
6135 require verify = recipient
6136 .endd
6137 This statement requires the recipient address to be verified; if verification
6138 fails, the address is rejected.
6139 .code
6140 # deny    dnslists    = black.list.example
6141 #         message     = rejected because $sender_host_address \
6142 #                       is in a black list at $dnslist_domain\n\
6143 #                       $dnslist_text
6144 #
6145 # warn    dnslists    = black.list.example
6146 #         add_header  = X-Warning: $sender_host_address is in \
6147 #                       a black list at $dnslist_domain
6148 #         log_message = found in $dnslist_domain
6149 .endd
6150 These commented-out lines are examples of how you could configure Exim to check
6151 sending hosts against a DNS black list. The first statement rejects messages
6152 from blacklisted hosts, whereas the second just inserts a warning header
6153 line.
6154 .code
6155 # require verify = csa
6156 .endd
6157 This commented-out line is an example of how you could turn on client SMTP
6158 authorization (CSA) checking. Such checks do DNS lookups for special SRV
6159 records.
6160 .code
6161 accept
6162 .endd
6163 The final statement in the first ACL unconditionally accepts any recipient
6164 address that has successfully passed all the previous tests.
6165 .code
6166 acl_check_data:
6167 .endd
6168 This line marks the start of the second ACL, and names it. Most of the contents
6169 of this ACL are commented out:
6170 .code
6171 # deny    malware   = *
6172 #         message   = This message contains a virus \
6173 #                     ($malware_name).
6174 .endd
6175 These lines are examples of how to arrange for messages to be scanned for
6176 viruses when Exim has been compiled with the content-scanning extension, and a
6177 suitable virus scanner is installed. If the message is found to contain a
6178 virus, it is rejected with the given custom error message.
6179 .code
6180 # warn    spam      = nobody
6181 #         message   = X-Spam_score: $spam_score\n\
6182 #                     X-Spam_score_int: $spam_score_int\n\
6183 #                     X-Spam_bar: $spam_bar\n\
6184 #                     X-Spam_report: $spam_report
6185 .endd
6186 These lines are an example of how to arrange for messages to be scanned by
6187 SpamAssassin when Exim has been compiled with the content-scanning extension,
6188 and SpamAssassin has been installed. The SpamAssassin check is run with
6189 &`nobody`& as its user parameter, and the results are added to the message as a
6190 series of extra header line. In this case, the message is not rejected,
6191 whatever the spam score.
6192 .code
6193 accept
6194 .endd
6195 This final line in the DATA ACL accepts the message unconditionally.
6196
6197
6198 .section "Router configuration" "SECID55"
6199 .cindex "default" "routers"
6200 .cindex "routers" "default"
6201 The router configuration comes next in the default configuration, introduced
6202 by the line
6203 .code
6204 begin routers
6205 .endd
6206 Routers are the modules in Exim that make decisions about where to send
6207 messages. An address is passed to each router, in turn, until it is either
6208 accepted, or failed. This means that the order in which you define the routers
6209 matters. Each router is fully described in its own chapter later in this
6210 manual. Here we give only brief overviews.
6211 .code
6212 # domain_literal:
6213 #   driver = ipliteral
6214 #   domains = !+local_domains
6215 #   transport = remote_smtp
6216 .endd
6217 .cindex "domain literal" "default router"
6218 This router is commented out because the majority of sites do not want to
6219 support domain literal addresses (those of the form &'user@[10.9.8.7]'&). If
6220 you uncomment this router, you also need to uncomment the setting of
6221 &%allow_domain_literals%& in the main part of the configuration.
6222
6223 Which router is used next depends upon whether or not the ROUTER_SMARTHOST
6224 macro has been defined, per
6225 .code
6226 .ifdef ROUTER_SMARTHOST
6227 smarthost:
6228 #...
6229 .else
6230 dnslookup:
6231 #...
6232 .endif
6233 .endd
6234
6235 If ROUTER_SMARTHOST has been defined, either at the top of the file or on the
6236 command-line, then we route all non-local mail to that smarthost; otherwise, we'll
6237 perform DNS lookups for direct-to-MX lookup.  Any mail which is to a local domain will
6238 skip these routers because of the &%domains%& option.
6239
6240 .code
6241 smarthost:
6242   driver = manualroute
6243   domains = ! +local_domains
6244   transport = smarthost_smtp
6245   route_data = ROUTER_SMARTHOST
6246   ignore_target_hosts = <; 0.0.0.0 ; 127.0.0.0/8 ; ::1
6247   no_more
6248 .endd
6249 This router only handles mail which is not to any local domains; this is
6250 specified by the line
6251 .code
6252 domains = ! +local_domains
6253 .endd
6254 The &%domains%& option lists the domains to which this router applies, but the
6255 exclamation mark is a negation sign, so the router is used only for domains
6256 that are not in the domain list called &'local_domains'& (which was defined at
6257 the start of the configuration). The plus sign before &'local_domains'&
6258 indicates that it is referring to a named list. Addresses in other domains are
6259 passed on to the following routers.
6260
6261 The name of the router driver is &(manualroute)& because we are manually
6262 specifying how mail should be routed onwards, instead of using DNS MX.
6263 While the name of this router instance is arbitrary, the &%driver%& option must
6264 be one of the driver modules that is in the Exim binary.
6265
6266 With no pre-conditions other than &%domains%&, all mail for non-local domains
6267 will be handled by this router, and the &%no_more%& setting will ensure that no
6268 other routers will be used for messages matching the pre-conditions.  See
6269 &<<SECTrouprecon>>& for more on how the pre-conditions apply.  For messages which
6270 are handled by this router, we provide a hostname to deliver to in &%route_data%&
6271 and the macro supplies the value; the address is then queued for the
6272 &(smarthost_smtp)& transport.
6273
6274 .code
6275 dnslookup:
6276   driver = dnslookup
6277   domains = ! +local_domains
6278   transport = remote_smtp
6279   ignore_target_hosts = 0.0.0.0 : 127.0.0.0/8
6280   no_more
6281 .endd
6282 The &%domains%& option behaves as per smarthost, above.
6283
6284 The name of the router driver is &(dnslookup)&,
6285 and is specified by the &%driver%& option. Do not be confused by the fact that
6286 the name of this router instance is the same as the name of the driver. The
6287 instance name is arbitrary, but the name set in the &%driver%& option must be
6288 one of the driver modules that is in the Exim binary.
6289
6290 The &(dnslookup)& router routes addresses by looking up their domains in the
6291 DNS in order to obtain a list of hosts to which the address is routed. If the
6292 router succeeds, the address is queued for the &(remote_smtp)& transport, as
6293 specified by the &%transport%& option. If the router does not find the domain
6294 in the DNS, no further routers are tried because of the &%no_more%& setting, so
6295 the address fails and is bounced.
6296
6297 The &%ignore_target_hosts%& option specifies a list of IP addresses that are to
6298 be entirely ignored. This option is present because a number of cases have been
6299 encountered where MX records in the DNS point to host names
6300 whose IP addresses are 0.0.0.0 or are in the 127 subnet (typically 127.0.0.1).
6301 Completely ignoring these IP addresses causes Exim to fail to route the
6302 email address, so it bounces. Otherwise, Exim would log a routing problem, and
6303 continue to try to deliver the message periodically until the address timed
6304 out.
6305 .code
6306 system_aliases:
6307   driver = redirect
6308   allow_fail
6309   allow_defer
6310   data = ${lookup{$local_part}lsearch{/etc/aliases}}
6311 # user = exim
6312   file_transport = address_file
6313   pipe_transport = address_pipe
6314 .endd
6315 Control reaches this and subsequent routers only for addresses in the local
6316 domains. This router checks to see whether the local part is defined as an
6317 alias in the &_/etc/aliases_& file, and if so, redirects it according to the
6318 data that it looks up from that file. If no data is found for the local part,
6319 the value of the &%data%& option is empty, causing the address to be passed to
6320 the next router.
6321
6322 &_/etc/aliases_& is a conventional name for the system aliases file that is
6323 often used. That is why it is referenced by from the default configuration
6324 file. However, you can change this by setting SYSTEM_ALIASES_FILE in
6325 &_Local/Makefile_& before building Exim.
6326 .code
6327 userforward:
6328   driver = redirect
6329   check_local_user
6330 # local_part_suffix = +* : -*
6331 # local_part_suffix_optional
6332   file = $home/.forward
6333 # allow_filter
6334   no_verify
6335   no_expn
6336   check_ancestor
6337   file_transport = address_file
6338   pipe_transport = address_pipe
6339   reply_transport = address_reply
6340 .endd
6341 This is the most complicated router in the default configuration. It is another
6342 redirection router, but this time it is looking for forwarding data set up by
6343 individual users. The &%check_local_user%& setting specifies a check that the
6344 local part of the address is the login name of a local user. If it is not, the
6345 router is skipped. The two commented options that follow &%check_local_user%&,
6346 namely:
6347 .code
6348 # local_part_suffix = +* : -*
6349 # local_part_suffix_optional
6350 .endd
6351 .vindex "&$local_part_suffix$&"
6352 show how you can specify the recognition of local part suffixes. If the first
6353 is uncommented, a suffix beginning with either a plus or a minus sign, followed
6354 by any sequence of characters, is removed from the local part and placed in the
6355 variable &$local_part_suffix$&. The second suffix option specifies that the
6356 presence of a suffix in the local part is optional. When a suffix is present,
6357 the check for a local login uses the local part with the suffix removed.
6358
6359 When a local user account is found, the file called &_.forward_& in the user's
6360 home directory is consulted. If it does not exist, or is empty, the router
6361 declines. Otherwise, the contents of &_.forward_& are interpreted as
6362 redirection data (see chapter &<<CHAPredirect>>& for more details).
6363
6364 .cindex "Sieve filter" "enabling in default router"
6365 Traditional &_.forward_& files contain just a list of addresses, pipes, or
6366 files. Exim supports this by default. However, if &%allow_filter%& is set (it
6367 is commented out by default), the contents of the file are interpreted as a set
6368 of Exim or Sieve filtering instructions, provided the file begins with &"#Exim
6369 filter"& or &"#Sieve filter"&, respectively. User filtering is discussed in the
6370 separate document entitled &'Exim's interfaces to mail filtering'&.
6371
6372 The &%no_verify%& and &%no_expn%& options mean that this router is skipped when
6373 verifying addresses, or when running as a consequence of an SMTP EXPN command.
6374 There are two reasons for doing this:
6375
6376 .olist
6377 Whether or not a local user has a &_.forward_& file is not really relevant when
6378 checking an address for validity; it makes sense not to waste resources doing
6379 unnecessary work.
6380 .next
6381 More importantly, when Exim is verifying addresses or handling an EXPN
6382 command during an SMTP session, it is running as the Exim user, not as root.
6383 The group is the Exim group, and no additional groups are set up.
6384 It may therefore not be possible for Exim to read users' &_.forward_& files at
6385 this time.
6386 .endlist
6387
6388 The setting of &%check_ancestor%& prevents the router from generating a new
6389 address that is the same as any previous address that was redirected. (This
6390 works round a problem concerning a bad interaction between aliasing and
6391 forwarding &-- see section &<<SECTredlocmai>>&).
6392
6393 The final three option settings specify the transports that are to be used when
6394 forwarding generates a direct delivery to a file, or to a pipe, or sets up an
6395 auto-reply, respectively. For example, if a &_.forward_& file contains
6396 .code
6397 a.nother@elsewhere.example, /home/spqr/archive
6398 .endd
6399 the delivery to &_/home/spqr/archive_& is done by running the &%address_file%&
6400 transport.
6401 .code
6402 localuser:
6403   driver = accept
6404   check_local_user
6405 # local_part_suffix = +* : -*
6406 # local_part_suffix_optional
6407   transport = local_delivery
6408 .endd
6409 The final router sets up delivery into local mailboxes, provided that the local
6410 part is the name of a local login, by accepting the address and assigning it to
6411 the &(local_delivery)& transport. Otherwise, we have reached the end of the
6412 routers, so the address is bounced. The commented suffix settings fulfil the
6413 same purpose as they do for the &(userforward)& router.
6414
6415
6416 .section "Transport configuration" "SECID56"
6417 .cindex "default" "transports"
6418 .cindex "transports" "default"
6419 Transports define mechanisms for actually delivering messages. They operate
6420 only when referenced from routers, so the order in which they are defined does
6421 not matter. The transports section of the configuration starts with
6422 .code
6423 begin transports
6424 .endd
6425 Two remote transports and four local transports are defined.
6426 .code
6427 remote_smtp:
6428   driver = smtp
6429   message_size_limit = ${if > {$max_received_linelength}{998} {1}{0}}
6430 .ifdef _HAVE_PRDR
6431   hosts_try_prdr = *
6432 .endif
6433 .endd
6434 This transport is used for delivering messages over SMTP connections.
6435 The list of remote hosts comes from the router.
6436 The &%message_size_limit%& usage is a hack to avoid sending on messages
6437 with over-long lines.
6438
6439 The &%hosts_try_prdr%& option enables an efficiency SMTP option.  It is
6440 negotiated between client and server and not expected to cause problems
6441 but can be disabled if needed.  The built-in macro _HAVE_PRDR guards the
6442 use of the &%hosts_try_prdr%& configuration option.
6443
6444 The other remote transport is used when delivering to a specific smarthost
6445 with whom there must be some kind of existing relationship, instead of the
6446 usual federated system.
6447
6448 .code
6449 smarthost_smtp:
6450   driver = smtp
6451   message_size_limit = ${if > {$max_received_linelength}{998} {1}{0}}
6452   multi_domain
6453   #
6454 .ifdef _HAVE_TLS
6455   # Comment out any of these which you have to, then file a Support
6456   # request with your smarthost provider to get things fixed:
6457   hosts_require_tls = *
6458   tls_verify_hosts = *
6459   # As long as tls_verify_hosts is enabled, this this will have no effect,
6460   # but if you have to comment it out then this will at least log whether
6461   # you succeed or not:
6462   tls_try_verify_hosts = *
6463   #
6464   # The SNI name should match the name which we'll expect to verify;
6465   # many mail systems don't use SNI and this doesn't matter, but if it does,
6466   # we need to send a name which the remote site will recognize.
6467   # This _should_ be the name which the smarthost operators specified as
6468   # the hostname for sending your mail to.
6469   tls_sni = ROUTER_SMARTHOST
6470   #
6471 .ifdef _HAVE_OPENSSL
6472   tls_require_ciphers = HIGH:!aNULL:@STRENGTH
6473 .endif
6474 .ifdef _HAVE_GNUTLS
6475   tls_require_ciphers = SECURE192:-VERS-SSL3.0:-VERS-TLS1.0:-VERS-TLS1.1
6476 .endif
6477 .endif
6478 .ifdef _HAVE_PRDR
6479   hosts_try_prdr = *
6480 .endif
6481 .endd
6482 After the same &%message_size_limit%& hack, we then specify that this Transport
6483 can handle messages to multiple domains in one run.  The assumption here is
6484 that you're routing all non-local mail to the same place and that place is
6485 happy to take all messages from you as quickly as possible.
6486 All other options depend upon built-in macros; if Exim was built without TLS support
6487 then no other options are defined.
6488 If TLS is available, then we configure "stronger than default" TLS ciphersuites
6489 and versions using the &%tls_require_ciphers%& option, where the value to be
6490 used depends upon the library providing TLS.
6491 Beyond that, the options adopt the stance that you should have TLS support available
6492 from your smarthost on today's Internet, so we turn on requiring TLS for the
6493 mail to be delivered, and requiring that the certificate be valid, and match
6494 the expected hostname.  The &%tls_sni%& option can be used by service providers
6495 to select an appropriate certificate to present to you and here we re-use the
6496 ROUTER_SMARTHOST macro, because that is unaffected by CNAMEs present in DNS.
6497 You want to specify the hostname which you'll expect to validate for, and that
6498 should not be subject to insecure tampering via DNS results.
6499
6500 For the &%hosts_try_prdr%& option see the previous transport.
6501
6502 All other options are defaulted.
6503 .code
6504 local_delivery:
6505   driver = appendfile
6506   file = /var/mail/$local_part_data
6507   delivery_date_add
6508   envelope_to_add
6509   return_path_add
6510 # group = mail
6511 # mode = 0660
6512 .endd
6513 This &(appendfile)& transport is used for local delivery to user mailboxes in
6514 traditional BSD mailbox format.
6515
6516 We prefer to avoid using &$local_part$& directly to define the mailbox filename,
6517 as it is provided by a potential bad actor.
6518 Instead we use &$local_part_data$&,
6519 the result of looking up &$local_part$& in the user database
6520 (done by using &%check_local_user%& in the the router).
6521
6522 By default &(appendfile)& runs under the uid and gid of the
6523 local user, which requires the sticky bit to be set on the &_/var/mail_&
6524 directory. Some systems use the alternative approach of running mail deliveries
6525 under a particular group instead of using the sticky bit. The commented options
6526 show how this can be done.
6527
6528 Exim adds three headers to the message as it delivers it: &'Delivery-date:'&,
6529 &'Envelope-to:'& and &'Return-path:'&. This action is requested by the three
6530 similarly-named options above.
6531 .code
6532 address_pipe:
6533   driver = pipe
6534   return_output
6535 .endd
6536 This transport is used for handling deliveries to pipes that are generated by
6537 redirection (aliasing or users' &_.forward_& files). The &%return_output%&
6538 option specifies that any output on stdout or stderr generated by the pipe is to
6539 be returned to the sender.
6540 .code
6541 address_file:
6542   driver = appendfile
6543   delivery_date_add
6544   envelope_to_add
6545   return_path_add
6546 .endd
6547 This transport is used for handling deliveries to files that are generated by
6548 redirection. The name of the file is not specified in this instance of
6549 &(appendfile)&, because it comes from the &(redirect)& router.
6550 .code
6551 address_reply:
6552   driver = autoreply
6553 .endd
6554 This transport is used for handling automatic replies generated by users'
6555 filter files.
6556
6557
6558
6559 .section "Default retry rule" "SECID57"
6560 .cindex "retry" "default rule"
6561 .cindex "default" "retry rule"
6562 The retry section of the configuration file contains rules which affect the way
6563 Exim retries deliveries that cannot be completed at the first attempt. It is
6564 introduced by the line
6565 .code
6566 begin retry
6567 .endd
6568 In the default configuration, there is just one rule, which applies to all
6569 errors:
6570 .code
6571 *   *   F,2h,15m; G,16h,1h,1.5; F,4d,6h
6572 .endd
6573 This causes any temporarily failing address to be retried every 15 minutes for
6574 2 hours, then at intervals starting at one hour and increasing by a factor of
6575 1.5 until 16 hours have passed, then every 6 hours up to 4 days. If an address
6576 is not delivered after 4 days of temporary failure, it is bounced. The time is
6577 measured from first failure, not from the time the message was received.
6578
6579 If the retry section is removed from the configuration, or is empty (that is,
6580 if no retry rules are defined), Exim will not retry deliveries. This turns
6581 temporary errors into permanent errors.
6582
6583
6584 .section "Rewriting configuration" "SECID58"
6585 The rewriting section of the configuration, introduced by
6586 .code
6587 begin rewrite
6588 .endd
6589 contains rules for rewriting addresses in messages as they arrive. There are no
6590 rewriting rules in the default configuration file.
6591
6592
6593
6594 .section "Authenticators configuration" "SECTdefconfauth"
6595 .cindex "AUTH" "configuration"
6596 The authenticators section of the configuration, introduced by
6597 .code
6598 begin authenticators
6599 .endd
6600 defines mechanisms for the use of the SMTP AUTH command. The default
6601 configuration file contains two commented-out example authenticators
6602 which support plaintext username/password authentication using the
6603 standard PLAIN mechanism and the traditional but non-standard LOGIN
6604 mechanism, with Exim acting as the server. PLAIN and LOGIN are enough
6605 to support most MUA software.
6606
6607 The example PLAIN authenticator looks like this:
6608 .code
6609 #PLAIN:
6610 #  driver                  = plaintext
6611 #  server_set_id           = $auth2
6612 #  server_prompts          = :
6613 #  server_condition        = Authentication is not yet configured
6614 #  server_advertise_condition = ${if def:tls_in_cipher }
6615 .endd
6616 And the example LOGIN authenticator looks like this:
6617 .code
6618 #LOGIN:
6619 #  driver                  = plaintext
6620 #  server_set_id           = $auth1
6621 #  server_prompts          = <| Username: | Password:
6622 #  server_condition        = Authentication is not yet configured
6623 #  server_advertise_condition = ${if def:tls_in_cipher }
6624 .endd
6625
6626 The &%server_set_id%& option makes Exim remember the authenticated username
6627 in &$authenticated_id$&, which can be used later in ACLs or routers. The
6628 &%server_prompts%& option configures the &(plaintext)& authenticator so
6629 that it implements the details of the specific authentication mechanism,
6630 i.e. PLAIN or LOGIN. The &%server_advertise_condition%& setting controls
6631 when Exim offers authentication to clients; in the examples, this is only
6632 when TLS or SSL has been started, so to enable the authenticators you also
6633 need to add support for TLS as described in section &<<SECTdefconfmain>>&.
6634
6635 The &%server_condition%& setting defines how to verify that the username and
6636 password are correct. In the examples it just produces an error message.
6637 To make the authenticators work, you can use a string expansion
6638 expression like one of the examples in chapter &<<CHAPplaintext>>&.
6639
6640 Beware that the sequence of the parameters to PLAIN and LOGIN differ; the
6641 usercode and password are in different positions.
6642 Chapter &<<CHAPplaintext>>& covers both.
6643
6644 .ecindex IIDconfiwal
6645
6646
6647
6648 . ////////////////////////////////////////////////////////////////////////////
6649 . ////////////////////////////////////////////////////////////////////////////
6650
6651 .chapter "Regular expressions" "CHAPregexp"
6652
6653 .cindex "regular expressions" "library"
6654 .cindex "PCRE"
6655 Exim supports the use of regular expressions in many of its options. It
6656 uses the PCRE regular expression library; this provides regular expression
6657 matching that is compatible with Perl 5. The syntax and semantics of
6658 regular expressions is discussed in
6659 online Perl manpages, in
6660 many Perl reference books, and also in
6661 Jeffrey Friedl's &'Mastering Regular Expressions'&, which is published by
6662 O'Reilly (see &url(http://www.oreilly.com/catalog/regex2/)).
6663 . --- the http: URL here redirects to another page with the ISBN in the URL
6664 . --- where trying to use https: just redirects back to http:, so sticking
6665 . --- to the old URL for now.  2018-09-07.
6666
6667 The documentation for the syntax and semantics of the regular expressions that
6668 are supported by PCRE is included in the PCRE distribution, and no further
6669 description is included here. The PCRE functions are called from Exim using
6670 the default option settings (that is, with no PCRE options set), except that
6671 the PCRE_CASELESS option is set when the matching is required to be
6672 case-insensitive.
6673
6674 In most cases, when a regular expression is required in an Exim configuration,
6675 it has to start with a circumflex, in order to distinguish it from plain text
6676 or an &"ends with"& wildcard. In this example of a configuration setting, the
6677 second item in the colon-separated list is a regular expression.
6678 .code
6679 domains = a.b.c : ^\\d{3} : *.y.z : ...
6680 .endd
6681 The doubling of the backslash is required because of string expansion that
6682 precedes interpretation &-- see section &<<SECTlittext>>& for more discussion
6683 of this issue, and a way of avoiding the need for doubling backslashes. The
6684 regular expression that is eventually used in this example contains just one
6685 backslash. The circumflex is included in the regular expression, and has the
6686 normal effect of &"anchoring"& it to the start of the string that is being
6687 matched.
6688
6689 There are, however, two cases where a circumflex is not required for the
6690 recognition of a regular expression: these are the &%match%& condition in a
6691 string expansion, and the &%matches%& condition in an Exim filter file. In
6692 these cases, the relevant string is always treated as a regular expression; if
6693 it does not start with a circumflex, the expression is not anchored, and can
6694 match anywhere in the subject string.
6695
6696 In all cases, if you want a regular expression to match at the end of a string,
6697 you must code the $ metacharacter to indicate this. For example:
6698 .code
6699 domains = ^\\d{3}\\.example
6700 .endd
6701 matches the domain &'123.example'&, but it also matches &'123.example.com'&.
6702 You need to use:
6703 .code
6704 domains = ^\\d{3}\\.example\$
6705 .endd
6706 if you want &'example'& to be the top-level domain. The backslash before the
6707 $ is needed because string expansion also interprets dollar characters.
6708
6709
6710
6711 . ////////////////////////////////////////////////////////////////////////////
6712 . ////////////////////////////////////////////////////////////////////////////
6713
6714 .chapter "File and database lookups" "CHAPfdlookup"
6715 .scindex IIDfidalo1 "file" "lookups"
6716 .scindex IIDfidalo2 "database" "lookups"
6717 .cindex "lookup" "description of"
6718 Exim can be configured to look up data in files or databases as it processes
6719 messages. Two different kinds of syntax are used:
6720
6721 .olist
6722 A string that is to be expanded may contain explicit lookup requests. These
6723 cause parts of the string to be replaced by data that is obtained from the
6724 lookup. Lookups of this type are conditional expansion items. Different results
6725 can be defined for the cases of lookup success and failure. See chapter
6726 &<<CHAPexpand>>&, where string expansions are described in detail.
6727 The key for the lookup is &*specified*& as part of the string expansion.
6728 .next
6729 Lists of domains, hosts, and email addresses can contain lookup requests as a
6730 way of avoiding excessively long linear lists. In this case, the data that is
6731 returned by the lookup is often (but not always) discarded; whether the lookup
6732 succeeds or fails is what really counts. These kinds of list are described in
6733 chapter &<<CHAPdomhosaddlists>>&.
6734 The key for the lookup is &*implicit*&,
6735 given by the context in which the list is expanded.
6736 .endlist
6737
6738 String expansions, lists, and lookups interact with each other in such a way
6739 that there is no order in which to describe any one of them that does not
6740 involve references to the others. Each of these three chapters makes more sense
6741 if you have read the other two first. If you are reading this for the first
6742 time, be aware that some of it will make a lot more sense after you have read
6743 chapters &<<CHAPdomhosaddlists>>& and &<<CHAPexpand>>&.
6744
6745 .section "Examples of different lookup syntax" "SECID60"
6746 It is easy to confuse the two different kinds of lookup, especially as the
6747 lists that may contain the second kind are always expanded before being
6748 processed as lists. Therefore, they may also contain lookups of the first kind.
6749 Be careful to distinguish between the following two examples:
6750 .code
6751 domains = ${lookup{$sender_host_address}lsearch{/some/file}}
6752 domains = lsearch;/some/file
6753 .endd
6754 The first uses a string expansion, the result of which must be a domain list.
6755 No strings have been specified for a successful or a failing lookup; the
6756 defaults in this case are the looked-up data and an empty string, respectively.
6757 The expansion takes place before the string is processed as a list, and the
6758 file that is searched could contain lines like this:
6759 .code
6760 192.168.3.4: domain1:domain2:...
6761 192.168.1.9: domain3:domain4:...
6762 .endd
6763 When the lookup succeeds, the result of the expansion is a list of domains (and
6764 possibly other types of item that are allowed in domain lists).
6765 .cindex "tainted data" "de-tainting"
6766 The result of the expansion is not tainted.
6767
6768 In the second example, the lookup is a single item in a domain list. It causes
6769 Exim to use a lookup to see if the domain that is being processed can be found
6770 in the file.
6771 The file could contains lines like this:
6772 .code
6773 domain1:
6774 domain2:
6775 .endd
6776 Any data that follows the keys is not relevant when checking that the domain
6777 matches the list item.
6778
6779 It is possible, though no doubt confusing, to use both kinds of lookup at once.
6780 Consider a file containing lines like this:
6781 .code
6782 192.168.5.6: lsearch;/another/file
6783 .endd
6784 If the value of &$sender_host_address$& is 192.168.5.6, expansion of the
6785 first &%domains%& setting above generates the second setting, which therefore
6786 causes a second lookup to occur.
6787
6788 .new
6789 The lookup type may optionally be followed by a comma
6790 and a comma-separated list of options.
6791 Each option is a &"name=value"& pair.
6792 Whether an option is meaningful depends on the lookup type.
6793
6794 All lookups support the option &"cache=no_rd"&.
6795 If this is given then the cache that Exim manages for lookup results
6796 is not checked before doing the lookup.
6797 The result of the lookup is still written to the cache.
6798 .wen
6799
6800 The rest of this chapter describes the different lookup types that are
6801 available. Any of them can be used in any part of the configuration where a
6802 lookup is permitted.
6803
6804
6805 .section "Lookup types" "SECID61"
6806 .cindex "lookup" "types of"
6807 .cindex "single-key lookup" "definition of"
6808 Two different types of data lookup are implemented:
6809
6810 .ilist
6811 The &'single-key'& type requires the specification of a file in which to look,
6812 and a single key to search for. The key must be a non-empty string for the
6813 lookup to succeed. The lookup type determines how the file is searched.
6814 .cindex "tainted data" "single-key lookups"
6815 The file string may not be tainted
6816
6817 .cindex "tainted data" "de-tainting"
6818 All single-key lookups support the option &"ret=key"&.
6819 If this is given and the lookup
6820 (either underlying implementation or cached value)
6821 returns data, the result is replaced with a non-tainted
6822 version of the lookup key.
6823 .cindex "tainted data" "de-tainting"
6824 .next
6825 .cindex "query-style lookup" "definition of"
6826 The &'query-style'& type accepts a generalized database query. No particular
6827 key value is assumed by Exim for query-style lookups. You can use whichever
6828 Exim variables you need to construct the database query.
6829 .endlist
6830
6831 The code for each lookup type is in a separate source file that is included in
6832 the binary of Exim only if the corresponding compile-time option is set. The
6833 default settings in &_src/EDITME_& are:
6834 .code
6835 LOOKUP_DBM=yes
6836 LOOKUP_LSEARCH=yes
6837 .endd
6838 which means that only linear searching and DBM lookups are included by default.
6839 For some types of lookup (e.g. SQL databases), you need to install appropriate
6840 libraries and header files before building Exim.
6841
6842
6843
6844
6845 .section "Single-key lookup types" "SECTsinglekeylookups"
6846 .cindex "lookup" "single-key types"
6847 .cindex "single-key lookup" "list of types"
6848 The following single-key lookup types are implemented:
6849
6850 .ilist
6851 .cindex "cdb" "description of"
6852 .cindex "lookup" "cdb"
6853 .cindex "binary zero" "in lookup key"
6854 &(cdb)&: The given file is searched as a Constant DataBase file, using the key
6855 string without a terminating binary zero. The cdb format is designed for
6856 indexed files that are read frequently and never updated, except by total
6857 re-creation. As such, it is particularly suitable for large files containing
6858 aliases or other indexed data referenced by an MTA. Information about cdb and
6859 tools for building the files can be found in several places:
6860 .display
6861 &url(https://cr.yp.to/cdb.html)
6862 &url(https://www.corpit.ru/mjt/tinycdb.html)
6863 &url(https://packages.debian.org/stable/utils/freecdb)
6864 &url(https://github.com/philpennock/cdbtools) (in Go)
6865 .endd
6866 A cdb distribution is not needed in order to build Exim with cdb support,
6867 because the code for reading cdb files is included directly in Exim itself.
6868 However, no means of building or testing cdb files is provided with Exim, so
6869 you need to obtain a cdb distribution in order to do this.
6870 .next
6871 .cindex "DBM" "lookup type"
6872 .cindex "lookup" "dbm"
6873 .cindex "binary zero" "in lookup key"
6874 &(dbm)&: Calls to DBM library functions are used to extract data from the given
6875 DBM file by looking up the record with the given key. A terminating binary
6876 zero is included in the key that is passed to the DBM library. See section
6877 &<<SECTdb>>& for a discussion of DBM libraries.
6878
6879 .cindex "Berkeley DB library" "file format"
6880 For all versions of Berkeley DB, Exim uses the DB_HASH style of database
6881 when building DBM files using the &%exim_dbmbuild%& utility. However, when
6882 using Berkeley DB versions 3 or 4, it opens existing databases for reading with
6883 the DB_UNKNOWN option. This enables it to handle any of the types of database
6884 that the library supports, and can be useful for accessing DBM files created by
6885 other applications. (For earlier DB versions, DB_HASH is always used.)
6886 .next
6887 .cindex "lookup" "dbmjz"
6888 .cindex "lookup" "dbm &-- embedded NULs"
6889 .cindex "sasldb2"
6890 .cindex "dbmjz lookup type"
6891 &(dbmjz)&: This is the same as &(dbm)&, except that the lookup key is
6892 interpreted as an Exim list; the elements of the list are joined together with
6893 ASCII NUL characters to form the lookup key.  An example usage would be to
6894 authenticate incoming SMTP calls using the passwords from Cyrus SASL's
6895 &_/etc/sasldb2_& file with the &(gsasl)& authenticator or Exim's own
6896 &(cram_md5)& authenticator.
6897 .next
6898 .cindex "lookup" "dbmnz"
6899 .cindex "lookup" "dbm &-- terminating zero"
6900 .cindex "binary zero" "in lookup key"
6901 .cindex "Courier"
6902 .cindex "&_/etc/userdbshadow.dat_&"
6903 .cindex "dbmnz lookup type"
6904 &(dbmnz)&: This is the same as &(dbm)&, except that a terminating binary zero
6905 is not included in the key that is passed to the DBM library. You may need this
6906 if you want to look up data in files that are created by or shared with some
6907 other application that does not use terminating zeros. For example, you need to
6908 use &(dbmnz)& rather than &(dbm)& if you want to authenticate incoming SMTP
6909 calls using the passwords from Courier's &_/etc/userdbshadow.dat_& file. Exim's
6910 utility program for creating DBM files (&'exim_dbmbuild'&) includes the zeros
6911 by default, but has an option to omit them (see section &<<SECTdbmbuild>>&).
6912 .next
6913 .cindex "lookup" "dsearch"
6914 .cindex "dsearch lookup type"
6915 &(dsearch)&: The given file must be an
6916 absolute
6917 directory path; this is searched for an entry
6918 whose name is the key by calling the &[lstat()]& function.
6919 The key may not
6920 contain any forward slash characters.
6921 If &[lstat()]& succeeds then so does the lookup.
6922 .cindex "tainted data" "dsearch result"
6923 The result is regarded as untainted.
6924
6925 Options for the lookup can be given by appending them after the word "dsearch",
6926 separated by a comma.  Options, if present, are a comma-separated list having
6927 each element starting with a tag name and an equals.
6928
6929 Two options are supported, for the return value and for filtering match
6930 candidates.
6931 The "ret" option requests an alternate result value of
6932 the entire path for the entry. Example:
6933 .code
6934 ${lookup {passwd} dsearch,ret=full {/etc}}
6935 .endd
6936 The default result is just the requested entry.
6937 The "filter" option requests that only directory entries of a given type
6938 are matched. The match value is one of "file", "dir" or "subdir" (the latter
6939 not matching "." or ".."). Example:
6940 .code
6941 ${lookup {passwd} dsearch,filter=file {/etc}}
6942 .endd
6943 The default matching is for any entry type, including directories
6944 and symlinks.
6945
6946 An example of how this
6947 lookup can be used to support virtual domains is given in section
6948 &<<SECTvirtualdomains>>&.
6949 .next
6950 .cindex "lookup" "iplsearch"
6951 .cindex "iplsearch lookup type"
6952 &(iplsearch)&: The given file is a text file containing keys and data. A key is
6953 terminated by a colon or white space or the end of the line. The keys in the
6954 file must be IP addresses, or IP addresses with CIDR masks. Keys that involve
6955 IPv6 addresses must be enclosed in quotes to prevent the first internal colon
6956 being interpreted as a key terminator. For example:
6957 .code
6958 1.2.3.4:           data for 1.2.3.4
6959 192.168.0.0/16:    data for 192.168.0.0/16
6960 "abcd::cdab":      data for abcd::cdab
6961 "abcd:abcd::/32"   data for abcd:abcd::/32
6962 .endd
6963 The key for an &(iplsearch)& lookup must be an IP address (without a mask). The
6964 file is searched linearly, using the CIDR masks where present, until a matching
6965 key is found. The first key that matches is used; there is no attempt to find a
6966 &"best"& match. Apart from the way the keys are matched, the processing for
6967 &(iplsearch)& is the same as for &(lsearch)&.
6968
6969 &*Warning 1*&: Unlike most other single-key lookup types, a file of data for
6970 &(iplsearch)& can &'not'& be turned into a DBM or cdb file, because those
6971 lookup types support only literal keys.
6972
6973 &*Warning 2*&: In a host list, you must always use &(net-iplsearch)& so that
6974 the implicit key is the host's IP address rather than its name (see section
6975 &<<SECThoslispatsikey>>&).
6976
6977 &*Warning 3*&: Do not use an IPv4-mapped IPv6 address for a key; use the
6978 IPv4, in dotted-quad form. (Exim converts IPv4-mapped IPv6 addresses to this
6979 notation before executing the lookup.)
6980
6981 .new
6982 One option is supported, "ret=full", to request the return of the entire line
6983 rather than omitting the key porttion.
6984 Note however that the key portion will have been de-quoted.
6985 .wen
6986
6987 .next
6988 .cindex lookup json
6989 .cindex json "lookup type"
6990 .cindex JSON expansions
6991 &(json)&: The given file is a text file with a JSON structure.
6992 An element of the structure is extracted, defined by the search key.
6993 The key is a list of subelement selectors
6994 (colon-separated by default but changeable in the usual way)
6995 which are applied in turn to select smaller and smaller portions
6996 of the JSON structure.
6997 If a selector is numeric, it must apply to a JSON array; the (zero-based)
6998 nunbered array element is selected.
6999 Otherwise it must apply to a JSON object; the named element is selected.
7000 The final resulting element can be a simple JSON type or a JSON object
7001 or array; for the latter two a string-representation of the JSON
7002 is returned.
7003 For elements of type string, the returned value is de-quoted.
7004
7005
7006 .new
7007 .next
7008 .cindex LMDB
7009 .cindex lookup lmdb
7010 .cindex database lmdb
7011 &(lmdb)&: The given file is an LMDB database.
7012 LMDB is a memory-mapped key-value store,
7013 with API modeled loosely on that of BerkeleyDB.
7014 See &url(https://symas.com/products/lightning-memory-mapped-database/)
7015 for the feature set and operation modes.
7016
7017 Exim provides read-only access via the LMDB C library.
7018 The library can be obtained from &url(https://github.com/LMDB/lmdb)
7019 or your operating system package repository.
7020 To enable LMDB support in Exim set LOOKUP_LMDB=yes in &_Local/Makefile_&.
7021
7022 You will need to separately create the LMDB database file,
7023 possibly using the &"mdb_load"& utility.
7024 .wen
7025
7026
7027 .next
7028 .cindex "linear search"
7029 .cindex "lookup" "lsearch"
7030 .cindex "lsearch lookup type"
7031 .cindex "case sensitivity" "in lsearch lookup"
7032 &(lsearch)&: The given file is a text file that is searched linearly for a
7033 line beginning with the search key, terminated by a colon or white space or the
7034 end of the line. The search is case-insensitive; that is, upper and lower case
7035 letters are treated as the same. The first occurrence of the key that is found
7036 in the file is used.
7037
7038 White space between the key and the colon is permitted. The remainder of the
7039 line, with leading and trailing white space removed, is the data. This can be
7040 continued onto subsequent lines by starting them with any amount of white
7041 space, but only a single space character is included in the data at such a
7042 junction. If the data begins with a colon, the key must be terminated by a
7043 colon, for example:
7044 .code
7045 baduser:  :fail:
7046 .endd
7047 Empty lines and lines beginning with # are ignored, even if they occur in the
7048 middle of an item. This is the traditional textual format of alias files. Note
7049 that the keys in an &(lsearch)& file are literal strings. There is no
7050 wildcarding of any kind.
7051
7052 .cindex "lookup" "lsearch &-- colons in keys"
7053 .cindex "white space" "in lsearch key"
7054 In most &(lsearch)& files, keys are not required to contain colons or #
7055 characters, or white space. However, if you need this feature, it is available.
7056 If a key begins with a doublequote character, it is terminated only by a
7057 matching quote (or end of line), and the normal escaping rules apply to its
7058 contents (see section &<<SECTstrings>>&). An optional colon is permitted after
7059 quoted keys (exactly as for unquoted keys). There is no special handling of
7060 quotes for the data part of an &(lsearch)& line.
7061
7062 .next
7063 .cindex "NIS lookup type"
7064 .cindex "lookup" "NIS"
7065 .cindex "binary zero" "in lookup key"
7066 &(nis)&: The given file is the name of a NIS map, and a NIS lookup is done with
7067 the given key, without a terminating binary zero. There is a variant called
7068 &(nis0)& which does include the terminating binary zero in the key. This is
7069 reportedly needed for Sun-style alias files. Exim does not recognize NIS
7070 aliases; the full map names must be used.
7071
7072 .next
7073 .cindex "wildlsearch lookup type"
7074 .cindex "lookup" "wildlsearch"
7075 .cindex "nwildlsearch lookup type"
7076 .cindex "lookup" "nwildlsearch"
7077 &(wildlsearch)& or &(nwildlsearch)&: These search a file linearly, like
7078 &(lsearch)&, but instead of being interpreted as a literal string, each key in
7079 the file may be wildcarded. The difference between these two lookup types is
7080 that for &(wildlsearch)&, each key in the file is string-expanded before being
7081 used, whereas for &(nwildlsearch)&, no expansion takes place.
7082
7083 .cindex "case sensitivity" "in (n)wildlsearch lookup"
7084 Like &(lsearch)&, the testing is done case-insensitively. However, keys in the
7085 file that are regular expressions can be made case-sensitive by the use of
7086 &`(-i)`& within the pattern. The following forms of wildcard are recognized:
7087
7088 . ==== As this is a nested list, any displays it contains must be indented
7089 . ==== as otherwise they are too far to the left.
7090
7091 .olist
7092 The string may begin with an asterisk to mean &"ends with"&. For example:
7093 .code
7094     *.a.b.c       data for anything.a.b.c
7095     *fish         data for anythingfish
7096 .endd
7097 .next
7098 The string may begin with a circumflex to indicate a regular expression. For
7099 example, for &(wildlsearch)&:
7100 .code
7101     ^\N\d+\.a\.b\N    data for <digits>.a.b
7102 .endd
7103 Note the use of &`\N`& to disable expansion of the contents of the regular
7104 expression. If you are using &(nwildlsearch)&, where the keys are not
7105 string-expanded, the equivalent entry is:
7106 .code
7107     ^\d+\.a\.b        data for <digits>.a.b
7108 .endd
7109 The case-insensitive flag is set at the start of compiling the regular
7110 expression, but it can be turned off by using &`(-i)`& at an appropriate point.
7111 For example, to make the entire pattern case-sensitive:
7112 .code
7113     ^(?-i)\d+\.a\.b        data for <digits>.a.b
7114 .endd
7115
7116 If the regular expression contains white space or colon characters, you must
7117 either quote it (see &(lsearch)& above), or represent these characters in other
7118 ways. For example, &`\s`& can be used for white space and &`\x3A`& for a
7119 colon. This may be easier than quoting, because if you quote, you have to
7120 escape all the backslashes inside the quotes.
7121
7122 &*Note*&: It is not possible to capture substrings in a regular expression
7123 match for later use, because the results of all lookups are cached. If a lookup
7124 is repeated, the result is taken from the cache, and no actual pattern matching
7125 takes place. The values of all the numeric variables are unset after a
7126 &((n)wildlsearch)& match.
7127
7128 .next
7129 Although I cannot see it being of much use, the general matching function that
7130 is used to implement &((n)wildlsearch)& means that the string may begin with a
7131 lookup name terminated by a semicolon, and followed by lookup data. For
7132 example:
7133 .code
7134     cdb;/some/file  data for keys that match the file
7135 .endd
7136 The data that is obtained from the nested lookup is discarded.
7137 .endlist olist
7138
7139 Keys that do not match any of these patterns are interpreted literally. The
7140 continuation rules for the data are the same as for &(lsearch)&, and keys may
7141 be followed by optional colons.
7142
7143 &*Warning*&: Unlike most other single-key lookup types, a file of data for
7144 &((n)wildlsearch)& can &'not'& be turned into a DBM or cdb file, because those
7145 lookup types support only literal keys.
7146
7147 .next
7148 .cindex "spf lookup type"
7149 .cindex "lookup" "spf"
7150 &(spf)&: If Exim is built with SPF support, manual lookups can be done
7151 (as opposed to the standard ACL condition method).
7152 For details see section &<<SECSPF>>&.
7153 .endlist ilist
7154
7155
7156 .section "Query-style lookup types" "SECTquerystylelookups"
7157 .cindex "lookup" "query-style types"
7158 .cindex "query-style lookup" "list of types"
7159 The supported query-style lookup types are listed below. Further details about
7160 many of them are given in later sections.
7161
7162 .ilist
7163 .cindex "DNS" "as a lookup type"
7164 .cindex "lookup" "DNS"
7165 &(dnsdb)&: This does a DNS search for one or more records whose domain names
7166 are given in the supplied query. The resulting data is the contents of the
7167 records. See section &<<SECTdnsdb>>&.
7168 .next
7169 .cindex "InterBase lookup type"
7170 .cindex "lookup" "InterBase"
7171 &(ibase)&: This does a lookup in an InterBase database.
7172 .next
7173 .cindex "LDAP" "lookup type"
7174 .cindex "lookup" "LDAP"
7175 &(ldap)&: This does an LDAP lookup using a query in the form of a URL, and
7176 returns attributes from a single entry. There is a variant called &(ldapm)&
7177 that permits values from multiple entries to be returned. A third variant
7178 called &(ldapdn)& returns the Distinguished Name of a single entry instead of
7179 any attribute values. See section &<<SECTldap>>&.
7180 .next
7181 .cindex "MySQL" "lookup type"
7182 .cindex "lookup" "MySQL"
7183 &(mysql)&: The format of the query is an SQL statement that is passed to a
7184 MySQL database. See section &<<SECTsql>>&.
7185 .next
7186 .cindex "NIS+ lookup type"
7187 .cindex "lookup" "NIS+"
7188 &(nisplus)&: This does a NIS+ lookup using a query that can specify the name of
7189 the field to be returned. See section &<<SECTnisplus>>&.
7190 .next
7191 .cindex "Oracle" "lookup type"
7192 .cindex "lookup" "Oracle"
7193 &(oracle)&: The format of the query is an SQL statement that is passed to an
7194 Oracle database. See section &<<SECTsql>>&.
7195 .next
7196 .cindex "lookup" "passwd"
7197 .cindex "passwd lookup type"
7198 .cindex "&_/etc/passwd_&"
7199 &(passwd)& is a query-style lookup with queries that are just user names. The
7200 lookup calls &[getpwnam()]& to interrogate the system password data, and on
7201 success, the result string is the same as you would get from an &(lsearch)&
7202 lookup on a traditional &_/etc/passwd file_&, though with &`*`& for the
7203 password value. For example:
7204 .code
7205 *:42:42:King Rat:/home/kr:/bin/bash
7206 .endd
7207 .next
7208 .cindex "PostgreSQL lookup type"
7209 .cindex "lookup" "PostgreSQL"
7210 &(pgsql)&: The format of the query is an SQL statement that is passed to a
7211 PostgreSQL database. See section &<<SECTsql>>&.
7212
7213 .next
7214 .cindex "Redis lookup type"
7215 .cindex lookup Redis
7216 &(redis)&: The format of the query is either a simple get or simple set,
7217 passed to a Redis database. See section &<<SECTsql>>&.
7218
7219 .next
7220 .cindex "sqlite lookup type"
7221 .cindex "lookup" "sqlite"
7222 &(sqlite)&: The format of the query is
7223 an SQL statement that is passed to an SQLite database. See section &<<SECTsqlite>>&.
7224
7225 .next
7226 &(testdb)&: This is a lookup type that is used for testing Exim. It is
7227 not likely to be useful in normal operation.
7228 .next
7229 .cindex "whoson lookup type"
7230 .cindex "lookup" "whoson"
7231 . --- still http:-only, 2018-09-07
7232 &(whoson)&: &'Whoson'& (&url(http://whoson.sourceforge.net)) is a protocol that
7233 allows a server to check whether a particular (dynamically allocated) IP
7234 address is currently allocated to a known (trusted) user and, optionally, to
7235 obtain the identity of the said user. For SMTP servers, &'Whoson'& was popular
7236 at one time for &"POP before SMTP"& authentication, but that approach has been
7237 superseded by SMTP authentication. In Exim, &'Whoson'& can be used to implement
7238 &"POP before SMTP"& checking using ACL statements such as
7239 .code
7240 require condition = \
7241   ${lookup whoson {$sender_host_address}{yes}{no}}
7242 .endd
7243 The query consists of a single IP address. The value returned is the name of
7244 the authenticated user, which is stored in the variable &$value$&. However, in
7245 this example, the data in &$value$& is not used; the result of the lookup is
7246 one of the fixed strings &"yes"& or &"no"&.
7247 .endlist
7248
7249
7250
7251 .section "Temporary errors in lookups" "SECID63"
7252 .cindex "lookup" "temporary error in"
7253 Lookup functions can return temporary error codes if the lookup cannot be
7254 completed. For example, an SQL or LDAP database might be unavailable. For this
7255 reason, it is not advisable to use a lookup that might do this for critical
7256 options such as a list of local domains.
7257
7258 When a lookup cannot be completed in a router or transport, delivery
7259 of the message (to the relevant address) is deferred, as for any other
7260 temporary error. In other circumstances Exim may assume the lookup has failed,
7261 or may give up altogether.
7262
7263
7264
7265 .section "Default values in single-key lookups" "SECTdefaultvaluelookups"
7266 .cindex "wildcard lookups"
7267 .cindex "lookup" "default values"
7268 .cindex "lookup" "wildcard"
7269 .cindex "lookup" "* added to type"
7270 .cindex "default" "in single-key lookups"
7271 In this context, a &"default value"& is a value specified by the administrator
7272 that is to be used if a lookup fails.
7273
7274 &*Note:*& This section applies only to single-key lookups. For query-style
7275 lookups, the facilities of the query language must be used. An attempt to
7276 specify a default for a query-style lookup provokes an error.
7277
7278 If &"*"& is added to a single-key lookup type (for example, &%lsearch*%&)
7279 and the initial lookup fails, the key &"*"& is looked up in the file to
7280 provide a default value. See also the section on partial matching below.
7281
7282 .cindex "*@ with single-key lookup"
7283 .cindex "lookup" "*@ added to type"
7284 .cindex "alias file" "per-domain default"
7285 Alternatively, if &"*@"& is added to a single-key lookup type (for example
7286 &%dbm*@%&) then, if the initial lookup fails and the key contains an @
7287 character, a second lookup is done with everything before the last @ replaced
7288 by *. This makes it possible to provide per-domain defaults in alias files
7289 that include the domains in the keys. If the second lookup fails (or doesn't
7290 take place because there is no @ in the key), &"*"& is looked up.
7291 For example, a &(redirect)& router might contain:
7292 .code
7293 data = ${lookup{$local_part@$domain}lsearch*@{/etc/mix-aliases}}
7294 .endd
7295 Suppose the address that is being processed is &'jane@eyre.example'&. Exim
7296 looks up these keys, in this order:
7297 .code
7298 jane@eyre.example
7299 *@eyre.example
7300 *
7301 .endd
7302 The data is taken from whichever key it finds first. &*Note*&: In an
7303 &(lsearch)& file, this does not mean the first of these keys in the file. A
7304 complete scan is done for each key, and only if it is not found at all does
7305 Exim move on to try the next key.
7306
7307
7308
7309 .section "Partial matching in single-key lookups" "SECTpartiallookup"
7310 .cindex "partial matching"
7311 .cindex "wildcard lookups"
7312 .cindex "lookup" "partial matching"
7313 .cindex "lookup" "wildcard"
7314 .cindex "asterisk" "in search type"
7315 The normal operation of a single-key lookup is to search the file for an exact
7316 match with the given key. However, in a number of situations where domains are
7317 being looked up, it is useful to be able to do partial matching. In this case,
7318 information in the file that has a key starting with &"*."& is matched by any
7319 domain that ends with the components that follow the full stop. For example, if
7320 a key in a DBM file is
7321 .code
7322 *.dates.fict.example
7323 .endd
7324 then when partial matching is enabled this is matched by (amongst others)
7325 &'2001.dates.fict.example'& and &'1984.dates.fict.example'&. It is also matched
7326 by &'dates.fict.example'&, if that does not appear as a separate key in the
7327 file.
7328
7329 &*Note*&: Partial matching is not available for query-style lookups. It is
7330 also not available for any lookup items in address lists (see section
7331 &<<SECTaddresslist>>&).
7332
7333 Partial matching is implemented by doing a series of separate lookups using
7334 keys constructed by modifying the original subject key. This means that it can
7335 be used with any of the single-key lookup types, provided that
7336 partial matching keys
7337 beginning with a special prefix (default &"*."&) are included in the data file.
7338 Keys in the file that do not begin with the prefix are matched only by
7339 unmodified subject keys when partial matching is in use.
7340
7341 Partial matching is requested by adding the string &"partial-"& to the front of
7342 the name of a single-key lookup type, for example, &%partial-dbm%&. When this
7343 is done, the subject key is first looked up unmodified; if that fails, &"*."&
7344 is added at the start of the subject key, and it is looked up again. If that
7345 fails, further lookups are tried with dot-separated components removed from the
7346 start of the subject key, one-by-one, and &"*."& added on the front of what
7347 remains.
7348
7349 A minimum number of two non-* components are required. This can be adjusted
7350 by including a number before the hyphen in the search type. For example,
7351 &%partial3-lsearch%& specifies a minimum of three non-* components in the
7352 modified keys. Omitting the number is equivalent to &"partial2-"&. If the
7353 subject key is &'2250.dates.fict.example'& then the following keys are looked
7354 up when the minimum number of non-* components is two:
7355 .code
7356 2250.dates.fict.example
7357 *.2250.dates.fict.example
7358 *.dates.fict.example
7359 *.fict.example
7360 .endd
7361 As soon as one key in the sequence is successfully looked up, the lookup
7362 finishes.
7363
7364 .cindex "lookup" "partial matching &-- changing prefix"
7365 .cindex "prefix" "for partial matching"
7366 The use of &"*."& as the partial matching prefix is a default that can be
7367 changed. The motivation for this feature is to allow Exim to operate with file
7368 formats that are used by other MTAs. A different prefix can be supplied in
7369 parentheses instead of the hyphen after &"partial"&. For example:
7370 .code
7371 domains = partial(.)lsearch;/some/file
7372 .endd
7373 In this example, if the domain is &'a.b.c'&, the sequence of lookups is
7374 &`a.b.c`&, &`.a.b.c`&, and &`.b.c`& (the default minimum of 2 non-wild
7375 components is unchanged). The prefix may consist of any punctuation characters
7376 other than a closing parenthesis. It may be empty, for example:
7377 .code
7378 domains = partial1()cdb;/some/file
7379 .endd
7380 For this example, if the domain is &'a.b.c'&, the sequence of lookups is
7381 &`a.b.c`&, &`b.c`&, and &`c`&.
7382
7383 If &"partial0"& is specified, what happens at the end (when the lookup with
7384 just one non-wild component has failed, and the original key is shortened right
7385 down to the null string) depends on the prefix:
7386
7387 .ilist
7388 If the prefix has zero length, the whole lookup fails.
7389 .next
7390 If the prefix has length 1, a lookup for just the prefix is done. For
7391 example, the final lookup for &"partial0(.)"& is for &`.`& alone.
7392 .next
7393 Otherwise, if the prefix ends in a dot, the dot is removed, and the
7394 remainder is looked up. With the default prefix, therefore, the final lookup is
7395 for &"*"& on its own.
7396 .next
7397 Otherwise, the whole prefix is looked up.
7398 .endlist
7399
7400
7401 If the search type ends in &"*"& or &"*@"& (see section
7402 &<<SECTdefaultvaluelookups>>& above), the search for an ultimate default that
7403 this implies happens after all partial lookups have failed. If &"partial0"& is
7404 specified, adding &"*"& to the search type has no effect with the default
7405 prefix, because the &"*"& key is already included in the sequence of partial
7406 lookups. However, there might be a use for lookup types such as
7407 &"partial0(.)lsearch*"&.
7408
7409 The use of &"*"& in lookup partial matching differs from its use as a wildcard
7410 in domain lists and the like. Partial matching works only in terms of
7411 dot-separated components; a key such as &`*fict.example`&
7412 in a database file is useless, because the asterisk in a partial matching
7413 subject key is always followed by a dot.
7414
7415
7416
7417
7418 .section "Lookup caching" "SECID64"
7419 .cindex "lookup" "caching"
7420 .cindex "caching" "lookup data"
7421 Exim caches all lookup results in order to avoid needless repetition of
7422 lookups. However, because (apart from the daemon) Exim operates as a collection
7423 of independent, short-lived processes, this caching applies only within a
7424 single Exim process. There is no inter-process lookup caching facility.
7425
7426 For single-key lookups, Exim keeps the relevant files open in case there is
7427 another lookup that needs them. In some types of configuration this can lead to
7428 many files being kept open for messages with many recipients. To avoid hitting
7429 the operating system limit on the number of simultaneously open files, Exim
7430 closes the least recently used file when it needs to open more files than its
7431 own internal limit, which can be changed via the &%lookup_open_max%& option.
7432
7433 The single-key lookup files are closed and the lookup caches are flushed at
7434 strategic points during delivery &-- for example, after all routing is
7435 complete.
7436
7437
7438
7439
7440 .section "Quoting lookup data" "SECID65"
7441 .cindex "lookup" "quoting"
7442 .cindex "quoting" "in lookups"
7443 When data from an incoming message is included in a query-style lookup, there
7444 is the possibility of special characters in the data messing up the syntax of
7445 the query. For example, a NIS+ query that contains
7446 .code
7447 [name=$local_part]
7448 .endd
7449 will be broken if the local part happens to contain a closing square bracket.
7450 For NIS+, data can be enclosed in double quotes like this:
7451 .code
7452 [name="$local_part"]
7453 .endd
7454 but this still leaves the problem of a double quote in the data. The rule for
7455 NIS+ is that double quotes must be doubled. Other lookup types have different
7456 rules, and to cope with the differing requirements, an expansion operator
7457 of the following form is provided:
7458 .code
7459 ${quote_<lookup-type>:<string>}
7460 .endd
7461 For example, the safest way to write the NIS+ query is
7462 .code
7463 [name="${quote_nisplus:$local_part}"]
7464 .endd
7465 See chapter &<<CHAPexpand>>& for full coverage of string expansions. The quote
7466 operator can be used for all lookup types, but has no effect for single-key
7467 lookups, since no quoting is ever needed in their key strings.
7468
7469
7470
7471
7472 .section "More about dnsdb" "SECTdnsdb"
7473 .cindex "dnsdb lookup"
7474 .cindex "lookup" "dnsdb"
7475 .cindex "DNS" "as a lookup type"
7476 The &(dnsdb)& lookup type uses the DNS as its database. A simple query consists
7477 of a record type and a domain name, separated by an equals sign. For example,
7478 an expansion string could contain:
7479 .code
7480 ${lookup dnsdb{mx=a.b.example}{$value}fail}
7481 .endd
7482 If the lookup succeeds, the result is placed in &$value$&, which in this case
7483 is used on its own as the result. If the lookup does not succeed, the
7484 &`fail`& keyword causes a &'forced expansion failure'& &-- see section
7485 &<<SECTforexpfai>>& for an explanation of what this means.
7486
7487 The supported DNS record types are A, CNAME, MX, NS, PTR, SOA, SPF, SRV, TLSA
7488 and TXT, and, when Exim is compiled with IPv6 support, AAAA.
7489 If no type is given, TXT is assumed.
7490
7491 For any record type, if multiple records are found, the data is returned as a
7492 concatenation, with newline as the default separator. The order, of course,
7493 depends on the DNS resolver. You can specify a different separator character
7494 between multiple records by putting a right angle-bracket followed immediately
7495 by the new separator at the start of the query. For example:
7496 .code
7497 ${lookup dnsdb{>: a=host1.example}}
7498 .endd
7499 It is permitted to specify a space as the separator character. Further
7500 white space is ignored.
7501 For lookup types that return multiple fields per record,
7502 an alternate field separator can be specified using a comma after the main
7503 separator character, followed immediately by the field separator.
7504
7505 .cindex "PTR record" "in &(dnsdb)& lookup"
7506 When the type is PTR,
7507 the data can be an IP address, written as normal; inversion and the addition of
7508 &%in-addr.arpa%& or &%ip6.arpa%& happens automatically. For example:
7509 .code
7510 ${lookup dnsdb{ptr=192.168.4.5}{$value}fail}
7511 .endd
7512 If the data for a PTR record is not a syntactically valid IP address, it is not
7513 altered and nothing is added.
7514
7515 .cindex "MX record" "in &(dnsdb)& lookup"
7516 .cindex "SRV record" "in &(dnsdb)& lookup"
7517 For an MX lookup, both the preference value and the host name are returned for
7518 each record, separated by a space. For an SRV lookup, the priority, weight,
7519 port, and host name are returned for each record, separated by spaces.
7520 The field separator can be modified as above.
7521
7522 .cindex "TXT record" "in &(dnsdb)& lookup"
7523 .cindex "SPF record" "in &(dnsdb)& lookup"
7524 For TXT records with multiple items of data, only the first item is returned,
7525 unless a field separator is specified.
7526 To concatenate items without a separator, use a semicolon instead.
7527 For SPF records the
7528 default behaviour is to concatenate multiple items without using a separator.
7529 .code
7530 ${lookup dnsdb{>\n,: txt=a.b.example}}
7531 ${lookup dnsdb{>\n; txt=a.b.example}}
7532 ${lookup dnsdb{spf=example.org}}
7533 .endd
7534 It is permitted to specify a space as the separator character. Further
7535 white space is ignored.
7536
7537 .cindex "SOA record" "in &(dnsdb)& lookup"
7538 For an SOA lookup, while no result is obtained the lookup is redone with
7539 successively more leading components dropped from the given domain.
7540 Only the primary-nameserver field is returned unless a field separator is
7541 specified.
7542 .code
7543 ${lookup dnsdb{>:,; soa=a.b.example.com}}
7544 .endd
7545
7546 .section "Dnsdb lookup modifiers" "SECTdnsdb_mod"
7547 .cindex "dnsdb modifiers"
7548 .cindex "modifiers" "dnsdb"
7549 .cindex "options" "dnsdb"
7550 Modifiers for &(dnsdb)& lookups are given by optional keywords,
7551 each followed by a comma,
7552 that may appear before the record type.
7553
7554 The &(dnsdb)& lookup fails only if all the DNS lookups fail. If there is a
7555 temporary DNS error for any of them, the behaviour is controlled by
7556 a defer-option modifier.
7557 The possible keywords are
7558 &"defer_strict"&, &"defer_never"&, and &"defer_lax"&.
7559 With &"strict"& behaviour, any temporary DNS error causes the
7560 whole lookup to defer. With &"never"& behaviour, a temporary DNS error is
7561 ignored, and the behaviour is as if the DNS lookup failed to find anything.
7562 With &"lax"& behaviour, all the queries are attempted, but a temporary DNS
7563 error causes the whole lookup to defer only if none of the other lookups
7564 succeed. The default is &"lax"&, so the following lookups are equivalent:
7565 .code
7566 ${lookup dnsdb{defer_lax,a=one.host.com:two.host.com}}
7567 ${lookup dnsdb{a=one.host.com:two.host.com}}
7568 .endd
7569 Thus, in the default case, as long as at least one of the DNS lookups
7570 yields some data, the lookup succeeds.
7571
7572 .cindex "DNSSEC" "dns lookup"
7573 Use of &(DNSSEC)& is controlled by a dnssec modifier.
7574 The possible keywords are
7575 &"dnssec_strict"&, &"dnssec_lax"&, and &"dnssec_never"&.
7576 With &"strict"& or &"lax"& DNSSEC information is requested
7577 with the lookup.
7578 With &"strict"& a response from the DNS resolver that
7579 is not labelled as authenticated data
7580 is treated as equivalent to a temporary DNS error.
7581 The default is &"lax"&.
7582
7583 See also the &$lookup_dnssec_authenticated$& variable.
7584
7585 .cindex timeout "dns lookup"
7586 .cindex "DNS" timeout
7587 Timeout for the dnsdb lookup can be controlled by a retrans modifier.
7588 The form is &"retrans_VAL"& where VAL is an Exim time specification
7589 (e.g. &"5s"&).
7590 The default value is set by the main configuration option &%dns_retrans%&.
7591
7592 Retries for the dnsdb lookup can be controlled by a retry modifier.
7593 The form if &"retry_VAL"& where VAL is an integer.
7594 The default count is set by the main configuration option &%dns_retry%&.
7595
7596 .cindex caching "of dns lookup"
7597 .cindex TTL "of dns lookup"
7598 .cindex DNS TTL
7599 Dnsdb lookup results are cached within a single process (and its children).
7600 The cache entry lifetime is limited to the smallest time-to-live (TTL)
7601 value of the set of returned DNS records.
7602
7603
7604 .section "Pseudo dnsdb record types" "SECID66"
7605 .cindex "MX record" "in &(dnsdb)& lookup"
7606 By default, both the preference value and the host name are returned for
7607 each MX record, separated by a space. If you want only host names, you can use
7608 the pseudo-type MXH:
7609 .code
7610 ${lookup dnsdb{mxh=a.b.example}}
7611 .endd
7612 In this case, the preference values are omitted, and just the host names are
7613 returned.
7614
7615 .cindex "name server for enclosing domain"
7616 Another pseudo-type is ZNS (for &"zone NS"&). It performs a lookup for NS
7617 records on the given domain, but if none are found, it removes the first
7618 component of the domain name, and tries again. This process continues until NS
7619 records are found or there are no more components left (or there is a DNS
7620 error). In other words, it may return the name servers for a top-level domain,
7621 but it never returns the root name servers. If there are no NS records for the
7622 top-level domain, the lookup fails. Consider these examples:
7623 .code
7624 ${lookup dnsdb{zns=xxx.quercite.com}}
7625 ${lookup dnsdb{zns=xxx.edu}}
7626 .endd
7627 Assuming that in each case there are no NS records for the full domain name,
7628 the first returns the name servers for &%quercite.com%&, and the second returns
7629 the name servers for &%edu%&.
7630
7631 You should be careful about how you use this lookup because, unless the
7632 top-level domain does not exist, the lookup always returns some host names. The
7633 sort of use to which this might be put is for seeing if the name servers for a
7634 given domain are on a blacklist. You can probably assume that the name servers
7635 for the high-level domains such as &%com%& or &%co.uk%& are not going to be on
7636 such a list.
7637
7638 .cindex "CSA" "in &(dnsdb)& lookup"
7639 A third pseudo-type is CSA (Client SMTP Authorization). This looks up SRV
7640 records according to the CSA rules, which are described in section
7641 &<<SECTverifyCSA>>&. Although &(dnsdb)& supports SRV lookups directly, this is
7642 not sufficient because of the extra parent domain search behaviour of CSA. The
7643 result of a successful lookup such as:
7644 .code
7645 ${lookup dnsdb {csa=$sender_helo_name}}
7646 .endd
7647 has two space-separated fields: an authorization code and a target host name.
7648 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
7649 authorization required but absent, or &"?"& for unknown.
7650
7651 .cindex "A+" "in &(dnsdb)& lookup"
7652 The pseudo-type A+ performs an AAAA
7653 and then an A lookup.  All results are returned; defer processing
7654 (see below) is handled separately for each lookup.  Example:
7655 .code
7656 ${lookup dnsdb {>; a+=$sender_helo_name}}
7657 .endd
7658
7659
7660 .section "Multiple dnsdb lookups" "SECID67"
7661 In the previous sections, &(dnsdb)& lookups for a single domain are described.
7662 However, you can specify a list of domains or IP addresses in a single
7663 &(dnsdb)& lookup. The list is specified in the normal Exim way, with colon as
7664 the default separator, but with the ability to change this. For example:
7665 .code
7666 ${lookup dnsdb{one.domain.com:two.domain.com}}
7667 ${lookup dnsdb{a=one.host.com:two.host.com}}
7668 ${lookup dnsdb{ptr = <; 1.2.3.4 ; 4.5.6.8}}
7669 .endd
7670 In order to retain backwards compatibility, there is one special case: if
7671 the lookup type is PTR and no change of separator is specified, Exim looks
7672 to see if the rest of the string is precisely one IPv6 address. In this
7673 case, it does not treat it as a list.
7674
7675 The data from each lookup is concatenated, with newline separators by default,
7676 in the same way that multiple DNS records for a single item are handled. A
7677 different separator can be specified, as described above.
7678
7679
7680
7681
7682 .section "More about LDAP" "SECTldap"
7683 .cindex "LDAP" "lookup, more about"
7684 .cindex "lookup" "LDAP"
7685 .cindex "Solaris" "LDAP"
7686 The original LDAP implementation came from the University of Michigan; this has
7687 become &"Open LDAP"&, and there are now two different releases. Another
7688 implementation comes from Netscape, and Solaris 7 and subsequent releases
7689 contain inbuilt LDAP support. Unfortunately, though these are all compatible at
7690 the lookup function level, their error handling is different. For this reason
7691 it is necessary to set a compile-time variable when building Exim with LDAP, to
7692 indicate which LDAP library is in use. One of the following should appear in
7693 your &_Local/Makefile_&:
7694 .code
7695 LDAP_LIB_TYPE=UMICHIGAN
7696 LDAP_LIB_TYPE=OPENLDAP1
7697 LDAP_LIB_TYPE=OPENLDAP2
7698 LDAP_LIB_TYPE=NETSCAPE
7699 LDAP_LIB_TYPE=SOLARIS
7700 .endd
7701 If LDAP_LIB_TYPE is not set, Exim assumes &`OPENLDAP1`&, which has the
7702 same interface as the University of Michigan version.
7703
7704 There are three LDAP lookup types in Exim. These behave slightly differently in
7705 the way they handle the results of a query:
7706
7707 .ilist
7708 &(ldap)& requires the result to contain just one entry; if there are more, it
7709 gives an error.
7710 .next
7711 &(ldapdn)& also requires the result to contain just one entry, but it is the
7712 Distinguished Name that is returned rather than any attribute values.
7713 .next
7714 &(ldapm)& permits the result to contain more than one entry; the attributes
7715 from all of them are returned.
7716 .endlist
7717
7718
7719 For &(ldap)& and &(ldapm)&, if a query finds only entries with no attributes,
7720 Exim behaves as if the entry did not exist, and the lookup fails. The format of
7721 the data returned by a successful lookup is described in the next section.
7722 First we explain how LDAP queries are coded.
7723
7724
7725 .section "Format of LDAP queries" "SECTforldaque"
7726 .cindex "LDAP" "query format"
7727 An LDAP query takes the form of a URL as defined in RFC 2255. For example, in
7728 the configuration of a &(redirect)& router one might have this setting:
7729 .code
7730 data = ${lookup ldap \
7731   {ldap:///cn=$local_part,o=University%20of%20Cambridge,\
7732   c=UK?mailbox?base?}}
7733 .endd
7734 .cindex "LDAP" "with TLS"
7735 The URL may begin with &`ldap`& or &`ldaps`& if your LDAP library supports
7736 secure (encrypted) LDAP connections. The second of these ensures that an
7737 encrypted TLS connection is used.
7738
7739 With sufficiently modern LDAP libraries, Exim supports forcing TLS over regular
7740 LDAP connections, rather than the SSL-on-connect &`ldaps`&.
7741 See the &%ldap_start_tls%& option.
7742
7743 Starting with Exim 4.83, the initialization of LDAP with TLS is more tightly
7744 controlled. Every part of the TLS configuration can be configured by settings in
7745 &_exim.conf_&. Depending on the version of the client libraries installed on
7746 your system, some of the initialization may have required setting options in
7747 &_/etc/ldap.conf_& or &_~/.ldaprc_& to get TLS working with self-signed
7748 certificates. This revealed a nuance where the current UID that exim was
7749 running as could affect which config files it read. With Exim 4.83, these
7750 methods become optional, only taking effect if not specifically set in
7751 &_exim.conf_&.
7752
7753
7754 .section "LDAP quoting" "SECID68"
7755 .cindex "LDAP" "quoting"
7756 Two levels of quoting are required in LDAP queries, the first for LDAP itself
7757 and the second because the LDAP query is represented as a URL. Furthermore,
7758 within an LDAP query, two different kinds of quoting are required. For this
7759 reason, there are two different LDAP-specific quoting operators.
7760
7761 The &%quote_ldap%& operator is designed for use on strings that are part of
7762 filter specifications. Conceptually, it first does the following conversions on
7763 the string:
7764 .code
7765 *   =>   \2A
7766 (   =>   \28
7767 )   =>   \29
7768 \   =>   \5C
7769 .endd
7770 in accordance with RFC 2254. The resulting string is then quoted according
7771 to the rules for URLs, that is, all non-alphanumeric characters except
7772 .code
7773 ! $ ' - . _ ( ) * +
7774 .endd
7775 are converted to their hex values, preceded by a percent sign. For example:
7776 .code
7777 ${quote_ldap: a(bc)*, a<yz>; }
7778 .endd
7779 yields
7780 .code
7781 %20a%5C28bc%5C29%5C2A%2C%20a%3Cyz%3E%3B%20
7782 .endd
7783 Removing the URL quoting, this is (with a leading and a trailing space):
7784 .code
7785 a\28bc\29\2A, a<yz>;
7786 .endd
7787 The &%quote_ldap_dn%& operator is designed for use on strings that are part of
7788 base DN specifications in queries. Conceptually, it first converts the string
7789 by inserting a backslash in front of any of the following characters:
7790 .code
7791 , + " \ < > ;
7792 .endd
7793 It also inserts a backslash before any leading spaces or # characters, and
7794 before any trailing spaces. (These rules are in RFC 2253.) The resulting string
7795 is then quoted according to the rules for URLs. For example:
7796 .code
7797 ${quote_ldap_dn: a(bc)*, a<yz>; }
7798 .endd
7799 yields
7800 .code
7801 %5C%20a(bc)*%5C%2C%20a%5C%3Cyz%5C%3E%5C%3B%5C%20
7802 .endd
7803 Removing the URL quoting, this is (with a trailing space):
7804 .code
7805 \ a(bc)*\, a\<yz\>\;\
7806 .endd
7807 There are some further comments about quoting in the section on LDAP
7808 authentication below.
7809
7810
7811 .section "LDAP connections" "SECID69"
7812 .cindex "LDAP" "connections"
7813 The connection to an LDAP server may either be over TCP/IP, or, when OpenLDAP
7814 is in use, via a Unix domain socket. The example given above does not specify
7815 an LDAP server. A server that is reached by TCP/IP can be specified in a query
7816 by starting it with
7817 .code
7818 ldap://<hostname>:<port>/...
7819 .endd
7820 If the port (and preceding colon) are omitted, the standard LDAP port (389) is
7821 used. When no server is specified in a query, a list of default servers is
7822 taken from the &%ldap_default_servers%& configuration option. This supplies a
7823 colon-separated list of servers which are tried in turn until one successfully
7824 handles a query, or there is a serious error. Successful handling either
7825 returns the requested data, or indicates that it does not exist. Serious errors
7826 are syntactical, or multiple values when only a single value is expected.
7827 Errors which cause the next server to be tried are connection failures, bind
7828 failures, and timeouts.
7829
7830 For each server name in the list, a port number can be given. The standard way
7831 of specifying a host and port is to use a colon separator (RFC 1738). Because
7832 &%ldap_default_servers%& is a colon-separated list, such colons have to be
7833 doubled. For example
7834 .code
7835 ldap_default_servers = ldap1.example.com::145:ldap2.example.com
7836 .endd
7837 If &%ldap_default_servers%& is unset, a URL with no server name is passed
7838 to the LDAP library with no server name, and the library's default (normally
7839 the local host) is used.
7840
7841 If you are using the OpenLDAP library, you can connect to an LDAP server using
7842 a Unix domain socket instead of a TCP/IP connection. This is specified by using
7843 &`ldapi`& instead of &`ldap`& in LDAP queries. What follows here applies only
7844 to OpenLDAP. If Exim is compiled with a different LDAP library, this feature is
7845 not available.
7846
7847 For this type of connection, instead of a host name for the server, a pathname
7848 for the socket is required, and the port number is not relevant. The pathname
7849 can be specified either as an item in &%ldap_default_servers%&, or inline in
7850 the query. In the former case, you can have settings such as
7851 .code
7852 ldap_default_servers = /tmp/ldap.sock : backup.ldap.your.domain
7853 .endd
7854 When the pathname is given in the query, you have to escape the slashes as
7855 &`%2F`& to fit in with the LDAP URL syntax. For example:
7856 .code
7857 ${lookup ldap {ldapi://%2Ftmp%2Fldap.sock/o=...
7858 .endd
7859 When Exim processes an LDAP lookup and finds that the &"hostname"& is really
7860 a pathname, it uses the Unix domain socket code, even if the query actually
7861 specifies &`ldap`& or &`ldaps`&. In particular, no encryption is used for a
7862 socket connection. This behaviour means that you can use a setting of
7863 &%ldap_default_servers%& such as in the example above with traditional &`ldap`&
7864 or &`ldaps`& queries, and it will work. First, Exim tries a connection via
7865 the Unix domain socket; if that fails, it tries a TCP/IP connection to the
7866 backup host.
7867
7868 If an explicit &`ldapi`& type is given in a query when a host name is
7869 specified, an error is diagnosed. However, if there are more items in
7870 &%ldap_default_servers%&, they are tried. In other words:
7871
7872 .ilist
7873 Using a pathname with &`ldap`& or &`ldaps`& forces the use of the Unix domain
7874 interface.
7875 .next
7876 Using &`ldapi`& with a host name causes an error.
7877 .endlist
7878
7879
7880 Using &`ldapi`& with no host or path in the query, and no setting of
7881 &%ldap_default_servers%&, does whatever the library does by default.
7882
7883
7884
7885 .section "LDAP authentication and control information" "SECID70"
7886 .cindex "LDAP" "authentication"
7887 The LDAP URL syntax provides no way of passing authentication and other control
7888 information to the server. To make this possible, the URL in an LDAP query may
7889 be preceded by any number of <&'name'&>=<&'value'&> settings, separated by
7890 spaces. If a value contains spaces it must be enclosed in double quotes, and
7891 when double quotes are used, backslash is interpreted in the usual way inside
7892 them. The following names are recognized:
7893 .display
7894 &`DEREFERENCE`&  set the dereferencing parameter
7895 &`NETTIME    `&  set a timeout for a network operation
7896 &`USER       `&  set the DN, for authenticating the LDAP bind
7897 &`PASS       `&  set the password, likewise
7898 &`REFERRALS  `&  set the referrals parameter
7899 &`SERVERS    `&  set alternate server list for this query only
7900 &`SIZE       `&  set the limit for the number of entries returned
7901 &`TIME       `&  set the maximum waiting time for a query
7902 .endd
7903 The value of the DEREFERENCE parameter must be one of the words &"never"&,
7904 &"searching"&, &"finding"&, or &"always"&. The value of the REFERRALS parameter
7905 must be &"follow"& (the default) or &"nofollow"&. The latter stops the LDAP
7906 library from trying to follow referrals issued by the LDAP server.
7907
7908 .cindex LDAP timeout
7909 .cindex timeout "LDAP lookup"
7910 The name CONNECT is an obsolete name for NETTIME, retained for
7911 backwards compatibility. This timeout (specified as a number of seconds) is
7912 enforced from the client end for operations that can be carried out over a
7913 network. Specifically, it applies to network connections and calls to the
7914 &'ldap_result()'& function. If the value is greater than zero, it is used if
7915 LDAP_OPT_NETWORK_TIMEOUT is defined in the LDAP headers (OpenLDAP), or
7916 if LDAP_X_OPT_CONNECT_TIMEOUT is defined in the LDAP headers (Netscape
7917 SDK 4.1). A value of zero forces an explicit setting of &"no timeout"& for
7918 Netscape SDK; for OpenLDAP no action is taken.
7919
7920 The TIME parameter (also a number of seconds) is passed to the server to
7921 set a server-side limit on the time taken to complete a search.
7922
7923 The SERVERS parameter allows you to specify an alternate list of ldap servers
7924 to use for an individual lookup.  The global &%ldap_default_servers%& option provides a
7925 default list of ldap servers, and a single lookup can specify a single ldap
7926 server to use.  But when you need to do a lookup with a list of servers that is
7927 different than the default list (maybe different order, maybe a completely
7928 different set of servers), the SERVERS parameter allows you to specify this
7929 alternate list (colon-separated).
7930
7931 Here is an example of an LDAP query in an Exim lookup that uses some of these
7932 values. This is a single line, folded to fit on the page:
7933 .code
7934 ${lookup ldap
7935   {user="cn=manager,o=University of Cambridge,c=UK" pass=secret
7936   ldap:///o=University%20of%20Cambridge,c=UK?sn?sub?(cn=foo)}
7937   {$value}fail}
7938 .endd
7939 The encoding of spaces as &`%20`& is a URL thing which should not be done for
7940 any of the auxiliary data. Exim configuration settings that include lookups
7941 which contain password information should be preceded by &"hide"& to prevent
7942 non-admin users from using the &%-bP%& option to see their values.
7943
7944 The auxiliary data items may be given in any order. The default is no
7945 connection timeout (the system timeout is used), no user or password, no limit
7946 on the number of entries returned, and no time limit on queries.
7947
7948 When a DN is quoted in the USER= setting for LDAP authentication, Exim
7949 removes any URL quoting that it may contain before passing it LDAP. Apparently
7950 some libraries do this for themselves, but some do not. Removing the URL
7951 quoting has two advantages:
7952
7953 .ilist
7954 It makes it possible to use the same &%quote_ldap_dn%& expansion for USER=
7955 DNs as with DNs inside actual queries.
7956 .next
7957 It permits spaces inside USER= DNs.
7958 .endlist
7959
7960 For example, a setting such as
7961 .code
7962 USER=cn=${quote_ldap_dn:$1}
7963 .endd
7964 should work even if &$1$& contains spaces.
7965
7966 Expanded data for the PASS= value should be quoted using the &%quote%&
7967 expansion operator, rather than the LDAP quote operators. The only reason this
7968 field needs quoting is to ensure that it conforms to the Exim syntax, which
7969 does not allow unquoted spaces. For example:
7970 .code
7971 PASS=${quote:$3}
7972 .endd
7973 The LDAP authentication mechanism can be used to check passwords as part of
7974 SMTP authentication. See the &%ldapauth%& expansion string condition in chapter
7975 &<<CHAPexpand>>&.
7976
7977
7978
7979 .section "Format of data returned by LDAP" "SECID71"
7980 .cindex "LDAP" "returned data formats"
7981 The &(ldapdn)& lookup type returns the Distinguished Name from a single entry
7982 as a sequence of values, for example
7983 .code
7984 cn=manager,o=University of Cambridge,c=UK
7985 .endd
7986 The &(ldap)& lookup type generates an error if more than one entry matches the
7987 search filter, whereas &(ldapm)& permits this case, and inserts a newline in
7988 the result between the data from different entries. It is possible for multiple
7989 values to be returned for both &(ldap)& and &(ldapm)&, but in the former case
7990 you know that whatever values are returned all came from a single entry in the
7991 directory.
7992
7993 In the common case where you specify a single attribute in your LDAP query, the
7994 result is not quoted, and does not contain the attribute name. If the attribute
7995 has multiple values, they are separated by commas. Any comma that is
7996 part of an attribute's value is doubled.
7997
7998 If you specify multiple attributes, the result contains space-separated, quoted
7999 strings, each preceded by the attribute name and an equals sign. Within the
8000 quotes, the quote character, backslash, and newline are escaped with
8001 backslashes, and commas are used to separate multiple values for the attribute.
8002 Any commas in attribute values are doubled
8003 (permitting treatment of the values as a comma-separated list).
8004 Apart from the escaping, the string within quotes takes the same form as the
8005 output when a single attribute is requested. Specifying no attributes is the
8006 same as specifying all of an entry's attributes.
8007
8008 Here are some examples of the output format. The first line of each pair is an
8009 LDAP query, and the second is the data that is returned. The attribute called
8010 &%attr1%& has two values, one of them with an embedded comma, whereas
8011 &%attr2%& has only one value. Both attributes are derived from &%attr%&
8012 (they have SUP &%attr%& in their schema definitions).
8013
8014 .code
8015 ldap:///o=base?attr1?sub?(uid=fred)
8016 value1.1,value1,,2
8017
8018 ldap:///o=base?attr2?sub?(uid=fred)
8019 value two
8020
8021 ldap:///o=base?attr?sub?(uid=fred)
8022 value1.1,value1,,2,value two
8023
8024 ldap:///o=base?attr1,attr2?sub?(uid=fred)
8025 attr1="value1.1,value1,,2" attr2="value two"
8026
8027 ldap:///o=base??sub?(uid=fred)
8028 objectClass="top" attr1="value1.1,value1,,2" attr2="value two"
8029 .endd
8030 You can
8031 make use of Exim's &%-be%& option to run expansion tests and thereby check the
8032 results of LDAP lookups.
8033 The &%extract%& operator in string expansions can be used to pick out
8034 individual fields from data that consists of &'key'&=&'value'& pairs.
8035 The &%listextract%& operator should be used to pick out individual values
8036 of attributes, even when only a single value is expected.
8037 The doubling of embedded commas allows you to use the returned data as a
8038 comma separated list (using the "<," syntax for changing the input list separator).
8039
8040
8041
8042
8043 .section "More about NIS+" "SECTnisplus"
8044 .cindex "NIS+ lookup type"
8045 .cindex "lookup" "NIS+"
8046 NIS+ queries consist of a NIS+ &'indexed name'& followed by an optional colon
8047 and field name. If this is given, the result of a successful query is the
8048 contents of the named field; otherwise the result consists of a concatenation
8049 of &'field-name=field-value'& pairs, separated by spaces. Empty values and
8050 values containing spaces are quoted. For example, the query
8051 .code
8052 [name=mg1456],passwd.org_dir
8053 .endd
8054 might return the string
8055 .code
8056 name=mg1456 passwd="" uid=999 gid=999 gcos="Martin Guerre"
8057 home=/home/mg1456 shell=/bin/bash shadow=""
8058 .endd
8059 (split over two lines here to fit on the page), whereas
8060 .code
8061 [name=mg1456],passwd.org_dir:gcos
8062 .endd
8063 would just return
8064 .code
8065 Martin Guerre
8066 .endd
8067 with no quotes. A NIS+ lookup fails if NIS+ returns more than one table entry
8068 for the given indexed key. The effect of the &%quote_nisplus%& expansion
8069 operator is to double any quote characters within the text.
8070
8071
8072
8073 .section "SQL lookups" "SECTsql"
8074 .cindex "SQL lookup types"
8075 .cindex "MySQL" "lookup type"
8076 .cindex "PostgreSQL lookup type"
8077 .cindex "lookup" "MySQL"
8078 .cindex "lookup" "PostgreSQL"
8079 .cindex "Oracle" "lookup type"
8080 .cindex "lookup" "Oracle"
8081 .cindex "InterBase lookup type"
8082 .cindex "lookup" "InterBase"
8083 .cindex "Redis lookup type"
8084 .cindex lookup Redis
8085 Exim can support lookups in InterBase, MySQL, Oracle, PostgreSQL, Redis,
8086 and SQLite
8087 databases. Queries for these databases contain SQL statements, so an example
8088 might be
8089 .code
8090 ${lookup mysql{select mailbox from users where id='userx'}\
8091   {$value}fail}
8092 .endd
8093 If the result of the query contains more than one field, the data for each
8094 field in the row is returned, preceded by its name, so the result of
8095 .code
8096 ${lookup pgsql{select home,name from users where id='userx'}\
8097   {$value}}
8098 .endd
8099 might be
8100 .code
8101 home=/home/userx name="Mister X"
8102 .endd
8103 Empty values and values containing spaces are double quoted, with embedded
8104 quotes escaped by a backslash. If the result of the query contains just one
8105 field, the value is passed back verbatim, without a field name, for example:
8106 .code
8107 Mister X
8108 .endd
8109 If the result of the query yields more than one row, it is all concatenated,
8110 with a newline between the data for each row.
8111
8112
8113 .section "More about MySQL, PostgreSQL, Oracle, InterBase, and Redis" "SECID72"
8114 .cindex "MySQL" "lookup type"
8115 .cindex "PostgreSQL lookup type"
8116 .cindex "lookup" "MySQL"
8117 .cindex "lookup" "PostgreSQL"
8118 .cindex "Oracle" "lookup type"
8119 .cindex "lookup" "Oracle"
8120 .cindex "InterBase lookup type"
8121 .cindex "lookup" "InterBase"
8122 .cindex "Redis lookup type"
8123 .cindex lookup Redis
8124 If any MySQL, PostgreSQL, Oracle, InterBase or Redis lookups are used, the
8125 &%mysql_servers%&, &%pgsql_servers%&, &%oracle_servers%&, &%ibase_servers%&,
8126 or &%redis_servers%&
8127 option (as appropriate) must be set to a colon-separated list of server
8128 information.
8129 .oindex &%mysql_servers%&
8130 .oindex &%pgsql_servers%&
8131 .oindex &%oracle_servers%&
8132 .oindex &%ibase_servers%&
8133 .oindex &%redis_servers%&
8134 (For MySQL and PostgreSQL, the global option need not be set if all
8135 queries contain their own server information &-- see section
8136 &<<SECTspeserque>>&.)
8137 For all but Redis
8138 each item in the list is a slash-separated list of four
8139 items: host name, database name, user name, and password. In the case of
8140 Oracle, the host name field is used for the &"service name"&, and the database
8141 name field is not used and should be empty. For example:
8142 .code
8143 hide oracle_servers = oracle.plc.example//userx/abcdwxyz
8144 .endd
8145 Because password data is sensitive, you should always precede the setting with
8146 &"hide"&, to prevent non-admin users from obtaining the setting via the &%-bP%&
8147 option. Here is an example where two MySQL servers are listed:
8148 .code
8149 hide mysql_servers = localhost/users/root/secret:\
8150                      otherhost/users/root/othersecret
8151 .endd
8152 For MySQL and PostgreSQL, a host may be specified as <&'name'&>:<&'port'&> but
8153 because this is a colon-separated list, the colon has to be doubled. For each
8154 query, these parameter groups are tried in order until a connection is made and
8155 a query is successfully processed. The result of a query may be that no data is
8156 found, but that is still a successful query. In other words, the list of
8157 servers provides a backup facility, not a list of different places to look.
8158
8159 For Redis the global option need not be specified if all queries contain their
8160 own server information &-- see section &<<SECTspeserque>>&.
8161 If specified, the option must be set to a colon-separated list of server
8162 information.
8163 Each item in the list is a slash-separated list of three items:
8164 host, database number, and password.
8165 .olist
8166 The host is required and may be either an IPv4 address and optional
8167 port number (separated by a colon, which needs doubling due to the
8168 higher-level list), or a Unix socket pathname enclosed in parentheses
8169 .next
8170 The database number is optional; if present that number is selected in the backend
8171 .next
8172 The password is optional; if present it is used to authenticate to the backend
8173 .endlist
8174
8175 The &%quote_mysql%&, &%quote_pgsql%&, and &%quote_oracle%& expansion operators
8176 convert newline, tab, carriage return, and backspace to \n, \t, \r, and \b
8177 respectively, and the characters single-quote, double-quote, and backslash
8178 itself are escaped with backslashes.
8179
8180 The &%quote_redis%& expansion operator
8181 escapes whitespace and backslash characters with a backslash.
8182
8183 .section "Specifying the server in the query" "SECTspeserque"
8184 For MySQL, PostgreSQL and Redis lookups (but not currently for Oracle and InterBase),
8185 it is possible to specify a list of servers with an individual query. This is
8186 done by appending a comma-separated option to the query type:
8187 .display
8188 &`,servers=`&&'server1:server2:server3:...'&
8189 .endd
8190 Each item in the list may take one of two forms:
8191 .olist
8192 If it contains no slashes it is assumed to be just a host name. The appropriate
8193 global option (&%mysql_servers%& or &%pgsql_servers%&) is searched for a host
8194 of the same name, and the remaining parameters (database, user, password) are
8195 taken from there.
8196 .next
8197 If it contains any slashes, it is taken as a complete parameter set.
8198 .endlist
8199 The list of servers is used in exactly the same way as the global list.
8200 Once a connection to a server has happened and a query has been
8201 successfully executed, processing of the lookup ceases.
8202
8203 This feature is intended for use in master/slave situations where updates
8204 are occurring and you want to update the master rather than a slave. If the
8205 master is in the list as a backup for reading, you might have a global setting
8206 like this:
8207 .code
8208 mysql_servers = slave1/db/name/pw:\
8209                 slave2/db/name/pw:\
8210                 master/db/name/pw
8211 .endd
8212 In an updating lookup, you could then write:
8213 .code
8214 ${lookup mysql,servers=master {UPDATE ...} }
8215 .endd
8216 That query would then be sent only to the master server. If, on the other hand,
8217 the master is not to be used for reading, and so is not present in the global
8218 option, you can still update it by a query of this form:
8219 .code
8220 ${lookup pgsql,servers=master/db/name/pw {UPDATE ...} }
8221 .endd
8222
8223 An older syntax places the servers specification before the query,
8224 semicolon separated:
8225 .code
8226 ${lookup mysql{servers=master; UPDATE ...} }
8227 .endd
8228 The new version avoids potential issues with tainted
8229 arguments in the query, for explicit expansion.
8230 &*Note*&: server specifications in list-style lookups are still problematic.
8231
8232
8233 .section "Special MySQL features" "SECID73"
8234 For MySQL, an empty host name or the use of &"localhost"& in &%mysql_servers%&
8235 causes a connection to the server on the local host by means of a Unix domain
8236 socket. An alternate socket can be specified in parentheses.
8237 An option group name for MySQL option files can be specified in square brackets;
8238 the default value is &"exim"&.
8239 The full syntax of each item in &%mysql_servers%& is:
8240 .display
8241 <&'hostname'&>::<&'port'&>(<&'socket name'&>)[<&'option group'&>]/&&&
8242   <&'database'&>/<&'user'&>/<&'password'&>
8243 .endd
8244 Any of the four sub-parts of the first field can be omitted. For normal use on
8245 the local host it can be left blank or set to just &"localhost"&.
8246
8247 No database need be supplied &-- but if it is absent here, it must be given in
8248 the queries.
8249
8250 If a MySQL query is issued that does not request any data (an insert, update,
8251 or delete command), the result of the lookup is the number of rows affected.
8252
8253 &*Warning*&: This can be misleading. If an update does not actually change
8254 anything (for example, setting a field to the value it already has), the result
8255 is zero because no rows are affected.
8256
8257
8258 .section "Special PostgreSQL features" "SECID74"
8259 PostgreSQL lookups can also use Unix domain socket connections to the database.
8260 This is usually faster and costs less CPU time than a TCP/IP connection.
8261 However it can be used only if the mail server runs on the same machine as the
8262 database server. A configuration line for PostgreSQL via Unix domain sockets
8263 looks like this:
8264 .code
8265 hide pgsql_servers = (/tmp/.s.PGSQL.5432)/db/user/password : ...
8266 .endd
8267 In other words, instead of supplying a host name, a path to the socket is
8268 given. The path name is enclosed in parentheses so that its slashes aren't
8269 visually confused with the delimiters for the other server parameters.
8270
8271 If a PostgreSQL query is issued that does not request any data (an insert,
8272 update, or delete command), the result of the lookup is the number of rows
8273 affected.
8274
8275 .section "More about SQLite" "SECTsqlite"
8276 .cindex "lookup" "SQLite"
8277 .cindex "sqlite lookup type"
8278 SQLite is different to the other SQL lookups because a filename is required in
8279 addition to the SQL query. An SQLite database is a single file, and there is no
8280 daemon as in the other SQL databases.
8281
8282 .new
8283 .oindex &%sqlite_dbfile%&
8284 There are two ways of
8285 specifying the file.
8286 The first is is by using the &%sqlite_dbfile%& main option.
8287 The second, which allows separate files for each query,
8288 is to use an option appended, comma-separated, to the &"sqlite"&
8289 lookup type word.  The option is the word &"file"&, then an equals,
8290 then the filename.
8291 The filename in this case cannot contain whitespace or open-brace charachters.
8292 .wen
8293
8294 A deprecated method is available, prefixing the query with the filename
8295 separated by white space.
8296 This means that
8297 .cindex "tainted data" "sqlite file"
8298 the query cannot use any tainted values, as that taints
8299 the entire query including the filename - resulting in a refusal to open
8300 the file.
8301
8302 In all the above cases the filename must be an absolute path.
8303
8304 Here is a lookup expansion example:
8305 .code
8306 sqlite_dbfile = /some/thing/sqlitedb
8307 ...
8308 ${lookup sqlite {select name from aliases where id='userx';}}
8309 .endd
8310 In a list, the syntax is similar. For example:
8311 .code
8312 domainlist relay_to_domains = sqlite;\
8313    select * from relays where ip='$sender_host_address';
8314 .endd
8315 The only character affected by the &%quote_sqlite%& operator is a single
8316 quote, which it doubles.
8317
8318 .cindex timeout SQLite
8319 .cindex sqlite "lookup timeout"
8320 The SQLite library handles multiple simultaneous accesses to the database
8321 internally. Multiple readers are permitted, but only one process can
8322 update at once. Attempts to access the database while it is being updated
8323 are rejected after a timeout period, during which the SQLite library
8324 waits for the lock to be released. In Exim, the default timeout is set
8325 to 5 seconds, but it can be changed by means of the &%sqlite_lock_timeout%&
8326 option.
8327
8328 .section "More about Redis" "SECTredis"
8329 .cindex "lookup" "Redis"
8330 .cindex "redis lookup type"
8331 Redis is a non-SQL database. Commands are simple get and set.
8332 Examples:
8333 .code
8334 ${lookup redis{set keyname ${quote_redis:objvalue plus}}}
8335 ${lookup redis{get keyname}}
8336 .endd
8337
8338 As of release 4.91, "lightweight" support for Redis Cluster is available.
8339 Requires &%redis_servers%& list to contain all the servers in the cluster, all
8340 of which must be reachable from the running exim instance. If the cluster has
8341 master/slave replication, the list must contain all the master and slave
8342 servers.
8343
8344 When the Redis Cluster returns a "MOVED" response to a query, Exim does not
8345 immediately follow the redirection but treats the response as a DEFER, moving on
8346 to the next server in the &%redis_servers%& list until the correct server is
8347 reached.
8348
8349 .ecindex IIDfidalo1
8350 .ecindex IIDfidalo2
8351
8352
8353 . ////////////////////////////////////////////////////////////////////////////
8354 . ////////////////////////////////////////////////////////////////////////////
8355
8356 .chapter "Domain, host, address, and local part lists" &&&
8357          "CHAPdomhosaddlists" &&&
8358          "Domain, host, and address lists"
8359 .scindex IIDdohoadli "lists of domains; hosts; etc."
8360 A number of Exim configuration options contain lists of domains, hosts,
8361 email addresses, or local parts. For example, the &%hold_domains%& option
8362 contains a list of domains whose delivery is currently suspended. These lists
8363 are also used as data in ACL statements (see chapter &<<CHAPACL>>&), and as
8364 arguments to expansion conditions such as &%match_domain%&.
8365
8366 Each item in one of these lists is a pattern to be matched against a domain,
8367 host, email address, or local part, respectively. In the sections below, the
8368 different types of pattern for each case are described, but first we cover some
8369 general facilities that apply to all four kinds of list.
8370
8371 Note that other parts of Exim use a &'string list'& which does not
8372 support all the complexity available in
8373 domain, host, address and local part lists.
8374
8375
8376
8377 .section "Expansion of lists" "SECTlistexpand"
8378 .cindex "expansion" "of lists"
8379 Each list is expanded as a single string before it is used.
8380
8381 &'Exception: the router headers_remove option, where list-item
8382 splitting is done before string-expansion.'&
8383
8384 The result of
8385 expansion must be a list, possibly containing empty items, which is split up
8386 into separate items for matching. By default, colon is the separator character,
8387 but this can be varied if necessary. See sections &<<SECTlistconstruct>>& and
8388 &<<SECTempitelis>>& for details of the list syntax; the second of these
8389 discusses the way to specify empty list items.
8390
8391
8392 If the string expansion is forced to fail, Exim behaves as if the item it is
8393 testing (domain, host, address, or local part) is not in the list. Other
8394 expansion failures cause temporary errors.
8395
8396 If an item in a list is a regular expression, backslashes, dollars and possibly
8397 other special characters in the expression must be protected against
8398 misinterpretation by the string expander. The easiest way to do this is to use
8399 the &`\N`& expansion feature to indicate that the contents of the regular
8400 expression should not be expanded. For example, in an ACL you might have:
8401 .code
8402 deny senders = \N^\d{8}\w@.*\.baddomain\.example$\N : \
8403                ${lookup{$domain}lsearch{/badsenders/bydomain}}
8404 .endd
8405 The first item is a regular expression that is protected from expansion by
8406 &`\N`&, whereas the second uses the expansion to obtain a list of unwanted
8407 senders based on the receiving domain.
8408
8409
8410
8411
8412 .section "Negated items in lists" "SECID76"
8413 .cindex "list" "negation"
8414 .cindex "negation" "in lists"
8415 Items in a list may be positive or negative. Negative items are indicated by a
8416 leading exclamation mark, which may be followed by optional white space. A list
8417 defines a set of items (domains, etc). When Exim processes one of these lists,
8418 it is trying to find out whether a domain, host, address, or local part
8419 (respectively) is in the set that is defined by the list. It works like this:
8420
8421 The list is scanned from left to right. If a positive item is matched, the
8422 subject that is being checked is in the set; if a negative item is matched, the
8423 subject is not in the set. If the end of the list is reached without the
8424 subject having matched any of the patterns, it is in the set if the last item
8425 was a negative one, but not if it was a positive one. For example, the list in
8426 .code
8427 domainlist relay_to_domains = !a.b.c : *.b.c
8428 .endd
8429 matches any domain ending in &'.b.c'& except for &'a.b.c'&. Domains that match
8430 neither &'a.b.c'& nor &'*.b.c'& do not match, because the last item in the
8431 list is positive. However, if the setting were
8432 .code
8433 domainlist relay_to_domains = !a.b.c
8434 .endd
8435 then all domains other than &'a.b.c'& would match because the last item in the
8436 list is negative. In other words, a list that ends with a negative item behaves
8437 as if it had an extra item &`:*`& on the end.
8438
8439 Another way of thinking about positive and negative items in lists is to read
8440 the connector as &"or"& after a positive item and as &"and"& after a negative
8441 item.
8442
8443
8444
8445 .section "File names in lists" "SECTfilnamlis"
8446 .cindex "list" "filename in"
8447 If an item in a domain, host, address, or local part list is an absolute
8448 filename (beginning with a slash character), each line of the file is read and
8449 processed as if it were an independent item in the list, except that further
8450 filenames are not allowed,
8451 and no expansion of the data from the file takes place.
8452 Empty lines in the file are ignored, and the file may also contain comment
8453 lines:
8454
8455 .ilist
8456 For domain and host lists, if a # character appears anywhere in a line of the
8457 file, it and all following characters are ignored.
8458 .next
8459 Because local parts may legitimately contain # characters, a comment in an
8460 address list or local part list file is recognized only if # is preceded by
8461 white space or the start of the line. For example:
8462 .code
8463 not#comment@x.y.z   # but this is a comment
8464 .endd
8465 .endlist
8466
8467 Putting a filename in a list has the same effect as inserting each line of the
8468 file as an item in the list (blank lines and comments excepted). However, there
8469 is one important difference: the file is read each time the list is processed,
8470 so if its contents vary over time, Exim's behaviour changes.
8471
8472 If a filename is preceded by an exclamation mark, the sense of any match
8473 within the file is inverted. For example, if
8474 .code
8475 hold_domains = !/etc/nohold-domains
8476 .endd
8477 and the file contains the lines
8478 .code
8479 !a.b.c
8480 *.b.c
8481 .endd
8482 then &'a.b.c'& is in the set of domains defined by &%hold_domains%&, whereas
8483 any domain matching &`*.b.c`& is not.
8484
8485
8486
8487 .section "An lsearch file is not an out-of-line list" "SECID77"
8488 As will be described in the sections that follow, lookups can be used in lists
8489 to provide indexed methods of checking list membership. There has been some
8490 confusion about the way &(lsearch)& lookups work in lists. Because
8491 an &(lsearch)& file contains plain text and is scanned sequentially, it is
8492 sometimes thought that it is allowed to contain wild cards and other kinds of
8493 non-constant pattern. This is not the case. The keys in an &(lsearch)& file are
8494 always fixed strings, just as for any other single-key lookup type.
8495
8496 If you want to use a file to contain wild-card patterns that form part of a
8497 list, just give the filename on its own, without a search type, as described
8498 in the previous section. You could also use the &(wildlsearch)& or
8499 &(nwildlsearch)&, but there is no advantage in doing this.
8500
8501
8502
8503
8504 .section "Results of list checking" SECTlistresults
8505 The primary result of doing a list check is a truth value.
8506 In some contexts additional information is stored
8507 about the list element that matched:
8508 .vlist
8509 .vitem hosts
8510 A &%hosts%& ACL condition
8511 will store a result in the &$host_data$& variable.
8512 .vitem local_parts
8513 A &%local_parts%& router option or &%local_parts%& ACL condition
8514 will store a result in the &$local_part_data$& variable.
8515 .vitem domains
8516 .new
8517 A &%domains%& router option or &%domains%& ACL condition
8518 will store a result in the &$domain_data$& variable.
8519 .wen
8520 .vitem senders
8521 A &%senders%& router option or &%senders%& ACL condition
8522 will store a result in the &$sender_data$& variable.
8523 .vitem recipients
8524 A &%recipients%& ACL condition
8525 will store a result in the &$recipient_data$& variable.
8526 .endlist
8527
8528 The detail of the additional information depends on the
8529 type of match and is given below as the &*value*& information.
8530
8531
8532
8533
8534 .section "Named lists" "SECTnamedlists"
8535 .cindex "named lists"
8536 .cindex "list" "named"
8537 A list of domains, hosts, email addresses, or local parts can be given a name
8538 which is then used to refer to the list elsewhere in the configuration. This is
8539 particularly convenient if the same list is required in several different
8540 places. It also allows lists to be given meaningful names, which can improve
8541 the readability of the configuration. For example, it is conventional to define
8542 a domain list called &'local_domains'& for all the domains that are handled
8543 locally on a host, using a configuration line such as
8544 .code
8545 domainlist local_domains = localhost:my.dom.example
8546 .endd
8547 Named lists are referenced by giving their name preceded by a plus sign, so,
8548 for example, a router that is intended to handle local domains would be
8549 configured with the line
8550 .code
8551 domains = +local_domains
8552 .endd
8553 The first router in a configuration is often one that handles all domains
8554 except the local ones, using a configuration with a negated item like this:
8555 .code
8556 dnslookup:
8557   driver = dnslookup
8558   domains = ! +local_domains
8559   transport = remote_smtp
8560   no_more
8561 .endd
8562 The four kinds of named list are created by configuration lines starting with
8563 the words &%domainlist%&, &%hostlist%&, &%addresslist%&, or &%localpartlist%&,
8564 respectively. Then there follows the name that you are defining, followed by an
8565 equals sign and the list itself. For example:
8566 .code
8567 hostlist    relay_from_hosts = 192.168.23.0/24 : my.friend.example
8568 addresslist bad_senders = cdb;/etc/badsenders
8569 .endd
8570 A named list may refer to other named lists:
8571 .code
8572 domainlist  dom1 = first.example : second.example
8573 domainlist  dom2 = +dom1 : third.example
8574 domainlist  dom3 = fourth.example : +dom2 : fifth.example
8575 .endd
8576 &*Warning*&: If the last item in a referenced list is a negative one, the
8577 effect may not be what you intended, because the negation does not propagate
8578 out to the higher level. For example, consider:
8579 .code
8580 domainlist  dom1 = !a.b
8581 domainlist  dom2 = +dom1 : *.b
8582 .endd
8583 The second list specifies &"either in the &%dom1%& list or &'*.b'&"&. The first
8584 list specifies just &"not &'a.b'&"&, so the domain &'x.y'& matches it. That
8585 means it matches the second list as well. The effect is not the same as
8586 .code
8587 domainlist  dom2 = !a.b : *.b
8588 .endd
8589 where &'x.y'& does not match. It's best to avoid negation altogether in
8590 referenced lists if you can.
8591
8592 .cindex "hiding named list values"
8593 .cindex "named lists" "hiding value of"
8594 Some named list definitions may contain sensitive data, for example, passwords for
8595 accessing databases. To stop non-admin users from using the &%-bP%& command
8596 line option to read these values, you can precede the definition with the
8597 word &"hide"&. For example:
8598 .code
8599 hide domainlist filter_for_domains = ldap;PASS=secret ldap::/// ...
8600 .endd
8601
8602
8603 Named lists may have a performance advantage. When Exim is routing an
8604 address or checking an incoming message, it caches the result of tests on named
8605 lists. So, if you have a setting such as
8606 .code
8607 domains = +local_domains
8608 .endd
8609 on several of your routers
8610 or in several ACL statements,
8611 the actual test is done only for the first one. However, the caching works only
8612 if there are no expansions within the list itself or any sublists that it
8613 references. In other words, caching happens only for lists that are known to be
8614 the same each time they are referenced.
8615
8616 By default, there may be up to 16 named lists of each type. This limit can be
8617 extended by changing a compile-time variable. The use of domain and host lists
8618 is recommended for concepts such as local domains, relay domains, and relay
8619 hosts. The default configuration is set up like this.
8620
8621
8622
8623 .section "Named lists compared with macros" "SECID78"
8624 .cindex "list" "named compared with macro"
8625 .cindex "macro" "compared with named list"
8626 At first sight, named lists might seem to be no different from macros in the
8627 configuration file. However, macros are just textual substitutions. If you
8628 write
8629 .code
8630 ALIST = host1 : host2
8631 auth_advertise_hosts = !ALIST
8632 .endd
8633 it probably won't do what you want, because that is exactly the same as
8634 .code
8635 auth_advertise_hosts = !host1 : host2
8636 .endd
8637 Notice that the second host name is not negated. However, if you use a host
8638 list, and write
8639 .code
8640 hostlist alist = host1 : host2
8641 auth_advertise_hosts = ! +alist
8642 .endd
8643 the negation applies to the whole list, and so that is equivalent to
8644 .code
8645 auth_advertise_hosts = !host1 : !host2
8646 .endd
8647
8648
8649 .section "Named list caching" "SECID79"
8650 .cindex "list" "caching of named"
8651 .cindex "caching" "named lists"
8652 While processing a message, Exim caches the result of checking a named list if
8653 it is sure that the list is the same each time. In practice, this means that
8654 the cache operates only if the list contains no $ characters, which guarantees
8655 that it will not change when it is expanded. Sometimes, however, you may have
8656 an expanded list that you know will be the same each time within a given
8657 message. For example:
8658 .code
8659 domainlist special_domains = \
8660            ${lookup{$sender_host_address}cdb{/some/file}}
8661 .endd
8662 This provides a list of domains that depends only on the sending host's IP
8663 address. If this domain list is referenced a number of times (for example,
8664 in several ACL lines, or in several routers) the result of the check is not
8665 cached by default, because Exim does not know that it is going to be the
8666 same list each time.
8667
8668 By appending &`_cache`& to &`domainlist`& you can tell Exim to go ahead and
8669 cache the result anyway. For example:
8670 .code
8671 domainlist_cache special_domains = ${lookup{...
8672 .endd
8673 If you do this, you should be absolutely sure that caching is going to do
8674 the right thing in all cases. When in doubt, leave it out.
8675
8676
8677
8678 .section "Domain lists" "SECTdomainlist"
8679 .cindex "domain list" "patterns for"
8680 .cindex "list" "domain list"
8681 Domain lists contain patterns that are to be matched against a mail domain.
8682 The following types of item may appear in domain lists:
8683
8684 .ilist
8685 .cindex "primary host name"
8686 .cindex "host name" "matched in domain list"
8687 .oindex "&%primary_hostname%&"
8688 .cindex "domain list" "matching primary host name"
8689 .cindex "@ in a domain list"
8690 If a pattern consists of a single @ character, it matches the local host name,
8691 as set by the &%primary_hostname%& option (or defaulted). This makes it
8692 possible to use the same configuration file on several different hosts that
8693 differ only in their names.
8694
8695 The value for a match will be the primary host name.
8696
8697
8698 .next
8699 .cindex "@[] in a domain list"
8700 .cindex "domain list" "matching local IP interfaces"
8701 .cindex "domain literal"
8702 If a pattern consists of the string &`@[]`& it matches an IP address enclosed
8703 in square brackets (as in an email address that contains a domain literal), but
8704 only if that IP address is recognized as local for email routing purposes. The
8705 &%local_interfaces%& and &%extra_local_interfaces%& options can be used to
8706 control which of a host's several IP addresses are treated as local.
8707 In today's Internet, the use of domain literals is controversial;
8708 see the &%allow_domain_literals%& main option.
8709
8710 The value for a match will be the string &`@[]`&.
8711
8712
8713 .next
8714 .cindex "@mx_any"
8715 .cindex "@mx_primary"
8716 .cindex "@mx_secondary"
8717 .cindex "domain list" "matching MX pointers to local host"
8718 If a pattern consists of the string &`@mx_any`& it matches any domain that
8719 has an MX record pointing to the local host or to any host that is listed in
8720 .oindex "&%hosts_treat_as_local%&"
8721 &%hosts_treat_as_local%&. The items &`@mx_primary`& and &`@mx_secondary`&
8722 are similar, except that the first matches only when a primary MX target is the
8723 local host, and the second only when no primary MX target is the local host,
8724 but a secondary MX target is. &"Primary"& means an MX record with the lowest
8725 preference value &-- there may of course be more than one of them.
8726
8727 The MX lookup that takes place when matching a pattern of this type is
8728 performed with the resolver options for widening names turned off. Thus, for
8729 example, a single-component domain will &'not'& be expanded by adding the
8730 resolver's default domain. See the &%qualify_single%& and &%search_parents%&
8731 options of the &(dnslookup)& router for a discussion of domain widening.
8732
8733 Sometimes you may want to ignore certain IP addresses when using one of these
8734 patterns. You can specify this by following the pattern with &`/ignore=`&<&'ip
8735 list'&>, where <&'ip list'&> is a list of IP addresses. These addresses are
8736 ignored when processing the pattern (compare the &%ignore_target_hosts%& option
8737 on a router). For example:
8738 .code
8739 domains = @mx_any/ignore=127.0.0.1
8740 .endd
8741 This example matches any domain that has an MX record pointing to one of
8742 the local host's IP addresses other than 127.0.0.1.
8743
8744 The list of IP addresses is in fact processed by the same code that processes
8745 host lists, so it may contain CIDR-coded network specifications and it may also
8746 contain negative items.
8747
8748 Because the list of IP addresses is a sublist within a domain list, you have to
8749 be careful about delimiters if there is more than one address. Like any other
8750 list, the default delimiter can be changed. Thus, you might have:
8751 .code
8752 domains = @mx_any/ignore=<;127.0.0.1;0.0.0.0 : \
8753           an.other.domain : ...
8754 .endd
8755 so that the sublist uses semicolons for delimiters. When IPv6 addresses are
8756 involved, it is easiest to change the delimiter for the main list as well:
8757 .code
8758 domains = <? @mx_any/ignore=<;127.0.0.1;::1 ? \
8759           an.other.domain ? ...
8760 .endd
8761 The value for a match will be the list element string (starting &`@mx_`&).
8762
8763
8764 .next
8765 .cindex "asterisk" "in domain list"
8766 .cindex "domain list" "asterisk in"
8767 .cindex "domain list" "matching &""ends with""&"
8768 If a pattern starts with an asterisk, the remaining characters of the pattern
8769 are compared with the terminating characters of the domain. The use of &"*"& in
8770 domain lists differs from its use in partial matching lookups. In a domain
8771 list, the character following the asterisk need not be a dot, whereas partial
8772 matching works only in terms of dot-separated components. For example, a domain
8773 list item such as &`*key.ex`& matches &'donkey.ex'& as well as
8774 &'cipher.key.ex'&.
8775
8776 The value for a match will be the list element string (starting with the asterisk).
8777 Additionally, &$0$& will be set to the matched string
8778 and &$1$& to the variable portion which the asterisk matched.
8779
8780 .next
8781 .cindex "regular expressions" "in domain list"
8782 .cindex "domain list" "matching regular expression"
8783 If a pattern starts with a circumflex character, it is treated as a regular
8784 expression, and matched against the domain using a regular expression matching
8785 function. The circumflex is treated as part of the regular expression.
8786 Email domains are case-independent, so this regular expression match is by
8787 default case-independent, but you can make it case-dependent by starting it
8788 with &`(?-i)`&. References to descriptions of the syntax of regular expressions
8789 are given in chapter &<<CHAPregexp>>&.
8790
8791 &*Warning*&: Because domain lists are expanded before being processed, you
8792 must escape any backslash and dollar characters in the regular expression, or
8793 use the special &`\N`& sequence (see chapter &<<CHAPexpand>>&) to specify that
8794 it is not to be expanded (unless you really do want to build a regular
8795 expression by expansion, of course).
8796
8797 The value for a match will be the list element string (starting with the circumflex).
8798 Additionally, &$0$& will be set to the string matching the regular expression,
8799 and &$1$& (onwards) to any submatches identified by parentheses.
8800
8801
8802
8803 .next
8804 .cindex "lookup" "in domain list"
8805 .cindex "domain list" "matching by lookup"
8806 If a pattern starts with the name of a single-key lookup type followed by a
8807 semicolon (for example, &"dbm;"& or &"lsearch;"&), the remainder of the pattern
8808 must be a filename in a suitable format for the lookup type. For example, for
8809 &"cdb;"& it must be an absolute path:
8810 .code
8811 domains = cdb;/etc/mail/local_domains.cdb
8812 .endd
8813 The appropriate type of lookup is done on the file using the domain name as the
8814 key. In most cases, the value resulting from the lookup is not used; Exim is interested
8815 only in whether or not the key is present in the file. However, when a lookup
8816 is used for the &%domains%& option on a router
8817 or a &%domains%& condition in an ACL statement, the value is preserved in the
8818 &$domain_data$& variable and can be referred to in other router options or
8819 other statements in the same ACL.
8820 .cindex "tainted data" "de-tainting"
8821 The value will be untainted.
8822
8823 .new
8824 &*Note*&: If the data result of the lookup (as opposed to the key)
8825 is empty, then this empty value is stored in &$domain_data$&.
8826 The option to return the key for the lookup, as the value,
8827 may be what is wanted.
8828 .wen
8829
8830
8831 .next
8832 Any of the single-key lookup type names may be preceded by
8833 &`partial`&<&'n'&>&`-`&, where the <&'n'&> is optional, for example,
8834 .code
8835 domains = partial-dbm;/partial/domains
8836 .endd
8837 This causes partial matching logic to be invoked; a description of how this
8838 works is given in section &<<SECTpartiallookup>>&.
8839
8840 .next
8841 .cindex "asterisk" "in lookup type"
8842 Any of the single-key lookup types may be followed by an asterisk. This causes
8843 a default lookup for a key consisting of a single asterisk to be done if the
8844 original lookup fails. This is not a useful feature when using a domain list to
8845 select particular domains (because any domain would match), but it might have
8846 value if the result of the lookup is being used via the &$domain_data$&
8847 expansion variable.
8848
8849 .next
8850 If the pattern starts with the name of a query-style lookup type followed by a
8851 semicolon (for example, &"nisplus;"& or &"ldap;"&), the remainder of the
8852 pattern must be an appropriate query for the lookup type, as described in
8853 chapter &<<CHAPfdlookup>>&. For example:
8854 .code
8855 hold_domains = mysql;select domain from holdlist \
8856   where domain = '${quote_mysql:$domain}';
8857 .endd
8858 In most cases, the value resulting from the lookup is not used (so for an SQL query, for
8859 example, it doesn't matter what field you select). Exim is interested only in
8860 whether or not the query succeeds. However, when a lookup is used for the
8861 &%domains%& option on a router, the value is preserved in the &$domain_data$&
8862 variable and can be referred to in other options.
8863 .cindex "tainted data" "de-tainting"
8864 The value will be untainted.
8865
8866 .next
8867 If the pattern starts with the name of a lookup type
8868 of either kind (single-key or query-style) it may be
8869 followed by a comma and options,
8870 The options are lookup-type specific and consist of a comma-separated list.
8871 Each item starts with a tag and and equals "=" sign.
8872
8873 .next
8874 .cindex "domain list" "matching literal domain name"
8875 If none of the above cases apply, a caseless textual comparison is made
8876 between the pattern and the domain.
8877
8878 The value for a match will be the list element string.
8879 .cindex "tainted data" "de-tainting"
8880 Note that this is commonly untainted
8881 (depending on the way the list was created).
8882 Specifically, explicit text in the configuration file in not tainted.
8883 This is a useful way of obtaining an untainted equivalent to
8884 the domain, for later operations.
8885
8886 However if the list (including one-element lists)
8887 is created by expanding a variable containing tainted data,
8888 it is tainted and so will the match value be.
8889 .endlist
8890
8891
8892 Here is an example that uses several different kinds of pattern:
8893 .code
8894 domainlist funny_domains = \
8895   @ : \
8896   lib.unseen.edu : \
8897   *.foundation.fict.example : \
8898   \N^[1-2]\d{3}\.fict\.example$\N : \
8899   partial-dbm;/opt/data/penguin/book : \
8900   nis;domains.byname : \
8901   nisplus;[name=$domain,status=local],domains.org_dir
8902 .endd
8903 There are obvious processing trade-offs among the various matching modes. Using
8904 an asterisk is faster than a regular expression, and listing a few names
8905 explicitly probably is too. The use of a file or database lookup is expensive,
8906 but may be the only option if hundreds of names are required. Because the
8907 patterns are tested in order, it makes sense to put the most commonly matched
8908 patterns earlier.
8909
8910
8911
8912 .section "Host lists" "SECThostlist"
8913 .cindex "host list" "patterns in"
8914 .cindex "list" "host list"
8915 Host lists are used to control what remote hosts are allowed to do. For
8916 example, some hosts may be allowed to use the local host as a relay, and some
8917 may be permitted to use the SMTP ETRN command. Hosts can be identified in
8918 two different ways, by name or by IP address. In a host list, some types of
8919 pattern are matched to a host name, and some are matched to an IP address.
8920 You need to be particularly careful with this when single-key lookups are
8921 involved, to ensure that the right value is being used as the key.
8922
8923
8924 .section "Special host list patterns" "SECID80"
8925 .cindex "empty item in hosts list"
8926 .cindex "host list" "empty string in"
8927 If a host list item is the empty string, it matches only when no remote host is
8928 involved. This is the case when a message is being received from a local
8929 process using SMTP on the standard input, that is, when a TCP/IP connection is
8930 not used.
8931
8932 .cindex "asterisk" "in host list"
8933 The special pattern &"*"& in a host list matches any host or no host. Neither
8934 the IP address nor the name is actually inspected.
8935
8936
8937
8938 .section "Host list patterns that match by IP address" "SECThoslispatip"
8939 .cindex "host list" "matching IP addresses"
8940 If an IPv4 host calls an IPv6 host and the call is accepted on an IPv6 socket,
8941 the incoming address actually appears in the IPv6 host as
8942 &`::ffff:`&<&'v4address'&>. When such an address is tested against a host
8943 list, it is converted into a traditional IPv4 address first. (Not all operating
8944 systems accept IPv4 calls on IPv6 sockets, as there have been some security
8945 concerns.)
8946
8947 The following types of pattern in a host list check the remote host by
8948 inspecting its IP address:
8949
8950 .ilist
8951 If the pattern is a plain domain name (not a regular expression, not starting
8952 with *, not a lookup of any kind), Exim calls the operating system function
8953 to find the associated IP address(es). Exim uses the newer
8954 &[getipnodebyname()]& function when available, otherwise &[gethostbyname()]&.
8955 This typically causes a forward DNS lookup of the name. The result is compared
8956 with the IP address of the subject host.
8957
8958 If there is a temporary problem (such as a DNS timeout) with the host name
8959 lookup, a temporary error occurs. For example, if the list is being used in an
8960 ACL condition, the ACL gives a &"defer"& response, usually leading to a
8961 temporary SMTP error code. If no IP address can be found for the host name,
8962 what happens is described in section &<<SECTbehipnot>>& below.
8963
8964 .next
8965 .cindex "@ in a host list"
8966 If the pattern is &"@"&, the primary host name is substituted and used as a
8967 domain name, as just described.
8968
8969 .next
8970 If the pattern is an IP address, it is matched against the IP address of the
8971 subject host. IPv4 addresses are given in the normal &"dotted-quad"& notation.
8972 IPv6 addresses can be given in colon-separated format, but the colons have to
8973 be doubled so as not to be taken as item separators when the default list
8974 separator is used. IPv6 addresses are recognized even when Exim is compiled
8975 without IPv6 support. This means that if they appear in a host list on an
8976 IPv4-only host, Exim will not treat them as host names. They are just addresses
8977 that can never match a client host.
8978
8979 .next
8980 .cindex "@[] in a host list"
8981 If the pattern is &"@[]"&, it matches the IP address of any IP interface on
8982 the local host. For example, if the local host is an IPv4 host with one
8983 interface address 10.45.23.56, these two ACL statements have the same effect:
8984 .code
8985 accept hosts = 127.0.0.1 : 10.45.23.56
8986 accept hosts = @[]
8987 .endd
8988 .next
8989 .cindex "CIDR notation"
8990 If the pattern is an IP address followed by a slash and a mask length, for
8991 example
8992 .code
8993 10.11.42.0/24
8994 .endd
8995 , it is matched against the IP address of the subject
8996 host under the given mask. This allows an entire network of hosts to be
8997 included (or excluded) by a single item. The mask uses CIDR notation; it
8998 specifies the number of address bits that must match, starting from the most
8999 significant end of the address.
9000
9001 &*Note*&: The mask is &'not'& a count of addresses, nor is it the high number
9002 of a range of addresses. It is the number of bits in the network portion of the
9003 address. The above example specifies a 24-bit netmask, so it matches all 256
9004 addresses in the 10.11.42.0 network. An item such as
9005 .code
9006 192.168.23.236/31
9007 .endd
9008 matches just two addresses, 192.168.23.236 and 192.168.23.237. A mask value of
9009 32 for an IPv4 address is the same as no mask at all; just a single address
9010 matches.
9011
9012 Here is another example which shows an IPv4 and an IPv6 network:
9013 .code
9014 recipient_unqualified_hosts = 192.168.0.0/16: \
9015                               3ffe::ffff::836f::::/48
9016 .endd
9017 The doubling of list separator characters applies only when these items
9018 appear inline in a host list. It is not required when indirecting via a file.
9019 For example:
9020 .code
9021 recipient_unqualified_hosts = /opt/exim/unqualnets
9022 .endd
9023 could make use of a file containing
9024 .code
9025 172.16.0.0/12
9026 3ffe:ffff:836f::/48
9027 .endd
9028 to have exactly the same effect as the previous example. When listing IPv6
9029 addresses inline, it is usually more convenient to use the facility for
9030 changing separator characters. This list contains the same two networks:
9031 .code
9032 recipient_unqualified_hosts = <; 172.16.0.0/12; \
9033                                  3ffe:ffff:836f::/48
9034 .endd
9035 The separator is changed to semicolon by the leading &"<;"& at the start of the
9036 list.
9037 .endlist
9038
9039
9040
9041 .section "Host list patterns for single-key lookups by host address" &&&
9042          "SECThoslispatsikey"
9043 .cindex "host list" "lookup of IP address"
9044 When a host is to be identified by a single-key lookup of its complete IP
9045 address, the pattern takes this form:
9046 .display
9047 &`net-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
9048 .endd
9049 For example:
9050 .code
9051 hosts_lookup = net-cdb;/hosts-by-ip.db
9052 .endd
9053 The text form of the IP address of the subject host is used as the lookup key.
9054 IPv6 addresses are converted to an unabbreviated form, using lower case
9055 letters, with dots as separators because colon is the key terminator in
9056 &(lsearch)& files. [Colons can in fact be used in keys in &(lsearch)& files by
9057 quoting the keys, but this is a facility that was added later.] The data
9058 returned by the lookup is not used.
9059
9060 .cindex "IP address" "masking"
9061 .cindex "host list" "masked IP address"
9062 Single-key lookups can also be performed using masked IP addresses, using
9063 patterns of this form:
9064 .display
9065 &`net<`&&'number'&&`>-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
9066 .endd
9067 For example:
9068 .code
9069 net24-dbm;/networks.db
9070 .endd
9071 The IP address of the subject host is masked using <&'number'&> as the mask
9072 length. A textual string is constructed from the masked value, followed by the
9073 mask, and this is used as the lookup key. For example, if the host's IP address
9074 is 192.168.34.6, the key that is looked up for the above example is
9075 &"192.168.34.0/24"&.
9076
9077 When an IPv6 address is converted to a string, dots are normally used instead
9078 of colons, so that keys in &(lsearch)& files need not contain colons (which
9079 terminate &(lsearch)& keys). This was implemented some time before the ability
9080 to quote keys was made available in &(lsearch)& files. However, the more
9081 recently implemented &(iplsearch)& files do require colons in IPv6 keys
9082 (notated using the quoting facility) so as to distinguish them from IPv4 keys.
9083 For this reason, when the lookup type is &(iplsearch)&, IPv6 addresses are
9084 converted using colons and not dots.
9085 In all cases except IPv4-mapped IPv6, full, unabbreviated IPv6
9086 addresses are always used.
9087 The latter are converted to IPv4 addresses, in dotted-quad form.
9088
9089 Ideally, it would be nice to tidy up this anomalous situation by changing to
9090 colons in all cases, given that quoting is now available for &(lsearch)&.
9091 However, this would be an incompatible change that might break some existing
9092 configurations.
9093
9094 &*Warning*&: Specifying &%net32-%& (for an IPv4 address) or &%net128-%& (for an
9095 IPv6 address) is not the same as specifying just &%net-%& without a number. In
9096 the former case the key strings include the mask value, whereas in the latter
9097 case the IP address is used on its own.
9098
9099
9100
9101 .section "Host list patterns that match by host name" "SECThoslispatnam"
9102 .cindex "host" "lookup failures"
9103 .cindex "unknown host name"
9104 .cindex "host list" "matching host name"
9105 There are several types of pattern that require Exim to know the name of the
9106 remote host. These are either wildcard patterns or lookups by name. (If a
9107 complete hostname is given without any wildcarding, it is used to find an IP
9108 address to match against, as described in section &<<SECThoslispatip>>&
9109 above.)
9110
9111 If the remote host name is not already known when Exim encounters one of these
9112 patterns, it has to be found from the IP address.
9113 Although many sites on the Internet are conscientious about maintaining reverse
9114 DNS data for their hosts, there are also many that do not do this.
9115 Consequently, a name cannot always be found, and this may lead to unwanted
9116 effects. Take care when configuring host lists with wildcarded name patterns.
9117 Consider what will happen if a name cannot be found.
9118
9119 Because of the problems of determining host names from IP addresses, matching
9120 against host names is not as common as matching against IP addresses.
9121
9122 By default, in order to find a host name, Exim first does a reverse DNS lookup;
9123 if no name is found in the DNS, the system function (&[gethostbyaddr()]& or
9124 &[getipnodebyaddr()]& if available) is tried. The order in which these lookups
9125 are done can be changed by setting the &%host_lookup_order%& option. For
9126 security, once Exim has found one or more names, it looks up the IP addresses
9127 for these names and compares them with the IP address that it started with.
9128 Only those names whose IP addresses match are accepted. Any other names are
9129 discarded. If no names are left, Exim behaves as if the host name cannot be
9130 found. In the most common case there is only one name and one IP address.
9131
9132 There are some options that control what happens if a host name cannot be
9133 found. These are described in section &<<SECTbehipnot>>& below.
9134
9135 .cindex "host" "alias for"
9136 .cindex "alias for host"
9137 As a result of aliasing, hosts may have more than one name. When processing any
9138 of the following types of pattern, all the host's names are checked:
9139
9140 .ilist
9141 .cindex "asterisk" "in host list"
9142 If a pattern starts with &"*"& the remainder of the item must match the end of
9143 the host name. For example, &`*.b.c`& matches all hosts whose names end in
9144 &'.b.c'&. This special simple form is provided because this is a very common
9145 requirement. Other kinds of wildcarding require the use of a regular
9146 expression.
9147 .next
9148 .cindex "regular expressions" "in host list"
9149 .cindex "host list" "regular expression in"
9150 If the item starts with &"^"& it is taken to be a regular expression which is
9151 matched against the host name. Host names are case-independent, so this regular
9152 expression match is by default case-independent, but you can make it
9153 case-dependent by starting it with &`(?-i)`&. References to descriptions of the
9154 syntax of regular expressions are given in chapter &<<CHAPregexp>>&. For
9155 example,
9156 .code
9157 ^(a|b)\.c\.d$
9158 .endd
9159 is a regular expression that matches either of the two hosts &'a.c.d'& or
9160 &'b.c.d'&. When a regular expression is used in a host list, you must take care
9161 that backslash and dollar characters are not misinterpreted as part of the
9162 string expansion. The simplest way to do this is to use &`\N`& to mark that
9163 part of the string as non-expandable. For example:
9164 .code
9165 sender_unqualified_hosts = \N^(a|b)\.c\.d$\N : ....
9166 .endd
9167 &*Warning*&: If you want to match a complete host name, you must include the
9168 &`$`& terminating metacharacter in the regular expression, as in the above
9169 example. Without it, a match at the start of the host name is all that is
9170 required.
9171 .endlist
9172
9173
9174
9175
9176 .section "Behaviour when an IP address or name cannot be found" "SECTbehipnot"
9177 .cindex "host" "lookup failures, permanent"
9178 While processing a host list, Exim may need to look up an IP address from a
9179 name (see section &<<SECThoslispatip>>&), or it may need to look up a host name
9180 from an IP address (see section &<<SECThoslispatnam>>&). In either case, the
9181 behaviour when it fails to find the information it is seeking is the same.
9182
9183 &*Note*&: This section applies to permanent lookup failures. It does &'not'&
9184 apply to temporary DNS errors, whose handling is described in the next section.
9185
9186 .cindex "&`+include_unknown`&"
9187 .cindex "&`+ignore_unknown`&"
9188 Exim parses a host list from left to right. If it encounters a permanent
9189 lookup failure in any item in the host list before it has found a match,
9190 Exim treats it as a failure and the default behavior is as if the host
9191 does not match the list. This may not always be what you want to happen.
9192 To change Exim's behaviour, the special items &`+include_unknown`& or
9193 &`+ignore_unknown`& may appear in the list (at top level &-- they are
9194 not recognized in an indirected file).
9195
9196 .ilist
9197 If any item that follows &`+include_unknown`& requires information that
9198 cannot found, Exim behaves as if the host does match the list. For example,
9199 .code
9200 host_reject_connection = +include_unknown:*.enemy.ex
9201 .endd
9202 rejects connections from any host whose name matches &`*.enemy.ex`&, and also
9203 any hosts whose name it cannot find.
9204
9205 .next
9206 If any item that follows &`+ignore_unknown`& requires information that cannot
9207 be found, Exim ignores that item and proceeds to the rest of the list. For
9208 example:
9209 .code
9210 accept hosts = +ignore_unknown : friend.example : \
9211                192.168.4.5
9212 .endd
9213 accepts from any host whose name is &'friend.example'& and from 192.168.4.5,
9214 whether or not its host name can be found. Without &`+ignore_unknown`&, if no
9215 name can be found for 192.168.4.5, it is rejected.
9216 .endlist
9217
9218 Both &`+include_unknown`& and &`+ignore_unknown`& may appear in the same
9219 list. The effect of each one lasts until the next, or until the end of the
9220 list.
9221
9222 .section "Mixing wildcarded host names and addresses in host lists" &&&
9223          "SECTmixwilhos"
9224 .cindex "host list" "mixing names and addresses in"
9225
9226 This section explains the host/ip processing logic with the same concepts
9227 as the previous section, but specifically addresses what happens when a
9228 wildcarded hostname is one of the items in the hostlist.
9229
9230 .ilist
9231 If you have name lookups or wildcarded host names and
9232 IP addresses in the same host list, you should normally put the IP
9233 addresses first. For example, in an ACL you could have:
9234 .code
9235 accept hosts = 10.9.8.7 : *.friend.example
9236 .endd
9237 The reason you normally would order it this way lies in the
9238 left-to-right way that Exim processes lists.  It can test IP addresses
9239 without doing any DNS lookups, but when it reaches an item that requires
9240 a host name, it fails if it cannot find a host name to compare with the
9241 pattern. If the above list is given in the opposite order, the
9242 &%accept%& statement fails for a host whose name cannot be found, even
9243 if its IP address is 10.9.8.7.
9244
9245 .next
9246 If you really do want to do the name check first, and still recognize the IP
9247 address, you can rewrite the ACL like this:
9248 .code
9249 accept hosts = *.friend.example
9250 accept hosts = 10.9.8.7
9251 .endd
9252 If the first &%accept%& fails, Exim goes on to try the second one. See chapter
9253 &<<CHAPACL>>& for details of ACLs. Alternatively, you can use
9254 &`+ignore_unknown`&, which was discussed in depth in the first example in
9255 this section.
9256 .endlist
9257
9258
9259 .section "Temporary DNS errors when looking up host information" &&&
9260          "SECTtemdnserr"
9261 .cindex "host" "lookup failures, temporary"
9262 .cindex "&`+include_defer`&"
9263 .cindex "&`+ignore_defer`&"
9264 A temporary DNS lookup failure normally causes a defer action (except when
9265 &%dns_again_means_nonexist%& converts it into a permanent error). However,
9266 host lists can include &`+ignore_defer`& and &`+include_defer`&, analogous to
9267 &`+ignore_unknown`& and &`+include_unknown`&, as described in the previous
9268 section. These options should be used with care, probably only in non-critical
9269 host lists such as whitelists.
9270
9271
9272
9273 .section "Host list patterns for single-key lookups by host name" &&&
9274          "SECThoslispatnamsk"
9275 .cindex "unknown host name"
9276 .cindex "host list" "matching host name"
9277 If a pattern is of the form
9278 .display
9279 <&'single-key-search-type'&>;<&'search-data'&>
9280 .endd
9281 for example
9282 .code
9283 dbm;/host/accept/list
9284 .endd
9285 a single-key lookup is performed, using the host name as its key. If the
9286 lookup succeeds, the host matches the item. The actual data that is looked up
9287 is not used.
9288
9289 &*Reminder*&: With this kind of pattern, you must have host &'names'& as
9290 keys in the file, not IP addresses. If you want to do lookups based on IP
9291 addresses, you must precede the search type with &"net-"& (see section
9292 &<<SECThoslispatsikey>>&). There is, however, no reason why you could not use
9293 two items in the same list, one doing an address lookup and one doing a name
9294 lookup, both using the same file.
9295
9296
9297
9298 .section "Host list patterns for query-style lookups" "SECID81"
9299 If a pattern is of the form
9300 .display
9301 <&'query-style-search-type'&>;<&'query'&>
9302 .endd
9303 the query is obeyed, and if it succeeds, the host matches the item. The actual
9304 data that is looked up is not used. The variables &$sender_host_address$& and
9305 &$sender_host_name$& can be used in the query. For example:
9306 .code
9307 hosts_lookup = pgsql;\
9308   select ip from hostlist where ip='$sender_host_address'
9309 .endd
9310 The value of &$sender_host_address$& for an IPv6 address contains colons. You
9311 can use the &%sg%& expansion item to change this if you need to. If you want to
9312 use masked IP addresses in database queries, you can use the &%mask%& expansion
9313 operator.
9314
9315 If the query contains a reference to &$sender_host_name$&, Exim automatically
9316 looks up the host name if it has not already done so. (See section
9317 &<<SECThoslispatnam>>& for comments on finding host names.)
9318
9319 Historical note: prior to release 4.30, Exim would always attempt to find a
9320 host name before running the query, unless the search type was preceded by
9321 &`net-`&. This is no longer the case. For backwards compatibility, &`net-`& is
9322 still recognized for query-style lookups, but its presence or absence has no
9323 effect. (Of course, for single-key lookups, &`net-`& &'is'& important.
9324 See section &<<SECThoslispatsikey>>&.)
9325
9326
9327
9328
9329
9330 .section "Address lists" "SECTaddresslist"
9331 .cindex "list" "address list"
9332 .cindex "address list" "empty item"
9333 .cindex "address list" "patterns"
9334 Address lists contain patterns that are matched against mail addresses. There
9335 is one special case to be considered: the sender address of a bounce message is
9336 always empty. You can test for this by providing an empty item in an address
9337 list. For example, you can set up a router to process bounce messages by
9338 using this option setting:
9339 .code
9340 senders = :
9341 .endd
9342 The presence of the colon creates an empty item. If you do not provide any
9343 data, the list is empty and matches nothing. The empty sender can also be
9344 detected by a regular expression that matches an empty string,
9345 and by a query-style lookup that succeeds when &$sender_address$& is empty.
9346
9347 Non-empty items in an address list can be straightforward email addresses. For
9348 example:
9349 .code
9350 senders = jbc@askone.example : hs@anacreon.example
9351 .endd
9352 A certain amount of wildcarding is permitted. If a pattern contains an @
9353 character, but is not a regular expression and does not begin with a
9354 semicolon-terminated lookup type (described below), the local part of the
9355 subject address is compared with the local part of the pattern, which may start
9356 with an asterisk. If the local parts match, the domain is checked in exactly
9357 the same way as for a pattern in a domain list. For example, the domain can be
9358 wildcarded, refer to a named list, or be a lookup:
9359 .code
9360 deny senders = *@*.spamming.site:\
9361                *@+hostile_domains:\
9362                bozo@partial-lsearch;/list/of/dodgy/sites:\
9363                *@dbm;/bad/domains.db
9364 .endd
9365 .cindex "local part" "starting with !"
9366 .cindex "address list" "local part starting with !"
9367 If a local part that begins with an exclamation mark is required, it has to be
9368 specified using a regular expression, because otherwise the exclamation mark is
9369 treated as a sign of negation, as is standard in lists.
9370
9371 If a non-empty pattern that is not a regular expression or a lookup does not
9372 contain an @ character, it is matched against the domain part of the subject
9373 address. The only two formats that are recognized this way are a literal
9374 domain, or a domain pattern that starts with *. In both these cases, the effect
9375 is the same as if &`*@`& preceded the pattern. For example:
9376 .code
9377 deny senders = enemy.domain : *.enemy.domain
9378 .endd
9379
9380 The following kinds of more complicated address list pattern can match any
9381 address, including the empty address that is characteristic of bounce message
9382 senders:
9383
9384 .ilist
9385 .cindex "regular expressions" "in address list"
9386 .cindex "address list" "regular expression in"
9387 If (after expansion) a pattern starts with &"^"&, a regular expression match is
9388 done against the complete address, with the pattern as the regular expression.
9389 You must take care that backslash and dollar characters are not misinterpreted
9390 as part of the string expansion. The simplest way to do this is to use &`\N`&
9391 to mark that part of the string as non-expandable. For example:
9392 .code
9393 deny senders = \N^.*this.*@example\.com$\N : \
9394                \N^\d{8}.+@spamhaus.example$\N : ...
9395 .endd
9396 The &`\N`& sequences are removed by the expansion, so these items do indeed
9397 start with &"^"& by the time they are being interpreted as address patterns.
9398
9399 .next
9400 .cindex "address list" "lookup for complete address"
9401 Complete addresses can be looked up by using a pattern that starts with a
9402 lookup type terminated by a semicolon, followed by the data for the lookup. For
9403 example:
9404 .code
9405 deny senders = cdb;/etc/blocked.senders : \
9406   mysql;select address from blocked where \
9407   address='${quote_mysql:$sender_address}'
9408 .endd
9409 Both query-style and single-key lookup types can be used. For a single-key
9410 lookup type, Exim uses the complete address as the key. However, empty keys are
9411 not supported for single-key lookups, so a match against the empty address
9412 always fails. This restriction does not apply to query-style lookups.
9413
9414 Partial matching for single-key lookups (section &<<SECTpartiallookup>>&)
9415 cannot be used, and is ignored if specified, with an entry being written to the
9416 panic log.
9417 .cindex "*@ with single-key lookup"
9418 However, you can configure lookup defaults, as described in section
9419 &<<SECTdefaultvaluelookups>>&, but this is useful only for the &"*@"& type of
9420 default. For example, with this lookup:
9421 .code
9422 accept senders = lsearch*@;/some/file
9423 .endd
9424 the file could contains lines like this:
9425 .code
9426 user1@domain1.example
9427 *@domain2.example
9428 .endd
9429 and for the sender address &'nimrod@jaeger.example'&, the sequence of keys
9430 that are tried is:
9431 .code
9432 nimrod@jaeger.example
9433 *@jaeger.example
9434 *
9435 .endd
9436 &*Warning 1*&: Do not include a line keyed by &"*"& in the file, because that
9437 would mean that every address matches, thus rendering the test useless.
9438
9439 &*Warning 2*&: Do not confuse these two kinds of item:
9440 .code
9441 deny recipients = dbm*@;/some/file
9442 deny recipients = *@dbm;/some/file
9443 .endd
9444 The first does a whole address lookup, with defaulting, as just described,
9445 because it starts with a lookup type. The second matches the local part and
9446 domain independently, as described in a bullet point below.
9447 .endlist
9448
9449
9450 The following kinds of address list pattern can match only non-empty addresses.
9451 If the subject address is empty, a match against any of these pattern types
9452 always fails.
9453
9454
9455 .ilist
9456 .cindex "@@ with single-key lookup"
9457 .cindex "address list" "@@ lookup type"
9458 .cindex "address list" "split local part and domain"
9459 If a pattern starts with &"@@"& followed by a single-key lookup item
9460 (for example, &`@@lsearch;/some/file`&), the address that is being checked is
9461 split into a local part and a domain. The domain is looked up in the file. If
9462 it is not found, there is no match. If it is found, the data that is looked up
9463 from the file is treated as a colon-separated list of local part patterns, each
9464 of which is matched against the subject local part in turn.
9465
9466 .cindex "asterisk" "in address list"
9467 The lookup may be a partial one, and/or one involving a search for a default
9468 keyed by &"*"& (see section &<<SECTdefaultvaluelookups>>&). The local part
9469 patterns that are looked up can be regular expressions or begin with &"*"&, or
9470 even be further lookups. They may also be independently negated. For example,
9471 with
9472 .code
9473 deny senders = @@dbm;/etc/reject-by-domain
9474 .endd
9475 the data from which the DBM file is built could contain lines like
9476 .code
9477 baddomain.com:  !postmaster : *
9478 .endd
9479 to reject all senders except &%postmaster%& from that domain.
9480
9481 .cindex "local part" "starting with !"
9482 If a local part that actually begins with an exclamation mark is required, it
9483 has to be specified using a regular expression. In &(lsearch)& files, an entry
9484 may be split over several lines by indenting the second and subsequent lines,
9485 but the separating colon must still be included at line breaks. White space
9486 surrounding the colons is ignored. For example:
9487 .code
9488 aol.com:  spammer1 : spammer2 : ^[0-9]+$ :
9489   spammer3 : spammer4
9490 .endd
9491 As in all colon-separated lists in Exim, a colon can be included in an item by
9492 doubling.
9493
9494 If the last item in the list starts with a right angle-bracket, the remainder
9495 of the item is taken as a new key to look up in order to obtain a continuation
9496 list of local parts. The new key can be any sequence of characters. Thus one
9497 might have entries like
9498 .code
9499 aol.com: spammer1 : spammer 2 : >*
9500 xyz.com: spammer3 : >*
9501 *:       ^\d{8}$
9502 .endd
9503 in a file that was searched with &%@@dbm*%&, to specify a match for 8-digit
9504 local parts for all domains, in addition to the specific local parts listed for
9505 each domain. Of course, using this feature costs another lookup each time a
9506 chain is followed, but the effort needed to maintain the data is reduced.
9507
9508 .cindex "loop" "in lookups"
9509 It is possible to construct loops using this facility, and in order to catch
9510 them, the chains may be no more than fifty items long.
9511
9512 .next
9513 The @@<&'lookup'&> style of item can also be used with a query-style
9514 lookup, but in this case, the chaining facility is not available. The lookup
9515 can only return a single list of local parts.
9516 .endlist
9517
9518 &*Warning*&: There is an important difference between the address list items
9519 in these two examples:
9520 .code
9521 senders = +my_list
9522 senders = *@+my_list
9523 .endd
9524 In the first one, &`my_list`& is a named address list, whereas in the second
9525 example it is a named domain list.
9526
9527
9528
9529
9530 .section "Case of letters in address lists" "SECTcasletadd"
9531 .cindex "case of local parts"
9532 .cindex "address list" "case forcing"
9533 .cindex "case forcing in address lists"
9534 Domains in email addresses are always handled caselessly, but for local parts
9535 case may be significant on some systems (see &%caseful_local_part%& for how
9536 Exim deals with this when routing addresses). However, RFC 2505 (&'Anti-Spam
9537 Recommendations for SMTP MTAs'&) suggests that matching of addresses to
9538 blocking lists should be done in a case-independent manner. Since most address
9539 lists in Exim are used for this kind of control, Exim attempts to do this by
9540 default.
9541
9542 The domain portion of an address is always lowercased before matching it to an
9543 address list. The local part is lowercased by default, and any string
9544 comparisons that take place are done caselessly. This means that the data in
9545 the address list itself, in files included as plain filenames, and in any file
9546 that is looked up using the &"@@"& mechanism, can be in any case. However, the
9547 keys in files that are looked up by a search type other than &(lsearch)& (which
9548 works caselessly) must be in lower case, because these lookups are not
9549 case-independent.
9550
9551 .cindex "&`+caseful`&"
9552 To allow for the possibility of caseful address list matching, if an item in
9553 an address list is the string &"+caseful"&, the original case of the local
9554 part is restored for any comparisons that follow, and string comparisons are no
9555 longer case-independent. This does not affect the domain, which remains in
9556 lower case. However, although independent matches on the domain alone are still
9557 performed caselessly, regular expressions that match against an entire address
9558 become case-sensitive after &"+caseful"& has been seen.
9559
9560
9561
9562 .section "Local part lists" "SECTlocparlis"
9563 .cindex "list" "local part list"
9564 .cindex "local part" "list"
9565 These behave in the same way as domain and host lists, with the following
9566 changes:
9567
9568 Case-sensitivity in local part lists is handled in the same way as for address
9569 lists, as just described. The &"+caseful"& item can be used if required. In a
9570 setting of the &%local_parts%& option in a router with &%caseful_local_part%&
9571 set false, the subject is lowercased and the matching is initially
9572 case-insensitive. In this case, &"+caseful"& will restore case-sensitive
9573 matching in the local part list, but not elsewhere in the router. If
9574 &%caseful_local_part%& is set true in a router, matching in the &%local_parts%&
9575 option is case-sensitive from the start.
9576
9577 If a local part list is indirected to a file (see section &<<SECTfilnamlis>>&),
9578 comments are handled in the same way as address lists &-- they are recognized
9579 only if the # is preceded by white space or the start of the line.
9580 Otherwise, local part lists are matched in the same way as domain lists, except
9581 that the special items that refer to the local host (&`@`&, &`@[]`&,
9582 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`&) are not recognized.
9583 Refer to section &<<SECTdomainlist>>& for details of the other available item
9584 types.
9585 .ecindex IIDdohoadli
9586
9587
9588
9589
9590 . ////////////////////////////////////////////////////////////////////////////
9591 . ////////////////////////////////////////////////////////////////////////////
9592
9593 .chapter "String expansions" "CHAPexpand"
9594 .scindex IIDstrexp "expansion" "of strings"
9595 Many strings in Exim's runtime configuration are expanded before use. Some of
9596 them are expanded every time they are used; others are expanded only once.
9597
9598 When a string is being expanded it is copied verbatim from left to right except
9599 .cindex expansion "string concatenation"
9600 when a dollar or backslash character is encountered. A dollar specifies the
9601 start of a portion of the string that is interpreted and replaced as described
9602 below in section &<<SECTexpansionitems>>& onwards. Backslash is used as an
9603 escape character, as described in the following section.
9604
9605 Whether a string is expanded depends upon the context.  Usually this is solely
9606 dependent upon the option for which a value is sought; in this documentation,
9607 options for which string expansion is performed are marked with &dagger; after
9608 the data type.  ACL rules always expand strings.  A couple of expansion
9609 conditions do not expand some of the brace-delimited branches, for security
9610 reasons,
9611 .cindex "tainted data" expansion
9612 .cindex "tainted data" definition
9613 .cindex expansion "tainted data"
9614 and expansion of data deriving from the sender (&"tainted data"&)
9615 .new
9616 is not permitted (including acessing a file using a tainted name).
9617 The main config option &%allow_insecure_tainted_data%& can be used as
9618 mitigation during uprades to more secure configurations.
9619 .wen
9620
9621 .new
9622 Common ways of obtaining untainted equivalents of variables with
9623 tainted values
9624 .cindex "tainted data" "de-tainting"
9625 come down to using the tainted value as a lookup key in a trusted database.
9626 This database could be the filesystem structure,
9627 or the password file,
9628 or accessed via a DBMS.
9629 Specific methods are indexed under &"de-tainting"&.
9630 .wen
9631
9632
9633
9634 .section "Literal text in expanded strings" "SECTlittext"
9635 .cindex "expansion" "including literal text"
9636 An uninterpreted dollar can be included in an expanded string by putting a
9637 backslash in front of it. A backslash can be used to prevent any special
9638 character being treated specially in an expansion, including backslash itself.
9639 If the string appears in quotes in the configuration file, two backslashes are
9640 required because the quotes themselves cause interpretation of backslashes when
9641 the string is read in (see section &<<SECTstrings>>&).
9642
9643 .cindex "expansion" "non-expandable substrings"
9644 A portion of the string can specified as non-expandable by placing it between
9645 two occurrences of &`\N`&. This is particularly useful for protecting regular
9646 expressions, which often contain backslashes and dollar signs. For example:
9647 .code
9648 deny senders = \N^\d{8}[a-z]@some\.site\.example$\N
9649 .endd
9650 On encountering the first &`\N`&, the expander copies subsequent characters
9651 without interpretation until it reaches the next &`\N`& or the end of the
9652 string.
9653
9654
9655
9656 .section "Character escape sequences in expanded strings" "SECID82"
9657 .cindex "expansion" "escape sequences"
9658 A backslash followed by one of the letters &"n"&, &"r"&, or &"t"& in an
9659 expanded string is recognized as an escape sequence for the character newline,
9660 carriage return, or tab, respectively. A backslash followed by up to three
9661 octal digits is recognized as an octal encoding for a single character, and a
9662 backslash followed by &"x"& and up to two hexadecimal digits is a hexadecimal
9663 encoding.
9664
9665 These escape sequences are also recognized in quoted strings when they are read
9666 in. Their interpretation in expansions as well is useful for unquoted strings,
9667 and for other cases such as looked-up strings that are then expanded.
9668
9669
9670 .section "Testing string expansions" "SECID83"
9671 .cindex "expansion" "testing"
9672 .cindex "testing" "string expansion"
9673 .oindex "&%-be%&"
9674 Many expansions can be tested by calling Exim with the &%-be%& option. This
9675 takes the command arguments, or lines from the standard input if there are no
9676 arguments, runs them through the string expansion code, and writes the results
9677 to the standard output. Variables based on configuration values are set up, but
9678 since no message is being processed, variables such as &$local_part$& have no
9679 value. Nevertheless the &%-be%& option can be useful for checking out file and
9680 database lookups, and the use of expansion operators such as &%sg%&, &%substr%&
9681 and &%nhash%&.
9682
9683 Exim gives up its root privilege when it is called with the &%-be%& option, and
9684 instead runs under the uid and gid it was called with, to prevent users from
9685 using &%-be%& for reading files to which they do not have access.
9686
9687 .oindex "&%-bem%&"
9688 If you want to test expansions that include variables whose values are taken
9689 from a message, there are two other options that can be used. The &%-bem%&
9690 option is like &%-be%& except that it is followed by a filename. The file is
9691 read as a message before doing the test expansions. For example:
9692 .code
9693 exim -bem /tmp/test.message '$h_subject:'
9694 .endd
9695 The &%-Mset%& option is used in conjunction with &%-be%& and is followed by an
9696 Exim message identifier. For example:
9697 .code
9698 exim -be -Mset 1GrA8W-0004WS-LQ '$recipients'
9699 .endd
9700 This loads the message from Exim's spool before doing the test expansions, and
9701 is therefore restricted to admin users.
9702
9703
9704 .section "Forced expansion failure" "SECTforexpfai"
9705 .cindex "expansion" "forced failure"
9706 A number of expansions that are described in the following section have
9707 alternative &"true"& and &"false"& substrings, enclosed in brace characters
9708 (which are sometimes called &"curly brackets"&). Which of the two strings is
9709 used depends on some condition that is evaluated as part of the expansion. If,
9710 instead of a &"false"& substring, the word &"fail"& is used (not in braces),
9711 the entire string expansion fails in a way that can be detected by the code
9712 that requested the expansion. This is called &"forced expansion failure"&, and
9713 its consequences depend on the circumstances. In some cases it is no different
9714 from any other expansion failure, but in others a different action may be
9715 taken. Such variations are mentioned in the documentation of the option that is
9716 being expanded.
9717
9718
9719
9720
9721 .section "Expansion items" "SECTexpansionitems"
9722 The following items are recognized in expanded strings. White space may be used
9723 between sub-items that are keywords or substrings enclosed in braces inside an
9724 outer set of braces, to improve readability. &*Warning*&: Within braces,
9725 white space is significant.
9726
9727 .vlist
9728 .vitem &*$*&<&'variable&~name'&>&~or&~&*${*&<&'variable&~name'&>&*}*&
9729 .cindex "expansion" "variables"
9730 Substitute the contents of the named variable, for example:
9731 .code
9732 $local_part
9733 ${domain}
9734 .endd
9735 The second form can be used to separate the name from subsequent alphanumeric
9736 characters. This form (using braces) is available only for variables; it does
9737 &'not'& apply to message headers. The names of the variables are given in
9738 section &<<SECTexpvar>>& below. If the name of a non-existent variable is
9739 given, the expansion fails.
9740
9741 .vitem &*${*&<&'op'&>&*:*&<&'string'&>&*}*&
9742 .cindex "expansion" "operators"
9743 The string is first itself expanded, and then the operation specified by
9744 <&'op'&> is applied to it. For example:
9745 .code
9746 ${lc:$local_part}
9747 .endd
9748 The string starts with the first character after the colon, which may be
9749 leading white space. A list of operators is given in section &<<SECTexpop>>&
9750 below. The operator notation is used for simple expansion items that have just
9751 one argument, because it reduces the number of braces and therefore makes the
9752 string easier to understand.
9753
9754 .vitem &*$bheader_*&<&'header&~name'&>&*:*&&~or&~&*$bh_*&<&'header&~name'&>&*:*&
9755 This item inserts &"basic"& header lines. It is described with the &%header%&
9756 expansion item below.
9757
9758
9759 .vitem "&*${acl{*&<&'name'&>&*}{*&<&'arg'&>&*}...}*&"
9760 .cindex "expansion" "calling an acl"
9761 .cindex "&%acl%&" "call from expansion"
9762 The name and zero to nine argument strings are first expanded separately.  The expanded
9763 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
9764 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
9765 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
9766 and may use the variables; if another acl expansion is used the values
9767 are restored after it returns.  If the ACL sets
9768 a value using a "message =" modifier and returns accept or deny, the value becomes
9769 the result of the expansion.
9770 If no message is set and the ACL returns accept or deny
9771 the expansion result is an empty string.
9772 If the ACL returns defer the result is a forced-fail.  Otherwise the expansion fails.
9773
9774
9775 .vitem "&*${authresults{*&<&'authserv-id'&>&*}}*&"
9776 .cindex authentication "results header"
9777 .chindex Authentication-Results:
9778 .cindex authentication "expansion item"
9779 This item returns a string suitable for insertion as an
9780 &'Authentication-Results:'&
9781 header line.
9782 The given <&'authserv-id'&> is included in the result; typically this
9783 will be a domain name identifying the system performing the authentications.
9784 Methods that might be present in the result include:
9785 .code
9786 none
9787 iprev
9788 auth
9789 spf
9790 dkim
9791 .endd
9792
9793 Example use (as an ACL modifier):
9794 .code
9795       add_header = :at_start:${authresults {$primary_hostname}}
9796 .endd
9797 This is safe even if no authentication results are available.
9798
9799
9800 .vitem "&*${certextract{*&<&'field'&>&*}{*&<&'certificate'&>&*}&&&
9801        {*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9802 .cindex "expansion" "extracting certificate fields"
9803 .cindex "&%certextract%&" "certificate fields"
9804 .cindex "certificate" "extracting fields"
9805 The <&'certificate'&> must be a variable of type certificate.
9806 The field name is expanded and used to retrieve the relevant field from
9807 the certificate.  Supported fields are:
9808 .display
9809 &`version        `&
9810 &`serial_number  `&
9811 &`subject        `& RFC4514 DN
9812 &`issuer         `& RFC4514 DN
9813 &`notbefore      `& time
9814 &`notafter       `& time
9815 &`sig_algorithm  `&
9816 &`signature      `&
9817 &`subj_altname   `& tagged list
9818 &`ocsp_uri       `& list
9819 &`crl_uri        `& list
9820 .endd
9821 If the field is found,
9822 <&'string2'&> is expanded, and replaces the whole item;
9823 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9824 variable &$value$& contains the value that has been extracted. Afterwards, it
9825 is restored to any previous value it might have had.
9826
9827 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9828 key is not found. If {<&'string2'&>} is also omitted, the value that was
9829 extracted is used.
9830
9831 Some field names take optional modifiers, appended and separated by commas.
9832
9833 The field selectors marked as "RFC4514" above
9834 output a Distinguished Name string which is
9835 not quite
9836 parseable by Exim as a comma-separated tagged list
9837 (the exceptions being elements containing commas).
9838 RDN elements of a single type may be selected by
9839 a modifier of the type label; if so the expansion
9840 result is a list (newline-separated by default).
9841 The separator may be changed by another modifier of
9842 a right angle-bracket followed immediately by the new separator.
9843 Recognised RDN type labels include "CN", "O", "OU" and "DC".
9844
9845 The field selectors marked as "time" above
9846 take an optional modifier of "int"
9847 for which the result is the number of seconds since epoch.
9848 Otherwise the result is a human-readable string
9849 in the timezone selected by the main "timezone" option.
9850
9851 The field selectors marked as "list" above return a list,
9852 newline-separated by default,
9853 (embedded separator characters in elements are doubled).
9854 The separator may be changed by a modifier of
9855 a right angle-bracket followed immediately by the new separator.
9856
9857 The field selectors marked as "tagged" above
9858 prefix each list element with a type string and an equals sign.
9859 Elements of only one type may be selected by a modifier
9860 which is one of "dns", "uri" or "mail";
9861 if so the element tags are omitted.
9862
9863 If not otherwise noted field values are presented in human-readable form.
9864
9865 .vitem "&*${dlfunc{*&<&'file'&>&*}{*&<&'function'&>&*}{*&<&'arg'&>&*}&&&
9866        {*&<&'arg'&>&*}...}*&"
9867 .cindex &%dlfunc%&
9868 This expansion dynamically loads and then calls a locally-written C function.
9869 This functionality is available only if Exim is compiled with
9870 .code
9871 EXPAND_DLFUNC=yes
9872 .endd
9873 set in &_Local/Makefile_&. Once loaded, Exim remembers the dynamically loaded
9874 object so that it doesn't reload the same object file in the same Exim process
9875 (but of course Exim does start new processes frequently).
9876
9877 There may be from zero to eight arguments to the function.
9878
9879 When compiling
9880 a local function that is to be called in this way,
9881 first &_DLFUNC_IMPL_& should be defined,
9882 and second &_local_scan.h_& should be included.
9883 The Exim variables and functions that are defined by that API
9884 are also available for dynamically loaded functions. The function itself
9885 must have the following type:
9886 .code
9887 int dlfunction(uschar **yield, int argc, uschar *argv[])
9888 .endd
9889 Where &`uschar`& is a typedef for &`unsigned char`& in &_local_scan.h_&. The
9890 function should return one of the following values:
9891
9892 &`OK`&: Success. The string that is placed in the variable &'yield'& is put
9893 into the expanded string that is being built.
9894
9895 &`FAIL`&: A non-forced expansion failure occurs, with the error message taken
9896 from &'yield'&, if it is set.
9897
9898 &`FAIL_FORCED`&: A forced expansion failure occurs, with the error message
9899 taken from &'yield'& if it is set.
9900
9901 &`ERROR`&: Same as &`FAIL`&, except that a panic log entry is written.
9902
9903 When compiling a function that is to be used in this way with gcc,
9904 you need to add &%-shared%& to the gcc command. Also, in the Exim build-time
9905 configuration, you must add &%-export-dynamic%& to EXTRALIBS.
9906
9907
9908 .vitem "&*${env{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&"
9909 .cindex "expansion" "extracting value from environment"
9910 .cindex "environment" "values from"
9911 The key is first expanded separately, and leading and trailing white space
9912 removed.
9913 This is then searched for as a name in the environment.
9914 If a variable is found then its value is placed in &$value$&
9915 and <&'string1'&> is expanded, otherwise <&'string2'&> is expanded.
9916
9917 Instead of {<&'string2'&>} the word &"fail"& (not in curly brackets) can
9918 appear, for example:
9919 .code
9920 ${env{USER}{$value} fail }
9921 .endd
9922 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9923 {<&'string1'&>} must be present for &"fail"& to be recognized.
9924
9925 If {<&'string2'&>} is omitted an empty string is substituted on
9926 search failure.
9927 If {<&'string1'&>} is omitted the search result is substituted on
9928 search success.
9929
9930 The environment is adjusted by the &%keep_environment%& and
9931 &%add_environment%& main section options.
9932
9933
9934 .vitem "&*${extract{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9935        {*&<&'string3'&>&*}}*&"
9936 .cindex "expansion" "extracting substrings by key"
9937 .cindex "&%extract%&" "substrings by key"
9938 The key and <&'string1'&> are first expanded separately. Leading and trailing
9939 white space is removed from the key (but not from any of the strings). The key
9940 must not be empty and must not consist entirely of digits.
9941 The expanded <&'string1'&> must be of the form:
9942 .display
9943 <&'key1'&> = <&'value1'&>  <&'key2'&> = <&'value2'&> ...
9944 .endd
9945 .vindex "&$value$&"
9946 where the equals signs and spaces (but not both) are optional. If any of the
9947 values contain white space, they must be enclosed in double quotes, and any
9948 values that are enclosed in double quotes are subject to escape processing as
9949 described in section &<<SECTstrings>>&. The expanded <&'string1'&> is searched
9950 for the value that corresponds to the key. The search is case-insensitive. If
9951 the key is found, <&'string2'&> is expanded, and replaces the whole item;
9952 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9953 variable &$value$& contains the value that has been extracted. Afterwards, it
9954 is restored to any previous value it might have had.
9955
9956 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9957 key is not found. If {<&'string2'&>} is also omitted, the value that was
9958 extracted is used. Thus, for example, these two expansions are identical, and
9959 yield &"2001"&:
9960 .code
9961 ${extract{gid}{uid=1984 gid=2001}}
9962 ${extract{gid}{uid=1984 gid=2001}{$value}}
9963 .endd
9964 Instead of {<&'string3'&>} the word &"fail"& (not in curly brackets) can
9965 appear, for example:
9966 .code
9967 ${extract{Z}{A=... B=...}{$value} fail }
9968 .endd
9969 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9970 {<&'string2'&>} must be present for &"fail"& to be recognized.
9971
9972 .vitem "&*${extract json{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9973        {*&<&'string3'&>&*}}*&" &&&
9974        "&*${extract jsons{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9975        {*&<&'string3'&>&*}}*&"
9976 .cindex "expansion" "extracting from JSON object"
9977 .cindex JSON expansions
9978 The key and <&'string1'&> are first expanded separately. Leading and trailing
9979 white space is removed from the key (but not from any of the strings). The key
9980 must not be empty and must not consist entirely of digits.
9981 The expanded <&'string1'&> must be of the form:
9982 .display
9983 { <&'"key1"'&> : <&'value1'&> ,  <&'"key2"'&> , <&'value2'&> ... }
9984 .endd
9985 .vindex "&$value$&"
9986 The braces, commas and colons, and the quoting of the member name are required;
9987 the spaces are optional.
9988 Matching of the key against the member names is done case-sensitively.
9989 For the &"json"& variant,
9990 if a returned value is a JSON string, it retains its leading and
9991 trailing quotes.
9992 For the &"jsons"& variant, which is intended for use with JSON strings, the
9993 leading and trailing quotes are removed from the returned value.
9994 . XXX should be a UTF-8 compare
9995
9996 The results of matching are handled as above.
9997
9998
9999 .vitem "&*${extract{*&<&'number'&>&*}{*&<&'separators'&>&*}&&&
10000         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
10001 .cindex "expansion" "extracting substrings by number"
10002 .cindex "&%extract%&" "substrings by number"
10003 The <&'number'&> argument must consist entirely of decimal digits,
10004 apart from leading and trailing white space, which is ignored.
10005 This is what distinguishes this form of &%extract%& from the previous kind. It
10006 behaves in the same way, except that, instead of extracting a named field, it
10007 extracts from <&'string1'&> the field whose number is given as the first
10008 argument. You can use &$value$& in <&'string2'&> or &`fail`& instead of
10009 <&'string3'&> as before.
10010
10011 The fields in the string are separated by any one of the characters in the
10012 separator string. These may include space or tab characters.
10013 The first field is numbered one. If the number is negative, the fields are
10014 counted from the end of the string, with the rightmost one numbered -1. If the
10015 number given is zero, the entire string is returned. If the modulus of the
10016 number is greater than the number of fields in the string, the result is the
10017 expansion of <&'string3'&>, or the empty string if <&'string3'&> is not
10018 provided. For example:
10019 .code
10020 ${extract{2}{:}{x:42:99:& Mailer::/bin/bash}}
10021 .endd
10022 yields &"42"&, and
10023 .code
10024 ${extract{-4}{:}{x:42:99:& Mailer::/bin/bash}}
10025 .endd
10026 yields &"99"&. Two successive separators mean that the field between them is
10027 empty (for example, the fifth field above).
10028
10029
10030 .vitem "&*${extract json {*&<&'number'&>&*}}&&&
10031         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&" &&&
10032        "&*${extract jsons{*&<&'number'&>&*}}&&&
10033         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
10034 .cindex "expansion" "extracting from JSON array"
10035 .cindex JSON expansions
10036 The <&'number'&> argument must consist entirely of decimal digits,
10037 apart from leading and trailing white space, which is ignored.
10038
10039 Field selection and result handling is as above;
10040 there is no choice of field separator.
10041 For the &"json"& variant,
10042 if a returned value is a JSON string, it retains its leading and
10043 trailing quotes.
10044 For the &"jsons"& variant, which is intended for use with JSON strings, the
10045 leading and trailing quotes are removed from the returned value.
10046
10047
10048 .vitem &*${filter{*&<&'string'&>&*}{*&<&'condition'&>&*}}*&
10049 .cindex "list" "selecting by condition"
10050 .cindex "expansion" "selecting from list by condition"
10051 .vindex "&$item$&"
10052 After expansion, <&'string'&> is interpreted as a list, colon-separated by
10053 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10054 For each item
10055 in this list, its value is place in &$item$&, and then the condition is
10056 evaluated. If the condition is true, &$item$& is added to the output as an
10057 item in a new list; if the condition is false, the item is discarded. The
10058 separator used for the output list is the same as the one used for the
10059 input, but a separator setting is not included in the output. For example:
10060 .code
10061 ${filter{a:b:c}{!eq{$item}{b}}}
10062 .endd
10063 yields &`a:c`&. At the end of the expansion, the value of &$item$& is restored
10064 to what it was before. See also the &%map%& and &%reduce%& expansion items.
10065
10066
10067 .vitem &*${hash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
10068 .cindex "hash function" "textual"
10069 .cindex "expansion" "textual hash"
10070 This is a textual hashing function, and was the first to be implemented in
10071 early versions of Exim. In current releases, there are other hashing functions
10072 (numeric, MD5, and SHA-1), which are described below.
10073
10074 The first two strings, after expansion, must be numbers. Call them <&'m'&> and
10075 <&'n'&>. If you are using fixed values for these numbers, that is, if
10076 <&'string1'&> and <&'string2'&> do not change when they are expanded, you can
10077 use the simpler operator notation that avoids some of the braces:
10078 .code
10079 ${hash_<n>_<m>:<string>}
10080 .endd
10081 The second number is optional (in both notations). If <&'n'&> is greater than
10082 or equal to the length of the string, the expansion item returns the string.
10083 Otherwise it computes a new string of length <&'n'&> by applying a hashing
10084 function to the string. The new string consists of characters taken from the
10085 first <&'m'&> characters of the string
10086 .code
10087 abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQWRSTUVWXYZ0123456789
10088 .endd
10089 If <&'m'&> is not present the value 26 is used, so that only lower case
10090 letters appear. For example:
10091 .display
10092 &`$hash{3}{monty}}           `&   yields  &`jmg`&
10093 &`$hash{5}{monty}}           `&   yields  &`monty`&
10094 &`$hash{4}{62}{monty python}}`&   yields  &`fbWx`&
10095 .endd
10096
10097 .vitem "&*$header_*&<&'header&~name'&>&*:*&&~or&~&&&
10098         &*$h_*&<&'header&~name'&>&*:*&" &&&
10099        "&*$bheader_*&<&'header&~name'&>&*:*&&~or&~&&&
10100         &*$bh_*&<&'header&~name'&>&*:*&" &&&
10101        "&*$lheader_*&<&'header&~name'&>&*:*&&~or&~&&&
10102         &*$lh_*&<&'header&~name'&>&*:*&" &&&
10103        "&*$rheader_*&<&'header&~name'&>&*:*&&~or&~&&&
10104         &*$rh_*&<&'header&~name'&>&*:*&"
10105 .cindex "expansion" "header insertion"
10106 .vindex "&$header_$&"
10107 .vindex "&$bheader_$&"
10108 .vindex "&$lheader_$&"
10109 .vindex "&$rheader_$&"
10110 .cindex "header lines" "in expansion strings"
10111 .cindex "header lines" "character sets"
10112 .cindex "header lines" "decoding"
10113 Substitute the contents of the named message header line, for example
10114 .code
10115 $header_reply-to:
10116 .endd
10117 The newline that terminates a header line is not included in the expansion, but
10118 internal newlines (caused by splitting the header line over several physical
10119 lines) may be present.
10120
10121 The difference between the four pairs of expansions is in the way
10122 the data in the header line is interpreted.
10123
10124 .ilist
10125 .cindex "white space" "in header lines"
10126 &%rheader%& gives the original &"raw"& content of the header line, with no
10127 processing at all, and without the removal of leading and trailing white space.
10128
10129 .next
10130 .cindex "list" "of header lines"
10131 &%lheader%& gives a colon-separated list, one element per header when there
10132 are multiple headers with a given name.
10133 Any embedded colon characters within an element are doubled, so normal Exim
10134 list-processing facilities can be used.
10135 The terminating newline of each element is removed; in other respects
10136 the content is &"raw"&.
10137
10138 .next
10139 .cindex "base64 encoding" "in header lines"
10140 &%bheader%& removes leading and trailing white space, and then decodes base64
10141 or quoted-printable MIME &"words"& within the header text, but does no
10142 character set translation. If decoding of what looks superficially like a MIME
10143 &"word"& fails, the raw string is returned. If decoding
10144 .cindex "binary zero" "in header line"
10145 produces a binary zero character, it is replaced by a question mark &-- this is
10146 what Exim does for binary zeros that are actually received in header lines.
10147
10148 .next
10149 &%header%& tries to translate the string as decoded by &%bheader%& to a
10150 standard character set. This is an attempt to produce the same string as would
10151 be displayed on a user's MUA. If translation fails, the &%bheader%& string is
10152 returned. Translation is attempted only on operating systems that support the
10153 &[iconv()]& function. This is indicated by the compile-time macro HAVE_ICONV in
10154 a system Makefile or in &_Local/Makefile_&.
10155 .endlist ilist
10156
10157 In a filter file, the target character set for &%header%& can be specified by a
10158 command of the following form:
10159 .code
10160 headers charset "UTF-8"
10161 .endd
10162 This command affects all references to &$h_$& (or &$header_$&) expansions in
10163 subsequently obeyed filter commands. In the absence of this command, the target
10164 character set in a filter is taken from the setting of the &%headers_charset%&
10165 option in the runtime configuration. The value of this option defaults to the
10166 value of HEADERS_CHARSET in &_Local/Makefile_&. The ultimate default is
10167 ISO-8859-1.
10168
10169 Header names follow the syntax of RFC 2822, which states that they may contain
10170 any printing characters except space and colon. Consequently, curly brackets
10171 &'do not'& terminate header names, and should not be used to enclose them as
10172 if they were variables. Attempting to do so causes a syntax error.
10173
10174 Only header lines that are common to all copies of a message are visible to
10175 this mechanism. These are the original header lines that are received with the
10176 message, and any that are added by an ACL statement or by a system
10177 filter. Header lines that are added to a particular copy of a message by a
10178 router or transport are not accessible.
10179
10180 For incoming SMTP messages, no header lines are visible in
10181 ACLs that are obeyed before the data phase completes,
10182 because the header structure is not set up until the message is received.
10183 They are visible in DKIM, PRDR and DATA ACLs.
10184 Header lines that are added in a RCPT ACL (for example)
10185 are saved until the message's incoming header lines are available, at which
10186 point they are added.
10187 When any of the above ACLs are
10188 running, however, header lines added by earlier ACLs are visible.
10189
10190 Upper case and lower case letters are synonymous in header names. If the
10191 following character is white space, the terminating colon may be omitted, but
10192 this is not recommended, because you may then forget it when it is needed. When
10193 white space terminates the header name, this white space is included in the
10194 expanded string.  If the message does not contain the given header, the
10195 expansion item is replaced by an empty string. (See the &%def%& condition in
10196 section &<<SECTexpcond>>& for a means of testing for the existence of a
10197 header.)
10198
10199 If there is more than one header with the same name, they are all concatenated
10200 to form the substitution string, up to a maximum length of 64K. Unless
10201 &%rheader%& is being used, leading and trailing white space is removed from
10202 each header before concatenation, and a completely empty header is ignored. A
10203 newline character is then inserted between non-empty headers, but there is no
10204 newline at the very end. For the &%header%& and &%bheader%& expansion, for
10205 those headers that contain lists of addresses, a comma is also inserted at the
10206 junctions between headers. This does not happen for the &%rheader%& expansion.
10207
10208 .cindex "tainted data" "message headers"
10209 When the headers are from an incoming message,
10210 the result of expanding any of these variables is tainted.
10211
10212
10213 .vitem &*${hmac{*&<&'hashname'&>&*}{*&<&'secret'&>&*}{*&<&'string'&>&*}}*&
10214 .cindex "expansion" "hmac hashing"
10215 .cindex &%hmac%&
10216 This function uses cryptographic hashing (either MD5 or SHA-1) to convert a
10217 shared secret and some text into a message authentication code, as specified in
10218 RFC 2104. This differs from &`${md5:secret_text...}`& or
10219 &`${sha1:secret_text...}`& in that the hmac step adds a signature to the
10220 cryptographic hash, allowing for authentication that is not possible with MD5
10221 or SHA-1 alone. The hash name must expand to either &`md5`& or &`sha1`& at
10222 present. For example:
10223 .code
10224 ${hmac{md5}{somesecret}{$primary_hostname $tod_log}}
10225 .endd
10226 For the hostname &'mail.example.com'& and time 2002-10-17 11:30:59, this
10227 produces:
10228 .code
10229 dd97e3ba5d1a61b5006108f8c8252953
10230 .endd
10231 As an example of how this might be used, you might put in the main part of
10232 an Exim configuration:
10233 .code
10234 SPAMSCAN_SECRET=cohgheeLei2thahw
10235 .endd
10236 In a router or a transport you could then have:
10237 .code
10238 headers_add = \
10239   X-Spam-Scanned: ${primary_hostname} ${message_exim_id} \
10240   ${hmac{md5}{SPAMSCAN_SECRET}\
10241   {${primary_hostname},${message_exim_id},$h_message-id:}}
10242 .endd
10243 Then given a message, you can check where it was scanned by looking at the
10244 &'X-Spam-Scanned:'& header line. If you know the secret, you can check that
10245 this header line is authentic by recomputing the authentication code from the
10246 host name, message ID and the &'Message-id:'& header line. This can be done
10247 using Exim's &%-be%& option, or by other means, for example, by using the
10248 &'hmac_md5_hex()'& function in Perl.
10249
10250
10251 .vitem &*${if&~*&<&'condition'&>&*&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
10252 .cindex "expansion" "conditional"
10253 .cindex "&%if%&, expansion item"
10254 If <&'condition'&> is true, <&'string1'&> is expanded and replaces the whole
10255 item; otherwise <&'string2'&> is used. The available conditions are described
10256 in section &<<SECTexpcond>>& below. For example:
10257 .code
10258 ${if eq {$local_part}{postmaster} {yes}{no} }
10259 .endd
10260 The second string need not be present; if it is not and the condition is not
10261 true, the item is replaced with nothing. Alternatively, the word &"fail"& may
10262 be present instead of the second string (without any curly brackets). In this
10263 case, the expansion is forced to fail if the condition is not true (see section
10264 &<<SECTforexpfai>>&).
10265
10266 If both strings are omitted, the result is the string &`true`& if the condition
10267 is true, and the empty string if the condition is false. This makes it less
10268 cumbersome to write custom ACL and router conditions. For example, instead of
10269 .code
10270 condition = ${if >{$acl_m4}{3}{true}{false}}
10271 .endd
10272 you can use
10273 .code
10274 condition = ${if >{$acl_m4}{3}}
10275 .endd
10276
10277
10278
10279 .vitem &*${imapfolder{*&<&'foldername'&>&*}}*&
10280 .cindex expansion "imap folder"
10281 .cindex "&%imapfolder%& expansion item"
10282 This item converts a (possibly multilevel, or with non-ASCII characters)
10283 folder specification to a Maildir name for filesystem use.
10284 For information on internationalisation support see &<<SECTi18nMDA>>&.
10285
10286
10287
10288 .vitem &*${length{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
10289 .cindex "expansion" "string truncation"
10290 .cindex "&%length%& expansion item"
10291 The &%length%& item is used to extract the initial portion of a string. Both
10292 strings are expanded, and the first one must yield a number, <&'n'&>, say. If
10293 you are using a fixed value for the number, that is, if <&'string1'&> does not
10294 change when expanded, you can use the simpler operator notation that avoids
10295 some of the braces:
10296 .code
10297 ${length_<n>:<string>}
10298 .endd
10299 The result of this item is either the first <&'n'&> bytes or the whole
10300 of <&'string2'&>, whichever is the shorter. Do not confuse &%length%& with
10301 &%strlen%&, which gives the length of a string.
10302 All measurement is done in bytes and is not UTF-8 aware.
10303
10304
10305 .vitem "&*${listextract{*&<&'number'&>&*}&&&
10306         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
10307 .cindex "expansion" "extracting list elements by number"
10308 .cindex "&%listextract%&" "extract list elements by number"
10309 .cindex "list" "extracting elements by number"
10310 The <&'number'&> argument must consist entirely of decimal digits,
10311 apart from an optional leading minus,
10312 and leading and trailing white space (which is ignored).
10313
10314 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
10315 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10316
10317 The first field of the list is numbered one.
10318 If the number is negative, the fields are
10319 counted from the end of the list, with the rightmost one numbered -1.
10320 The numbered element of the list is extracted and placed in &$value$&,
10321 then <&'string2'&> is expanded as the result.
10322
10323 If the modulus of the
10324 number is zero or greater than the number of fields in the string,
10325 the result is the expansion of <&'string3'&>.
10326
10327 For example:
10328 .code
10329 ${listextract{2}{x:42:99}}
10330 .endd
10331 yields &"42"&, and
10332 .code
10333 ${listextract{-3}{<, x,42,99,& Mailer,,/bin/bash}{result: $value}}
10334 .endd
10335 yields &"result: 42"&.
10336
10337 If {<&'string3'&>} is omitted, an empty string is used for string3.
10338 If {<&'string2'&>} is also omitted, the value that was
10339 extracted is used.
10340 You can use &`fail`& instead of {<&'string3'&>} as in a string extract.
10341
10342
10343 .new
10344 .vitem &*${listquote{*&<&'separator'&>&*}{*&<&'string'&>&*}}*&
10345 .cindex quoting "for list"
10346 .cindex list quoting
10347 This item doubles any occurrence of the separator character
10348 in the given string.
10349 An empty string is replaced with a single space.
10350 This converts the string into a safe form for use as a list element,
10351 in a list using the given separator.
10352 .wen
10353
10354
10355 .vitem "&*${lookup&~{*&<&'key'&>&*}&~*&<&'search&~type'&>&*&~&&&
10356         {*&<&'file'&>&*}&~{*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&" &&&
10357        "&*${lookup&~*&<&'search&~type'&>&*&~{*&<&'query'&>&*}&~&&&
10358         {*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
10359 .cindex "expansion" "lookup in"
10360 .cindex "file" "lookups"
10361 .cindex "lookup" "in expanded string"
10362 The two forms of lookup item specify data lookups in files and databases, as
10363 discussed in chapter &<<CHAPfdlookup>>&. The first form is used for single-key
10364 lookups, and the second is used for query-style lookups. The <&'key'&>,
10365 <&'file'&>, and <&'query'&> strings are expanded before use.
10366
10367 If there is any white space in a lookup item which is part of a filter command,
10368 a retry or rewrite rule, a routing rule for the &(manualroute)& router, or any
10369 other place where white space is significant, the lookup item must be enclosed
10370 in double quotes. The use of data lookups in users' filter files may be locked
10371 out by the system administrator.
10372
10373 .vindex "&$value$&"
10374 If the lookup succeeds, <&'string1'&> is expanded and replaces the entire item.
10375 During its expansion, the variable &$value$& contains the data returned by the
10376 lookup. Afterwards it reverts to the value it had previously (at the outer
10377 level it is empty). If the lookup fails, <&'string2'&> is expanded and replaces
10378 the entire item. If {<&'string2'&>} is omitted, the replacement is the empty
10379 string on failure. If <&'string2'&> is provided, it can itself be a nested
10380 lookup, thus providing a mechanism for looking up a default value when the
10381 original lookup fails.
10382
10383 If a nested lookup is used as part of <&'string1'&>, &$value$& contains the
10384 data for the outer lookup while the parameters of the second lookup are
10385 expanded, and also while <&'string2'&> of the second lookup is expanded, should
10386 the second lookup fail. Instead of {<&'string2'&>} the word &"fail"& can
10387 appear, and in this case, if the lookup fails, the entire expansion is forced
10388 to fail (see section &<<SECTforexpfai>>&). If both {<&'string1'&>} and
10389 {<&'string2'&>} are omitted, the result is the looked up value in the case of a
10390 successful lookup, and nothing in the case of failure.
10391
10392 For single-key lookups, the string &"partial"& is permitted to precede the
10393 search type in order to do partial matching, and * or *@ may follow a search
10394 type to request default lookups if the key does not match (see sections
10395 &<<SECTdefaultvaluelookups>>& and &<<SECTpartiallookup>>& for details).
10396
10397 .cindex "numerical variables (&$1$& &$2$& etc)" "in lookup expansion"
10398 If a partial search is used, the variables &$1$& and &$2$& contain the wild
10399 and non-wild parts of the key during the expansion of the replacement text.
10400 They return to their previous values at the end of the lookup item.
10401
10402 This example looks up the postmaster alias in the conventional alias file:
10403 .code
10404 ${lookup {postmaster} lsearch {/etc/aliases} {$value}}
10405 .endd
10406 This example uses NIS+ to look up the full name of the user corresponding to
10407 the local part of an address, forcing the expansion to fail if it is not found:
10408 .code
10409 ${lookup nisplus {[name=$local_part],passwd.org_dir:gcos} \
10410   {$value}fail}
10411 .endd
10412
10413
10414 .vitem &*${map{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
10415 .cindex "expansion" "list creation"
10416 .vindex "&$item$&"
10417 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
10418 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10419 For each item
10420 in this list, its value is place in &$item$&, and then <&'string2'&> is
10421 expanded and added to the output as an item in a new list. The separator used
10422 for the output list is the same as the one used for the input, but a separator
10423 setting is not included in the output. For example:
10424 .code
10425 ${map{a:b:c}{[$item]}} ${map{<- x-y-z}{($item)}}
10426 .endd
10427 expands to &`[a]:[b]:[c] (x)-(y)-(z)`&. At the end of the expansion, the
10428 value of &$item$& is restored to what it was before. See also the &%filter%&
10429 and &%reduce%& expansion items.
10430
10431 .vitem &*${nhash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
10432 .cindex "expansion" "numeric hash"
10433 .cindex "hash function" "numeric"
10434 The three strings are expanded; the first two must yield numbers. Call them
10435 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
10436 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
10437 can use the simpler operator notation that avoids some of the braces:
10438 .code
10439 ${nhash_<n>_<m>:<string>}
10440 .endd
10441 The second number is optional (in both notations). If there is only one number,
10442 the result is a number in the range 0&--<&'n'&>-1. Otherwise, the string is
10443 processed by a div/mod hash function that returns two numbers, separated by a
10444 slash, in the ranges 0 to <&'n'&>-1 and 0 to <&'m'&>-1, respectively. For
10445 example,
10446 .code
10447 ${nhash{8}{64}{supercalifragilisticexpialidocious}}
10448 .endd
10449 returns the string &"6/33"&.
10450
10451
10452
10453 .vitem &*${perl{*&<&'subroutine'&>&*}{*&<&'arg'&>&*}{*&<&'arg'&>&*}...}*&
10454 .cindex "Perl" "use in expanded string"
10455 .cindex "expansion" "calling Perl from"
10456 This item is available only if Exim has been built to include an embedded Perl
10457 interpreter. The subroutine name and the arguments are first separately
10458 expanded, and then the Perl subroutine is called with those arguments. No
10459 additional arguments need be given; the maximum number permitted, including the
10460 name of the subroutine, is nine.
10461
10462 The return value of the subroutine is inserted into the expanded string, unless
10463 the return value is &%undef%&. In that case, the entire expansion is
10464 forced to fail, in the same way as an explicit &"fail"& on a lookup item
10465 does (see section &<<SECTforexpfai>>&).  Whatever you return is evaluated
10466 in a scalar context, thus the return value is a scalar.  For example, if you
10467 return a Perl vector, the return value is the size of the vector,
10468 not its contents.
10469
10470 If the subroutine exits by calling Perl's &%die%& function, the expansion fails
10471 with the error message that was passed to &%die%&. More details of the embedded
10472 Perl facility are given in chapter &<<CHAPperl>>&.
10473
10474 The &(redirect)& router has an option called &%forbid_filter_perl%& which locks
10475 out the use of this expansion item in filter files.
10476
10477
10478 .vitem &*${prvs{*&<&'address'&>&*}{*&<&'secret'&>&*}{*&<&'keynumber'&>&*}}*&
10479 .cindex "&%prvs%& expansion item"
10480 The first argument is a complete email address and the second is secret
10481 keystring. The third argument, specifying a key number, is optional. If absent,
10482 it defaults to 0. The result of the expansion is a prvs-signed email address,
10483 to be typically used with the &%return_path%& option on an &(smtp)& transport
10484 as part of a bounce address tag validation (BATV) scheme. For more discussion
10485 and an example, see section &<<SECTverifyPRVS>>&.
10486
10487 .vitem "&*${prvscheck{*&<&'address'&>&*}{*&<&'secret'&>&*}&&&
10488         {*&<&'string'&>&*}}*&"
10489 .cindex "&%prvscheck%& expansion item"
10490 This expansion item is the complement of the &%prvs%& item. It is used for
10491 checking prvs-signed addresses. If the expansion of the first argument does not
10492 yield a syntactically valid prvs-signed address, the whole item expands to the
10493 empty string. When the first argument does expand to a syntactically valid
10494 prvs-signed address, the second argument is expanded, with the prvs-decoded
10495 version of the address and the key number extracted from the address in the
10496 variables &$prvscheck_address$& and &$prvscheck_keynum$&, respectively.
10497
10498 These two variables can be used in the expansion of the second argument to
10499 retrieve the secret. The validity of the prvs-signed address is then checked
10500 against the secret. The result is stored in the variable &$prvscheck_result$&,
10501 which is empty for failure or &"1"& for success.
10502
10503 The third argument is optional; if it is missing, it defaults to an empty
10504 string. This argument is now expanded. If the result is an empty string, the
10505 result of the expansion is the decoded version of the address. This is the case
10506 whether or not the signature was valid. Otherwise, the result of the expansion
10507 is the expansion of the third argument.
10508
10509 All three variables can be used in the expansion of the third argument.
10510 However, once the expansion is complete, only &$prvscheck_result$& remains set.
10511 For more discussion and an example, see section &<<SECTverifyPRVS>>&.
10512
10513 .vitem &*${readfile{*&<&'file&~name'&>&*}{*&<&'eol&~string'&>&*}}*&
10514 .cindex "expansion" "inserting an entire file"
10515 .cindex "file" "inserting into expansion"
10516 .cindex "&%readfile%& expansion item"
10517 The filename and end-of-line (eol) string are first expanded separately. The file is
10518 then read, and its contents replace the entire item. All newline characters in
10519 the file are replaced by the end-of-line string if it is present. Otherwise,
10520 newlines are left in the string.
10521 String expansion is not applied to the contents of the file. If you want this,
10522 you must wrap the item in an &%expand%& operator. If the file cannot be read,
10523 the string expansion fails.
10524
10525 The &(redirect)& router has an option called &%forbid_filter_readfile%& which
10526 locks out the use of this expansion item in filter files.
10527
10528
10529
10530 .vitem "&*${readsocket{*&<&'name'&>&*}{*&<&'request'&>&*}&&&
10531         {*&<&'options'&>&*}{*&<&'eol&~string'&>&*}{*&<&'fail&~string'&>&*}}*&"
10532 .cindex "expansion" "inserting from a socket"
10533 .cindex "socket, use of in expansion"
10534 .cindex "&%readsocket%& expansion item"
10535 This item inserts data from a Unix domain or TCP socket into the expanded
10536 string. The minimal way of using it uses just two arguments, as in these
10537 examples:
10538 .code
10539 ${readsocket{/socket/name}{request string}}
10540 ${readsocket{inet:some.host:1234}{request string}}
10541 .endd
10542 For a Unix domain socket, the first substring must be the path to the socket.
10543 For an Internet socket, the first substring must contain &`inet:`& followed by
10544 a host name or IP address, followed by a colon and a port, which can be a
10545 number or the name of a TCP port in &_/etc/services_&. An IP address may
10546 optionally be enclosed in square brackets. This is best for IPv6 addresses. For
10547 example:
10548 .code
10549 ${readsocket{inet:[::1]:1234}{request string}}
10550 .endd
10551 Only a single host name may be given, but if looking it up yields more than
10552 one IP address, they are each tried in turn until a connection is made. For
10553 both kinds of socket, Exim makes a connection, writes the request string
10554 (unless it is an empty string; no terminating NUL is ever sent)
10555 and reads from the socket until an end-of-file
10556 is read. A timeout of 5 seconds is applied. Additional, optional arguments
10557 extend what can be done. Firstly, you can vary the timeout. For example:
10558 .code
10559 ${readsocket{/socket/name}{request string}{3s}}
10560 .endd
10561
10562 The third argument is a list of options, of which the first element is the timeout
10563 and must be present if any options are given.
10564 Further elements are options of form &'name=value'&.
10565 Example:
10566 .code
10567 ${readsocket{/socket/name}{request string}{3s:shutdown=no}}
10568 .endd
10569
10570 The following option names are recognised:
10571 .ilist
10572 &*cache*&
10573 Defines if the result data can be cached for use by a later identical
10574 request in the same process.
10575 Values are &"yes"& or &"no"& (the default).
10576 If not, all cached results for this connection specification
10577 will be invalidated.
10578
10579 .next
10580 &*shutdown*&
10581 Defines whether or not a write-shutdown is done on the connection after
10582 sending the request. Values are &"yes"& (the default) or &"no"&
10583 (preferred, eg. by some webservers).
10584
10585 .next
10586 &*tls*&
10587 Controls the use of TLS on the connection.
10588 Values are &"yes"& or &"no"& (the default).
10589 If it is enabled, a shutdown as descripbed above is never done.
10590 .endlist
10591
10592
10593 A fourth argument allows you to change any newlines that are in the data
10594 that is read, in the same way as for &%readfile%& (see above). This example
10595 turns them into spaces:
10596 .code
10597 ${readsocket{inet:127.0.0.1:3294}{request string}{3s}{ }}
10598 .endd
10599 As with all expansions, the substrings are expanded before the processing
10600 happens. Errors in these sub-expansions cause the expansion to fail. In
10601 addition, the following errors can occur:
10602
10603 .ilist
10604 Failure to create a socket file descriptor;
10605 .next
10606 Failure to connect the socket;
10607 .next
10608 Failure to write the request string;
10609 .next
10610 Timeout on reading from the socket.
10611 .endlist
10612
10613 By default, any of these errors causes the expansion to fail. However, if
10614 you supply a fifth substring, it is expanded and used when any of the above
10615 errors occurs. For example:
10616 .code
10617 ${readsocket{/socket/name}{request string}{3s}{\n}\
10618   {socket failure}}
10619 .endd
10620 You can test for the existence of a Unix domain socket by wrapping this
10621 expansion in &`${if exists`&, but there is a race condition between that test
10622 and the actual opening of the socket, so it is safer to use the fifth argument
10623 if you want to be absolutely sure of avoiding an expansion error for a
10624 non-existent Unix domain socket, or a failure to connect to an Internet socket.
10625
10626 The &(redirect)& router has an option called &%forbid_filter_readsocket%& which
10627 locks out the use of this expansion item in filter files.
10628
10629
10630 .vitem &*${reduce{*&<&'string1'&>}{<&'string2'&>&*}{*&<&'string3'&>&*}}*&
10631 .cindex "expansion" "reducing a list to a scalar"
10632 .cindex "list" "reducing to a scalar"
10633 .vindex "&$value$&"
10634 .vindex "&$item$&"
10635 This operation reduces a list to a single, scalar string. After expansion,
10636 <&'string1'&> is interpreted as a list, colon-separated by default, but the
10637 separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10638 Then <&'string2'&> is expanded and
10639 assigned to the &$value$& variable. After this, each item in the <&'string1'&>
10640 list is assigned to &$item$&, in turn, and <&'string3'&> is expanded for each of
10641 them. The result of that expansion is assigned to &$value$& before the next
10642 iteration. When the end of the list is reached, the final value of &$value$& is
10643 added to the expansion output. The &%reduce%& expansion item can be used in a
10644 number of ways. For example, to add up a list of numbers:
10645 .code
10646 ${reduce {<, 1,2,3}{0}{${eval:$value+$item}}}
10647 .endd
10648 The result of that expansion would be &`6`&. The maximum of a list of numbers
10649 can be found:
10650 .code
10651 ${reduce {3:0:9:4:6}{0}{${if >{$item}{$value}{$item}{$value}}}}
10652 .endd
10653 At the end of a &*reduce*& expansion, the values of &$item$& and &$value$& are
10654 restored to what they were before. See also the &%filter%& and &%map%&
10655 expansion items.
10656
10657 .vitem &*$rheader_*&<&'header&~name'&>&*:*&&~or&~&*$rh_*&<&'header&~name'&>&*:*&
10658 This item inserts &"raw"& header lines. It is described with the &%header%&
10659 expansion item in section &<<SECTexpansionitems>>& above.
10660
10661 .vitem "&*${run{*&<&'command'&>&*&~*&<&'args'&>&*}{*&<&'string1'&>&*}&&&
10662         {*&<&'string2'&>&*}}*&"
10663 .cindex "expansion" "running a command"
10664 .cindex "&%run%& expansion item"
10665 The command and its arguments are first expanded as one string. The string is
10666 split apart into individual arguments by spaces, and then the command is run
10667 in a separate process, but under the same uid and gid.  As in other command
10668 executions from Exim, a shell is not used by default. If the command requires
10669 a shell, you must explicitly code it.
10670
10671 Since the arguments are split by spaces, when there is a variable expansion
10672 which has an empty result, it will cause the situation that the argument will
10673 simply be omitted when the program is actually executed by Exim. If the
10674 script/program requires a specific number of arguments and the expanded
10675 variable could possibly result in this empty expansion, the variable must be
10676 quoted. This is more difficult if the expanded variable itself could result
10677 in a string containing quotes, because it would interfere with the quotes
10678 around the command arguments. A possible guard against this is to wrap the
10679 variable in the &%sg%& operator to change any quote marks to some other
10680 character.
10681
10682 The standard input for the command exists, but is empty. The standard output
10683 and standard error are set to the same file descriptor.
10684 .cindex "return code" "from &%run%& expansion"
10685 .vindex "&$value$&"
10686 If the command succeeds (gives a zero return code) <&'string1'&> is expanded
10687 and replaces the entire item; during this expansion, the standard output/error
10688 from the command is in the variable &$value$&. If the command fails,
10689 <&'string2'&>, if present, is expanded and used. Once again, during the
10690 expansion, the standard output/error from the command is in the variable
10691 &$value$&.
10692
10693 If <&'string2'&> is absent, the result is empty. Alternatively, <&'string2'&>
10694 can be the word &"fail"& (not in braces) to force expansion failure if the
10695 command does not succeed. If both strings are omitted, the result is contents
10696 of the standard output/error on success, and nothing on failure.
10697
10698 .vindex "&$run_in_acl$&"
10699 The standard output/error of the command is put in the variable &$value$&.
10700 In this ACL example, the output of a command is logged for the admin to
10701 troubleshoot:
10702 .code
10703 warn  condition    = ${run{/usr/bin/id}{yes}{no}}
10704       log_message  = Output of id: $value
10705 .endd
10706 If the command requires shell idioms, such as the > redirect operator, the
10707 shell must be invoked directly, such as with:
10708 .code
10709 ${run{/bin/bash -c "/usr/bin/id >/tmp/id"}{yes}{yes}}
10710 .endd
10711
10712 .vindex "&$runrc$&"
10713 The return code from the command is put in the variable &$runrc$&, and this
10714 remains set afterwards, so in a filter file you can do things like this:
10715 .code
10716 if "${run{x y z}{}}$runrc" is 1 then ...
10717   elif $runrc is 2 then ...
10718   ...
10719 endif
10720 .endd
10721 If execution of the command fails (for example, the command does not exist),
10722 the return code is 127 &-- the same code that shells use for non-existent
10723 commands.
10724
10725 &*Warning*&: In a router or transport, you cannot assume the order in which
10726 option values are expanded, except for those preconditions whose order of
10727 testing is documented. Therefore, you cannot reliably expect to set &$runrc$&
10728 by the expansion of one option, and use it in another.
10729
10730 The &(redirect)& router has an option called &%forbid_filter_run%& which locks
10731 out the use of this expansion item in filter files.
10732
10733
10734 .vitem &*${sg{*&<&'subject'&>&*}{*&<&'regex'&>&*}{*&<&'replacement'&>&*}}*&
10735 .cindex "expansion" "string substitution"
10736 .cindex "&%sg%& expansion item"
10737 This item works like Perl's substitution operator (s) with the global (/g)
10738 option; hence its name. However, unlike the Perl equivalent, Exim does not
10739 modify the subject string; instead it returns the modified string for insertion
10740 into the overall expansion. The item takes three arguments: the subject string,
10741 a regular expression, and a substitution string. For example:
10742 .code
10743 ${sg{abcdefabcdef}{abc}{xyz}}
10744 .endd
10745 yields &"xyzdefxyzdef"&. Because all three arguments are expanded before use,
10746 if any $, } or \ characters are required in the regular expression or in the
10747 substitution string, they have to be escaped. For example:
10748 .code
10749 ${sg{abcdef}{^(...)(...)\$}{\$2\$1}}
10750 .endd
10751 yields &"defabc"&, and
10752 .code
10753 ${sg{1=A 4=D 3=C}{\N(\d+)=\N}{K\$1=}}
10754 .endd
10755 yields &"K1=A K4=D K3=C"&. Note the use of &`\N`& to protect the contents of
10756 the regular expression from string expansion.
10757
10758 The regular expression is compiled in 8-bit mode, working against bytes
10759 rather than any Unicode-aware character handling.
10760
10761
10762 .vitem &*${sort{*&<&'string'&>&*}{*&<&'comparator'&>&*}{*&<&'extractor'&>&*}}*&
10763 .cindex sorting "a list"
10764 .cindex list sorting
10765 .cindex expansion "list sorting"
10766 After expansion, <&'string'&> is interpreted as a list, colon-separated by
10767 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10768 The <&'comparator'&> argument is interpreted as the operator
10769 of a two-argument expansion condition.
10770 The numeric operators plus ge, gt, le, lt (and ~i variants) are supported.
10771 The comparison should return true when applied to two values
10772 if the first value should sort before the second value.
10773 The <&'extractor'&> expansion is applied repeatedly to elements of the list,
10774 the element being placed in &$item$&,
10775 to give values for comparison.
10776
10777 The item result is a sorted list,
10778 with the original list separator,
10779 of the list elements (in full) of the original.
10780
10781 Examples:
10782 .code
10783 ${sort{3:2:1:4}{<}{$item}}
10784 .endd
10785 sorts a list of numbers, and
10786 .code
10787 ${sort {${lookup dnsdb{>:,,mx=example.com}}} {<} {${listextract{1}{<,$item}}}}
10788 .endd
10789 will sort an MX lookup into priority order.
10790
10791
10792
10793 .new
10794 .vitem &*${srs_encode&~{*&<&'secret'&>&*}{*&<&'return&~path'&>&*}{*&<&'original&~domain'&>&*}}*&
10795 SRS encoding.  See SECT &<<SECTSRS>>& for details.
10796 .wen
10797
10798
10799
10800 .vitem &*${substr{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
10801 .cindex "&%substr%& expansion item"
10802 .cindex "substring extraction"
10803 .cindex "expansion" "substring extraction"
10804 The three strings are expanded; the first two must yield numbers. Call them
10805 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
10806 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
10807 can use the simpler operator notation that avoids some of the braces:
10808 .code
10809 ${substr_<n>_<m>:<string>}
10810 .endd
10811 The second number is optional (in both notations).
10812 If it is absent in the simpler format, the preceding underscore must also be
10813 omitted.
10814
10815 The &%substr%& item can be used to extract more general substrings than
10816 &%length%&. The first number, <&'n'&>, is a starting offset, and <&'m'&> is the
10817 length required. For example
10818 .code
10819 ${substr{3}{2}{$local_part}}
10820 .endd
10821 If the starting offset is greater than the string length the result is the
10822 null string; if the length plus starting offset is greater than the string
10823 length, the result is the right-hand part of the string, starting from the
10824 given offset. The first byte (character) in the string has offset zero.
10825
10826 The &%substr%& expansion item can take negative offset values to count
10827 from the right-hand end of its operand. The last byte (character) is offset -1,
10828 the second-last is offset -2, and so on. Thus, for example,
10829 .code
10830 ${substr{-5}{2}{1234567}}
10831 .endd
10832 yields &"34"&. If the absolute value of a negative offset is greater than the
10833 length of the string, the substring starts at the beginning of the string, and
10834 the length is reduced by the amount of overshoot. Thus, for example,
10835 .code
10836 ${substr{-5}{2}{12}}
10837 .endd
10838 yields an empty string, but
10839 .code
10840 ${substr{-3}{2}{12}}
10841 .endd
10842 yields &"1"&.
10843
10844 When the second number is omitted from &%substr%&, the remainder of the string
10845 is taken if the offset is positive. If it is negative, all bytes (characters) in the
10846 string preceding the offset point are taken. For example, an offset of -1 and
10847 no length, as in these semantically identical examples:
10848 .code
10849 ${substr_-1:abcde}
10850 ${substr{-1}{abcde}}
10851 .endd
10852 yields all but the last character of the string, that is, &"abcd"&.
10853
10854 All measurement is done in bytes and is not UTF-8 aware.
10855
10856
10857
10858 .vitem "&*${tr{*&<&'subject'&>&*}{*&<&'characters'&>&*}&&&
10859         {*&<&'replacements'&>&*}}*&"
10860 .cindex "expansion" "character translation"
10861 .cindex "&%tr%& expansion item"
10862 This item does single-character (in bytes) translation on its subject string. The second
10863 argument is a list of characters to be translated in the subject string. Each
10864 matching character is replaced by the corresponding character from the
10865 replacement list. For example
10866 .code
10867 ${tr{abcdea}{ac}{13}}
10868 .endd
10869 yields &`1b3de1`&. If there are duplicates in the second character string, the
10870 last occurrence is used. If the third string is shorter than the second, its
10871 last character is replicated. However, if it is empty, no translation takes
10872 place.
10873
10874 All character handling is done in bytes and is not UTF-8 aware.
10875
10876 .endlist
10877
10878
10879
10880 .section "Expansion operators" "SECTexpop"
10881 .cindex "expansion" "operators"
10882 For expansion items that perform transformations on a single argument string,
10883 the &"operator"& notation is used because it is simpler and uses fewer braces.
10884 The substring is first expanded before the operation is applied to it. The
10885 following operations can be performed:
10886
10887 .vlist
10888 .vitem &*${address:*&<&'string'&>&*}*&
10889 .cindex "expansion" "RFC 2822 address handling"
10890 .cindex "&%address%& expansion item"
10891 The string is interpreted as an RFC 2822 address, as it might appear in a
10892 header line, and the effective address is extracted from it. If the string does
10893 not parse successfully, the result is empty.
10894
10895 The parsing correctly handles SMTPUTF8 Unicode in the string.
10896
10897
10898 .vitem &*${addresses:*&<&'string'&>&*}*&
10899 .cindex "expansion" "RFC 2822 address handling"
10900 .cindex "&%addresses%& expansion item"
10901 The string (after expansion) is interpreted as a list of addresses in RFC
10902 2822 format, such as can be found in a &'To:'& or &'Cc:'& header line. The
10903 operative address (&'local-part@domain'&) is extracted from each item, and the
10904 result of the expansion is a colon-separated list, with appropriate
10905 doubling of colons should any happen to be present in the email addresses.
10906 Syntactically invalid RFC2822 address items are omitted from the output.
10907
10908 It is possible to specify a character other than colon for the output
10909 separator by starting the string with > followed by the new separator
10910 character. For example:
10911 .code
10912 ${addresses:>& Chief <ceo@up.stairs>, sec@base.ment (dogsbody)}
10913 .endd
10914 expands to &`ceo@up.stairs&&sec@base.ment`&. The string is expanded
10915 first, so if the expanded string starts with >, it may change the output
10916 separator unintentionally. This can be avoided by setting the output
10917 separator explicitly:
10918 .code
10919 ${addresses:>:$h_from:}
10920 .endd
10921
10922 Compare the &%address%& (singular)
10923 expansion item, which extracts the working address from a single RFC2822
10924 address. See the &%filter%&, &%map%&, and &%reduce%& items for ways of
10925 processing lists.
10926
10927 To clarify "list of addresses in RFC 2822 format" mentioned above, Exim follows
10928 a strict interpretation of header line formatting.  Exim parses the bare,
10929 unquoted portion of an email address and if it finds a comma, treats it as an
10930 email address separator. For the example header line:
10931 .code
10932 From: =?iso-8859-2?Q?Last=2C_First?= <user@example.com>
10933 .endd
10934 The first example below demonstrates that Q-encoded email addresses are parsed
10935 properly if it is given the raw header (in this example, &`$rheader_from:`&).
10936 It does not see the comma because it's still encoded as "=2C".  The second
10937 example below is passed the contents of &`$header_from:`&, meaning it gets
10938 de-mimed. Exim sees the decoded "," so it treats it as &*two*& email addresses.
10939 The third example shows that the presence of a comma is skipped when it is
10940 quoted.  The fourth example shows SMTPUTF8 handling.
10941 .code
10942 # exim -be '${addresses:From: \
10943 =?iso-8859-2?Q?Last=2C_First?= <user@example.com>}'
10944 user@example.com
10945 # exim -be '${addresses:From: Last, First <user@example.com>}'
10946 Last:user@example.com
10947 # exim -be '${addresses:From: "Last, First" <user@example.com>}'
10948 user@example.com
10949 # exim -be '${addresses:フィル <フィリップ@example.jp>}'
10950 フィリップ@example.jp
10951 .endd
10952
10953 .vitem &*${base32:*&<&'digits'&>&*}*&
10954 .cindex "&%base32%& expansion item"
10955 .cindex "expansion" "conversion to base 32"
10956 The string must consist entirely of decimal digits. The number is converted to
10957 base 32 and output as a (empty, for zero) string of characters.
10958 Only lowercase letters are used.
10959
10960 .vitem &*${base32d:*&<&'base-32&~digits'&>&*}*&
10961 .cindex "&%base32d%& expansion item"
10962 .cindex "expansion" "conversion to base 32"
10963 The string must consist entirely of base-32 digits.
10964 The number is converted to decimal and output as a string.
10965
10966 .vitem &*${base62:*&<&'digits'&>&*}*&
10967 .cindex "&%base62%& expansion item"
10968 .cindex "expansion" "conversion to base 62"
10969 The string must consist entirely of decimal digits. The number is converted to
10970 base 62 and output as a string of six characters, including leading zeros. In
10971 the few operating environments where Exim uses base 36 instead of base 62 for
10972 its message identifiers (because those systems do not have case-sensitive
10973 filenames), base 36 is used by this operator, despite its name. &*Note*&: Just
10974 to be absolutely clear: this is &'not'& base64 encoding.
10975
10976 .vitem &*${base62d:*&<&'base-62&~digits'&>&*}*&
10977 .cindex "&%base62d%& expansion item"
10978 .cindex "expansion" "conversion to base 62"
10979 The string must consist entirely of base-62 digits, or, in operating
10980 environments where Exim uses base 36 instead of base 62 for its message
10981 identifiers, base-36 digits. The number is converted to decimal and output as a
10982 string.
10983
10984 .vitem &*${base64:*&<&'string'&>&*}*&
10985 .cindex "expansion" "base64 encoding"
10986 .cindex "base64 encoding" "in string expansion"
10987 .cindex "&%base64%& expansion item"
10988 .cindex certificate "base64 of DER"
10989 This operator converts a string into one that is base64 encoded.
10990
10991 If the string is a single variable of type certificate,
10992 returns the base64 encoding of the DER form of the certificate.
10993
10994
10995 .vitem &*${base64d:*&<&'string'&>&*}*&
10996 .cindex "expansion" "base64 decoding"
10997 .cindex "base64 decoding" "in string expansion"
10998 .cindex "&%base64d%& expansion item"
10999 This operator converts a base64-encoded string into the un-coded form.
11000
11001
11002 .vitem &*${domain:*&<&'string'&>&*}*&
11003 .cindex "domain" "extraction"
11004 .cindex "expansion" "domain extraction"
11005 The string is interpreted as an RFC 2822 address and the domain is extracted
11006 from it. If the string does not parse successfully, the result is empty.
11007
11008
11009 .vitem &*${escape:*&<&'string'&>&*}*&
11010 .cindex "expansion" "escaping non-printing characters"
11011 .cindex "&%escape%& expansion item"
11012 If the string contains any non-printing characters, they are converted to
11013 escape sequences starting with a backslash. Whether characters with the most
11014 significant bit set (so-called &"8-bit characters"&) count as printing or not
11015 is controlled by the &%print_topbitchars%& option.
11016
11017 .vitem &*${escape8bit:*&<&'string'&>&*}*&
11018 .cindex "expansion" "escaping 8-bit characters"
11019 .cindex "&%escape8bit%& expansion item"
11020 If the string contains any characters with the most significant bit set,
11021 they are converted to escape sequences starting with a backslash.
11022 Backslashes and DEL characters are also converted.
11023
11024
11025 .vitem &*${eval:*&<&'string'&>&*}*&&~and&~&*${eval10:*&<&'string'&>&*}*&
11026 .cindex "expansion" "expression evaluation"
11027 .cindex "expansion" "arithmetic expression"
11028 .cindex "&%eval%& expansion item"
11029 These items supports simple arithmetic and bitwise logical operations in
11030 expansion strings. The string (after expansion) must be a conventional
11031 arithmetic expression, but it is limited to basic arithmetic operators, bitwise
11032 logical operators, and parentheses. All operations are carried out using
11033 integer arithmetic. The operator priorities are as follows (the same as in the
11034 C programming language):
11035 .table2 70pt 300pt
11036 .irow &'highest:'& "not (~), negate (-)"
11037 .irow ""   "multiply (*), divide (/), remainder (%)"
11038 .irow ""   "plus (+), minus (-)"
11039 .irow ""   "shift-left (<<), shift-right (>>)"
11040 .irow ""   "and (&&)"
11041 .irow ""   "xor (^)"
11042 .irow &'lowest:'&  "or (|)"
11043 .endtable
11044 Binary operators with the same priority are evaluated from left to right. White
11045 space is permitted before or after operators.
11046
11047 For &%eval%&, numbers may be decimal, octal (starting with &"0"&) or
11048 hexadecimal (starting with &"0x"&). For &%eval10%&, all numbers are taken as
11049 decimal, even if they start with a leading zero; hexadecimal numbers are not
11050 permitted. This can be useful when processing numbers extracted from dates or
11051 times, which often do have leading zeros.
11052
11053 A number may be followed by &"K"&, &"M"& or &"G"& to multiply it by 1024, 1024*1024
11054 or 1024*1024*1024,
11055 respectively. Negative numbers are supported. The result of the computation is
11056 a decimal representation of the answer (without &"K"&, &"M"& or &"G"&). For example:
11057
11058 .display
11059 &`${eval:1+1}            `&  yields 2
11060 &`${eval:1+2*3}          `&  yields 7
11061 &`${eval:(1+2)*3}        `&  yields 9
11062 &`${eval:2+42%5}         `&  yields 4
11063 &`${eval:0xc&amp;5}          `&  yields 4
11064 &`${eval:0xc|5}          `&  yields 13
11065 &`${eval:0xc^5}          `&  yields 9
11066 &`${eval:0xc>>1}         `&  yields 6
11067 &`${eval:0xc<<1}         `&  yields 24
11068 &`${eval:~255&amp;0x1234}    `&  yields 4608
11069 &`${eval:-(~255&amp;0x1234)} `&  yields -4608
11070 .endd
11071
11072 As a more realistic example, in an ACL you might have
11073 .code
11074 deny   condition =                    \
11075          ${if and {                   \
11076            {>{$rcpt_count}{10}}       \
11077            {                          \
11078            <                          \
11079              {$recipients_count}      \
11080              {${eval:$rcpt_count/2}}  \
11081            }                          \
11082          }{yes}{no}}
11083        message = Too many bad recipients
11084 .endd
11085 The condition is true if there have been more than 10 RCPT commands and
11086 fewer than half of them have resulted in a valid recipient.
11087
11088
11089 .vitem &*${expand:*&<&'string'&>&*}*&
11090 .cindex "expansion" "re-expansion of substring"
11091 The &%expand%& operator causes a string to be expanded for a second time. For
11092 example,
11093 .code
11094 ${expand:${lookup{$domain}dbm{/some/file}{$value}}}
11095 .endd
11096 first looks up a string in a file while expanding the operand for &%expand%&,
11097 and then re-expands what it has found.
11098
11099
11100 .vitem &*${from_utf8:*&<&'string'&>&*}*&
11101 .cindex "Unicode"
11102 .cindex "UTF-8" "conversion from"
11103 .cindex "expansion" "UTF-8 conversion"
11104 .cindex "&%from_utf8%& expansion item"
11105 The world is slowly moving towards Unicode, although there are no standards for
11106 email yet. However, other applications (including some databases) are starting
11107 to store data in Unicode, using UTF-8 encoding. This operator converts from a
11108 UTF-8 string to an ISO-8859-1 string. UTF-8 code values greater than 255 are
11109 converted to underscores. The input must be a valid UTF-8 string. If it is not,
11110 the result is an undefined sequence of bytes.
11111
11112 Unicode code points with values less than 256 are compatible with ASCII and
11113 ISO-8859-1 (also known as Latin-1).
11114 For example, character 169 is the copyright symbol in both cases, though the
11115 way it is encoded is different. In UTF-8, more than one byte is needed for
11116 characters with code values greater than 127, whereas ISO-8859-1 is a
11117 single-byte encoding (but thereby limited to 256 characters). This makes
11118 translation from UTF-8 to ISO-8859-1 straightforward.
11119
11120
11121 .vitem &*${hash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
11122 .cindex "hash function" "textual"
11123 .cindex "expansion" "textual hash"
11124 The &%hash%& operator is a simpler interface to the hashing function that can
11125 be used when the two parameters are fixed numbers (as opposed to strings that
11126 change when expanded). The effect is the same as
11127 .code
11128 ${hash{<n>}{<m>}{<string>}}
11129 .endd
11130 See the description of the general &%hash%& item above for details. The
11131 abbreviation &%h%& can be used when &%hash%& is used as an operator.
11132
11133
11134
11135 .vitem &*${hex2b64:*&<&'hexstring'&>&*}*&
11136 .cindex "base64 encoding" "conversion from hex"
11137 .cindex "expansion" "hex to base64"
11138 .cindex "&%hex2b64%& expansion item"
11139 This operator converts a hex string into one that is base64 encoded. This can
11140 be useful for processing the output of the various hashing functions.
11141
11142
11143
11144 .vitem &*${hexquote:*&<&'string'&>&*}*&
11145 .cindex "quoting" "hex-encoded unprintable characters"
11146 .cindex "&%hexquote%& expansion item"
11147 This operator converts non-printable characters in a string into a hex
11148 escape form. Byte values between 33 (!) and 126 (~) inclusive are left
11149 as is, and other byte values are converted to &`\xNN`&, for example, a
11150 byte value 127 is converted to &`\x7f`&.
11151
11152
11153 .vitem &*${ipv6denorm:*&<&'string'&>&*}*&
11154 .cindex "&%ipv6denorm%& expansion item"
11155 .cindex "IP address" normalisation
11156 This expands an IPv6 address to a full eight-element colon-separated set
11157 of hex digits including leading zeroes.
11158 A trailing ipv4-style dotted-decimal set is converted to hex.
11159 Pure IPv4 addresses are converted to IPv4-mapped IPv6.
11160
11161 .vitem &*${ipv6norm:*&<&'string'&>&*}*&
11162 .cindex "&%ipv6norm%& expansion item"
11163 .cindex "IP address" normalisation
11164 .cindex "IP address" "canonical form"
11165 This converts an IPv6 address to canonical form.
11166 Leading zeroes of groups are omitted, and the longest
11167 set of zero-valued groups is replaced with a double colon.
11168 A trailing ipv4-style dotted-decimal set is converted to hex.
11169 Pure IPv4 addresses are converted to IPv4-mapped IPv6.
11170
11171
11172 .vitem &*${lc:*&<&'string'&>&*}*&
11173 .cindex "case forcing in strings"
11174 .cindex "string" "case forcing"
11175 .cindex "lower casing"
11176 .cindex "expansion" "case forcing"
11177 .cindex "&%lc%& expansion item"
11178 This forces the letters in the string into lower-case, for example:
11179 .code
11180 ${lc:$local_part}
11181 .endd
11182 Case is defined per the system C locale.
11183
11184 .vitem &*${length_*&<&'number'&>&*:*&<&'string'&>&*}*&
11185 .cindex "expansion" "string truncation"
11186 .cindex "&%length%& expansion item"
11187 The &%length%& operator is a simpler interface to the &%length%& function that
11188 can be used when the parameter is a fixed number (as opposed to a string that
11189 changes when expanded). The effect is the same as
11190 .code
11191 ${length{<number>}{<string>}}
11192 .endd
11193 See the description of the general &%length%& item above for details. Note that
11194 &%length%& is not the same as &%strlen%&. The abbreviation &%l%& can be used
11195 when &%length%& is used as an operator.
11196 All measurement is done in bytes and is not UTF-8 aware.
11197
11198
11199 .vitem &*${listcount:*&<&'string'&>&*}*&
11200 .cindex "expansion" "list item count"
11201 .cindex "list" "item count"
11202 .cindex "list" "count of items"
11203 .cindex "&%listcount%& expansion item"
11204 The string is interpreted as a list and the number of items is returned.
11205
11206
11207 .vitem &*${listnamed:*&<&'name'&>&*}*&&~and&~&*${listnamed_*&<&'type'&>&*:*&<&'name'&>&*}*&
11208 .cindex "expansion" "named list"
11209 .cindex "&%listnamed%& expansion item"
11210 The name is interpreted as a named list and the content of the list is returned,
11211 expanding any referenced lists, re-quoting as needed for colon-separation.
11212 If the optional type is given it must be one of "a", "d", "h" or "l"
11213 and selects address-, domain-, host- or localpart- lists to search among respectively.
11214 Otherwise all types are searched in an undefined order and the first
11215 matching list is returned.
11216 .new
11217 &*Note*&: Neither string-expansion of lists referenced by named-list syntax elements,
11218 nor expansion of lookup elements, is done by the &%listnamed%& operator.
11219 .wen
11220
11221
11222 .vitem &*${local_part:*&<&'string'&>&*}*&
11223 .cindex "expansion" "local part extraction"
11224 .cindex "&%local_part%& expansion item"
11225 The string is interpreted as an RFC 2822 address and the local part is
11226 extracted from it. If the string does not parse successfully, the result is
11227 empty.
11228 The parsing correctly handles SMTPUTF8 Unicode in the string.
11229
11230
11231 .vitem &*${mask:*&<&'IP&~address'&>&*/*&<&'bit&~count'&>&*}*&
11232 .cindex "masked IP address"
11233 .cindex "IP address" "masking"
11234 .cindex "CIDR notation"
11235 .cindex "expansion" "IP address masking"
11236 .cindex "&%mask%& expansion item"
11237 If the form of the string to be operated on is not an IP address followed by a
11238 slash and an integer (that is, a network address in CIDR notation), the
11239 expansion fails. Otherwise, this operator converts the IP address to binary,
11240 masks off the least significant bits according to the bit count, and converts
11241 the result back to text, with mask appended. For example,
11242 .code
11243 ${mask:10.111.131.206/28}
11244 .endd
11245 returns the string &"10.111.131.192/28"&. Since this operation is expected to
11246 be mostly used for looking up masked addresses in files, the result for an IPv6
11247 address uses dots to separate components instead of colons, because colon
11248 terminates a key string in lsearch files. So, for example,
11249 .code
11250 ${mask:3ffe:ffff:836f:0a00:000a:0800:200a:c031/99}
11251 .endd
11252 returns the string
11253 .code
11254 3ffe.ffff.836f.0a00.000a.0800.2000.0000/99
11255 .endd
11256 Letters in IPv6 addresses are always output in lower case.
11257
11258
11259 .vitem &*${md5:*&<&'string'&>&*}*&
11260 .cindex "MD5 hash"
11261 .cindex "expansion" "MD5 hash"
11262 .cindex certificate fingerprint
11263 .cindex "&%md5%& expansion item"
11264 The &%md5%& operator computes the MD5 hash value of the string, and returns it
11265 as a 32-digit hexadecimal number, in which any letters are in lower case.
11266
11267 If the string is a single variable of type certificate,
11268 returns the MD5 hash fingerprint of the certificate.
11269
11270
11271 .vitem &*${nhash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
11272 .cindex "expansion" "numeric hash"
11273 .cindex "hash function" "numeric"
11274 The &%nhash%& operator is a simpler interface to the numeric hashing function
11275 that can be used when the two parameters are fixed numbers (as opposed to
11276 strings that change when expanded). The effect is the same as
11277 .code
11278 ${nhash{<n>}{<m>}{<string>}}
11279 .endd
11280 See the description of the general &%nhash%& item above for details.
11281
11282
11283 .vitem &*${quote:*&<&'string'&>&*}*&
11284 .cindex "quoting" "in string expansions"
11285 .cindex "expansion" "quoting"
11286 .cindex "&%quote%& expansion item"
11287 The &%quote%& operator puts its argument into double quotes if it
11288 is an empty string or
11289 contains anything other than letters, digits, underscores, dots, and hyphens.
11290 Any occurrences of double quotes and backslashes are escaped with a backslash.
11291 Newlines and carriage returns are converted to &`\n`& and &`\r`&,
11292 respectively For example,
11293 .code
11294 ${quote:ab"*"cd}
11295 .endd
11296 becomes
11297 .code
11298 "ab\"*\"cd"
11299 .endd
11300 The place where this is useful is when the argument is a substitution from a
11301 variable or a message header.
11302
11303 .vitem &*${quote_local_part:*&<&'string'&>&*}*&
11304 .cindex "&%quote_local_part%& expansion item"
11305 This operator is like &%quote%&, except that it quotes the string only if
11306 required to do so by the rules of RFC 2822 for quoting local parts. For
11307 example, a plus sign would not cause quoting (but it would for &%quote%&).
11308 If you are creating a new email address from the contents of &$local_part$&
11309 (or any other unknown data), you should always use this operator.
11310
11311 This quoting determination is not SMTPUTF8-aware, thus quoting non-ASCII data
11312 will likely use the quoting form.
11313 Thus &'${quote_local_part:フィル}'& will always become &'"フィル"'&.
11314
11315
11316 .vitem &*${quote_*&<&'lookup-type'&>&*:*&<&'string'&>&*}*&
11317 .cindex "quoting" "lookup-specific"
11318 This operator applies lookup-specific quoting rules to the string. Each
11319 query-style lookup type has its own quoting rules which are described with
11320 the lookups in chapter &<<CHAPfdlookup>>&. For example,
11321 .code
11322 ${quote_ldap:two * two}
11323 .endd
11324 returns
11325 .code
11326 two%20%5C2A%20two
11327 .endd
11328 For single-key lookup types, no quoting is ever necessary and this operator
11329 yields an unchanged string.
11330
11331
11332 .vitem &*${randint:*&<&'n'&>&*}*&
11333 .cindex "random number"
11334 This operator returns a somewhat random number which is less than the
11335 supplied number and is at least 0.  The quality of this randomness depends
11336 on how Exim was built; the values are not suitable for keying material.
11337 If Exim is linked against OpenSSL then RAND_pseudo_bytes() is used.
11338 If Exim is linked against GnuTLS then gnutls_rnd(GNUTLS_RND_NONCE) is used,
11339 for versions of GnuTLS with that function.
11340 Otherwise, the implementation may be arc4random(), random() seeded by
11341 srandomdev() or srandom(), or a custom implementation even weaker than
11342 random().
11343
11344
11345 .vitem &*${reverse_ip:*&<&'ipaddr'&>&*}*&
11346 .cindex "expansion" "IP address"
11347 This operator reverses an IP address; for IPv4 addresses, the result is in
11348 dotted-quad decimal form, while for IPv6 addresses the result is in
11349 dotted-nibble hexadecimal form.  In both cases, this is the "natural" form
11350 for DNS.  For example,
11351 .code
11352 ${reverse_ip:192.0.2.4}
11353 ${reverse_ip:2001:0db8:c42:9:1:abcd:192.0.2.127}
11354 .endd
11355 returns
11356 .code
11357 4.2.0.192
11358 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
11359 .endd
11360
11361
11362 .vitem &*${rfc2047:*&<&'string'&>&*}*&
11363 .cindex "expansion" "RFC 2047"
11364 .cindex "RFC 2047" "expansion operator"
11365 .cindex "&%rfc2047%& expansion item"
11366 This operator encodes text according to the rules of RFC 2047. This is an
11367 encoding that is used in header lines to encode non-ASCII characters. It is
11368 assumed that the input string is in the encoding specified by the
11369 &%headers_charset%& option, which gets its default at build time. If the string
11370 contains only characters in the range 33&--126, and no instances of the
11371 characters
11372 .code
11373 ? = ( ) < > @ , ; : \ " . [ ] _
11374 .endd
11375 it is not modified. Otherwise, the result is the RFC 2047 encoding of the
11376 string, using as many &"encoded words"& as necessary to encode all the
11377 characters.
11378
11379
11380 .vitem &*${rfc2047d:*&<&'string'&>&*}*&
11381 .cindex "expansion" "RFC 2047"
11382 .cindex "RFC 2047" "decoding"
11383 .cindex "&%rfc2047d%& expansion item"
11384 This operator decodes strings that are encoded as per RFC 2047. Binary zero
11385 bytes are replaced by question marks. Characters are converted into the
11386 character set defined by &%headers_charset%&. Overlong RFC 2047 &"words"& are
11387 not recognized unless &%check_rfc2047_length%& is set false.
11388
11389 &*Note*&: If you use &%$header%&_&'xxx'&&*:*& (or &%$h%&_&'xxx'&&*:*&) to
11390 access a header line, RFC 2047 decoding is done automatically. You do not need
11391 to use this operator as well.
11392
11393
11394
11395 .vitem &*${rxquote:*&<&'string'&>&*}*&
11396 .cindex "quoting" "in regular expressions"
11397 .cindex "regular expressions" "quoting"
11398 .cindex "&%rxquote%& expansion item"
11399 The &%rxquote%& operator inserts a backslash before any non-alphanumeric
11400 characters in its argument. This is useful when substituting the values of
11401 variables or headers inside regular expressions.
11402
11403
11404 .vitem &*${sha1:*&<&'string'&>&*}*&
11405 .cindex "SHA-1 hash"
11406 .cindex "expansion" "SHA-1 hashing"
11407 .cindex certificate fingerprint
11408 .cindex "&%sha1%& expansion item"
11409 The &%sha1%& operator computes the SHA-1 hash value of the string, and returns
11410 it as a 40-digit hexadecimal number, in which any letters are in upper case.
11411
11412 If the string is a single variable of type certificate,
11413 returns the SHA-1 hash fingerprint of the certificate.
11414
11415
11416 .vitem &*${sha256:*&<&'string'&>&*}*& &&&
11417        &*${sha2:*&<&'string'&>&*}*& &&&
11418        &*${sha2_<n>:*&<&'string'&>&*}*&
11419 .cindex "SHA-256 hash"
11420 .cindex "SHA-2 hash"
11421 .cindex certificate fingerprint
11422 .cindex "expansion" "SHA-256 hashing"
11423 .cindex "&%sha256%& expansion item"
11424 .cindex "&%sha2%& expansion item"
11425 The &%sha256%& operator computes the SHA-256 hash value of the string
11426 and returns
11427 it as a 64-digit hexadecimal number, in which any letters are in upper case.
11428
11429 If the string is a single variable of type certificate,
11430 returns the SHA-256 hash fingerprint of the certificate.
11431
11432 The operator can also be spelled &%sha2%& and does the same as &%sha256%&
11433 (except for certificates, which are not supported).
11434 Finally, if an underbar
11435 and a number is appended it specifies the output length, selecting a
11436 member of the SHA-2 family of hash functions.
11437 Values of 256, 384 and 512 are accepted, with 256 being the default.
11438
11439
11440 .vitem &*${sha3:*&<&'string'&>&*}*& &&&
11441        &*${sha3_<n>:*&<&'string'&>&*}*&
11442 .cindex "SHA3 hash"
11443 .cindex "expansion" "SHA3 hashing"
11444 .cindex "&%sha3%& expansion item"
11445 The &%sha3%& operator computes the SHA3-256 hash value of the string
11446 and returns
11447 it as a 64-digit hexadecimal number, in which any letters are in upper case.
11448
11449 If a number is appended, separated by an underbar, it specifies
11450 the output length.  Values of 224, 256, 384 and 512 are accepted;
11451 with 256 being the default.
11452
11453 The &%sha3%& expansion item is only supported if Exim has been
11454 compiled with GnuTLS 3.5.0 or later,
11455 or OpenSSL 1.1.1 or later.
11456 The macro "_CRYPTO_HASH_SHA3" will be defined if it is supported.
11457
11458
11459 .vitem &*${stat:*&<&'string'&>&*}*&
11460 .cindex "expansion" "statting a file"
11461 .cindex "file" "extracting characteristics"
11462 .cindex "&%stat%& expansion item"
11463 The string, after expansion, must be a file path. A call to the &[stat()]&
11464 function is made for this path. If &[stat()]& fails, an error occurs and the
11465 expansion fails. If it succeeds, the data from the stat replaces the item, as a
11466 series of <&'name'&>=<&'value'&> pairs, where the values are all numerical,
11467 except for the value of &"smode"&. The names are: &"mode"& (giving the mode as
11468 a 4-digit octal number), &"smode"& (giving the mode in symbolic format as a
11469 10-character string, as for the &'ls'& command), &"inode"&, &"device"&,
11470 &"links"&, &"uid"&, &"gid"&, &"size"&, &"atime"&, &"mtime"&, and &"ctime"&. You
11471 can extract individual fields using the &%extract%& expansion item.
11472
11473 The use of the &%stat%& expansion in users' filter files can be locked out by
11474 the system administrator. &*Warning*&: The file size may be incorrect on 32-bit
11475 systems for files larger than 2GB.
11476
11477 .vitem &*${str2b64:*&<&'string'&>&*}*&
11478 .cindex "&%str2b64%& expansion item"
11479 Now deprecated, a synonym for the &%base64%& expansion operator.
11480
11481
11482
11483 .vitem &*${strlen:*&<&'string'&>&*}*&
11484 .cindex "expansion" "string length"
11485 .cindex "string" "length in expansion"
11486 .cindex "&%strlen%& expansion item"
11487 The item is replaced by the length of the expanded string, expressed as a
11488 decimal number. &*Note*&: Do not confuse &%strlen%& with &%length%&.
11489 All measurement is done in bytes and is not UTF-8 aware.
11490
11491
11492 .vitem &*${substr_*&<&'start'&>&*_*&<&'length'&>&*:*&<&'string'&>&*}*&
11493 .cindex "&%substr%& expansion item"
11494 .cindex "substring extraction"
11495 .cindex "expansion" "substring expansion"
11496 The &%substr%& operator is a simpler interface to the &%substr%& function that
11497 can be used when the two parameters are fixed numbers (as opposed to strings
11498 that change when expanded). The effect is the same as
11499 .code
11500 ${substr{<start>}{<length>}{<string>}}
11501 .endd
11502 See the description of the general &%substr%& item above for details. The
11503 abbreviation &%s%& can be used when &%substr%& is used as an operator.
11504 All measurement is done in bytes and is not UTF-8 aware.
11505
11506 .vitem &*${time_eval:*&<&'string'&>&*}*&
11507 .cindex "&%time_eval%& expansion item"
11508 .cindex "time interval" "decoding"
11509 This item converts an Exim time interval such as &`2d4h5m`& into a number of
11510 seconds.
11511
11512 .vitem &*${time_interval:*&<&'string'&>&*}*&
11513 .cindex "&%time_interval%& expansion item"
11514 .cindex "time interval" "formatting"
11515 The argument (after sub-expansion) must be a sequence of decimal digits that
11516 represents an interval of time as a number of seconds. It is converted into a
11517 number of larger units and output in Exim's normal time format, for example,
11518 &`1w3d4h2m6s`&.
11519
11520 .vitem &*${uc:*&<&'string'&>&*}*&
11521 .cindex "case forcing in strings"
11522 .cindex "string" "case forcing"
11523 .cindex "upper casing"
11524 .cindex "expansion" "case forcing"
11525 .cindex "&%uc%& expansion item"
11526 This forces the letters in the string into upper-case.
11527 Case is defined per the system C locale.
11528
11529 .vitem &*${utf8clean:*&<&'string'&>&*}*&
11530 .cindex "correction of invalid utf-8 sequences in strings"
11531 .cindex "utf-8" "utf-8 sequences"
11532 .cindex "incorrect utf-8"
11533 .cindex "expansion" "utf-8 forcing"
11534 .cindex "&%utf8clean%& expansion item"
11535 This replaces any invalid utf-8 sequence in the string by the character &`?`&.
11536 In versions of Exim before 4.92, this did not correctly do so for a truncated
11537 final codepoint's encoding, and the character would be silently dropped.
11538 If you must handle detection of this scenario across both sets of Exim behavior,
11539 the complexity will depend upon the task.
11540 For instance, to detect if the first character is multibyte and a 1-byte
11541 extraction can be successfully used as a path component (as is common for
11542 dividing up delivery folders), you might use:
11543 .code
11544 condition = ${if inlist{${utf8clean:${length_1:$local_part}}}{:?}{yes}{no}}
11545 .endd
11546 (which will false-positive if the first character of the local part is a
11547 literal question mark).
11548
11549 .vitem "&*${utf8_domain_to_alabel:*&<&'string'&>&*}*&" &&&
11550        "&*${utf8_domain_from_alabel:*&<&'string'&>&*}*&" &&&
11551        "&*${utf8_localpart_to_alabel:*&<&'string'&>&*}*&" &&&
11552        "&*${utf8_localpart_from_alabel:*&<&'string'&>&*}*&"
11553 .cindex expansion UTF-8
11554 .cindex UTF-8 expansion
11555 .cindex EAI
11556 .cindex internationalisation
11557 .cindex "&%utf8_domain_to_alabel%& expansion item"
11558 .cindex "&%utf8_domain_from_alabel%& expansion item"
11559 .cindex "&%utf8_localpart_to_alabel%& expansion item"
11560 .cindex "&%utf8_localpart_from_alabel%& expansion item"
11561 These convert EAI mail name components between UTF-8 and a-label forms.
11562 For information on internationalisation support see &<<SECTi18nMTA>>&.
11563 .endlist
11564
11565
11566
11567
11568
11569
11570 .section "Expansion conditions" "SECTexpcond"
11571 .scindex IIDexpcond "expansion" "conditions"
11572 The following conditions are available for testing by the &%${if%& construct
11573 while expanding strings:
11574
11575 .vlist
11576 .vitem &*!*&<&'condition'&>
11577 .cindex "expansion" "negating a condition"
11578 .cindex "negation" "in expansion condition"
11579 Preceding any condition with an exclamation mark negates the result of the
11580 condition.
11581
11582 .vitem <&'symbolic&~operator'&>&~&*{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11583 .cindex "numeric comparison"
11584 .cindex "expansion" "numeric comparison"
11585 There are a number of symbolic operators for doing numeric comparisons. They
11586 are:
11587 .display
11588 &`=   `&   equal
11589 &`==  `&   equal
11590 &`>   `&   greater
11591 &`>=  `&   greater or equal
11592 &`<   `&   less
11593 &`<=  `&   less or equal
11594 .endd
11595 For example:
11596 .code
11597 ${if >{$message_size}{10M} ...
11598 .endd
11599 Note that the general negation operator provides for inequality testing. The
11600 two strings must take the form of optionally signed decimal integers,
11601 optionally followed by one of the letters &"K"&, &"M"& or &"G"& (in either upper or
11602 lower case), signifying multiplication by 1024, 1024*1024 or 1024*1024*1024, respectively.
11603 As a special case, the numerical value of an empty string is taken as
11604 zero.
11605
11606 In all cases, a relative comparator OP is testing if <&'string1'&> OP
11607 <&'string2'&>; the above example is checking if &$message_size$& is larger than
11608 10M, not if 10M is larger than &$message_size$&.
11609
11610
11611 .vitem &*acl&~{{*&<&'name'&>&*}{*&<&'arg1'&>&*}&&&
11612         {*&<&'arg2'&>&*}...}*&
11613 .cindex "expansion" "calling an acl"
11614 .cindex "&%acl%&" "expansion condition"
11615 The name and zero to nine argument strings are first expanded separately.  The expanded
11616 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
11617 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
11618 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
11619 and may use the variables; if another acl expansion is used the values
11620 are restored after it returns.  If the ACL sets
11621 a value using a "message =" modifier the variable $value becomes
11622 the result of the expansion, otherwise it is empty.
11623 If the ACL returns accept the condition is true; if deny, false.
11624 If the ACL returns defer the result is a forced-fail.
11625
11626 .vitem &*bool&~{*&<&'string'&>&*}*&
11627 .cindex "expansion" "boolean parsing"
11628 .cindex "&%bool%& expansion condition"
11629 This condition turns a string holding a true or false representation into
11630 a boolean state.  It parses &"true"&, &"false"&, &"yes"& and &"no"&
11631 (case-insensitively); also integer numbers map to true if non-zero,
11632 false if zero.
11633 An empty string is treated as false.
11634 Leading and trailing whitespace is ignored;
11635 thus a string consisting only of whitespace is false.
11636 All other string values will result in expansion failure.
11637
11638 When combined with ACL variables, this expansion condition will let you
11639 make decisions in one place and act on those decisions in another place.
11640 For example:
11641 .code
11642 ${if bool{$acl_m_privileged_sender} ...
11643 .endd
11644
11645
11646 .vitem &*bool_lax&~{*&<&'string'&>&*}*&
11647 .cindex "expansion" "boolean parsing"
11648 .cindex "&%bool_lax%& expansion condition"
11649 Like &%bool%&, this condition turns a string into a boolean state.  But
11650 where &%bool%& accepts a strict set of strings, &%bool_lax%& uses the same
11651 loose definition that the Router &%condition%& option uses.  The empty string
11652 and the values &"false"&, &"no"& and &"0"& map to false, all others map to
11653 true.  Leading and trailing whitespace is ignored.
11654
11655 Note that where &"bool{00}"& is false, &"bool_lax{00}"& is true.
11656
11657 .vitem &*crypteq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11658 .cindex "expansion" "encrypted comparison"
11659 .cindex "encrypted strings, comparing"
11660 .cindex "&%crypteq%& expansion condition"
11661 This condition is included in the Exim binary if it is built to support any
11662 authentication mechanisms (see chapter &<<CHAPSMTPAUTH>>&). Otherwise, it is
11663 necessary to define SUPPORT_CRYPTEQ in &_Local/Makefile_& to get &%crypteq%&
11664 included in the binary.
11665
11666 The &%crypteq%& condition has two arguments. The first is encrypted and
11667 compared against the second, which is already encrypted. The second string may
11668 be in the LDAP form for storing encrypted strings, which starts with the
11669 encryption type in curly brackets, followed by the data. If the second string
11670 does not begin with &"{"& it is assumed to be encrypted with &[crypt()]& or
11671 &[crypt16()]& (see below), since such strings cannot begin with &"{"&.
11672 Typically this will be a field from a password file. An example of an encrypted
11673 string in LDAP form is:
11674 .code
11675 {md5}CY9rzUYh03PK3k6DJie09g==
11676 .endd
11677 If such a string appears directly in an expansion, the curly brackets have to
11678 be quoted, because they are part of the expansion syntax. For example:
11679 .code
11680 ${if crypteq {test}{\{md5\}CY9rzUYh03PK3k6DJie09g==}{yes}{no}}
11681 .endd
11682 The following encryption types (whose names are matched case-independently) are
11683 supported:
11684
11685 .ilist
11686 .cindex "MD5 hash"
11687 .cindex "base64 encoding" "in encrypted password"
11688 &%{md5}%& computes the MD5 digest of the first string, and expresses this as
11689 printable characters to compare with the remainder of the second string. If the
11690 length of the comparison string is 24, Exim assumes that it is base64 encoded
11691 (as in the above example). If the length is 32, Exim assumes that it is a
11692 hexadecimal encoding of the MD5 digest. If the length not 24 or 32, the
11693 comparison fails.
11694
11695 .next
11696 .cindex "SHA-1 hash"
11697 &%{sha1}%& computes the SHA-1 digest of the first string, and expresses this as
11698 printable characters to compare with the remainder of the second string. If the
11699 length of the comparison string is 28, Exim assumes that it is base64 encoded.
11700 If the length is 40, Exim assumes that it is a hexadecimal encoding of the
11701 SHA-1 digest. If the length is not 28 or 40, the comparison fails.
11702
11703 .next
11704 .cindex "&[crypt()]&"
11705 &%{crypt}%& calls the &[crypt()]& function, which traditionally used to use
11706 only the first eight characters of the password. However, in modern operating
11707 systems this is no longer true, and in many cases the entire password is used,
11708 whatever its length.
11709
11710 .next
11711 .cindex "&[crypt16()]&"
11712 &%{crypt16}%& calls the &[crypt16()]& function, which was originally created to
11713 use up to 16 characters of the password in some operating systems. Again, in
11714 modern operating systems, more characters may be used.
11715 .endlist
11716 Exim has its own version of &[crypt16()]&, which is just a double call to
11717 &[crypt()]&. For operating systems that have their own version, setting
11718 HAVE_CRYPT16 in &_Local/Makefile_& when building Exim causes it to use the
11719 operating system version instead of its own. This option is set by default in
11720 the OS-dependent &_Makefile_& for those operating systems that are known to
11721 support &[crypt16()]&.
11722
11723 Some years after Exim's &[crypt16()]& was implemented, a user discovered that
11724 it was not using the same algorithm as some operating systems' versions. It
11725 turns out that as well as &[crypt16()]& there is a function called
11726 &[bigcrypt()]& in some operating systems. This may or may not use the same
11727 algorithm, and both of them may be different to Exim's built-in &[crypt16()]&.
11728
11729 However, since there is now a move away from the traditional &[crypt()]&
11730 functions towards using SHA1 and other algorithms, tidying up this area of
11731 Exim is seen as very low priority.
11732
11733 If you do not put a encryption type (in curly brackets) in a &%crypteq%&
11734 comparison, the default is usually either &`{crypt}`& or &`{crypt16}`&, as
11735 determined by the setting of DEFAULT_CRYPT in &_Local/Makefile_&. The default
11736 default is &`{crypt}`&. Whatever the default, you can always use either
11737 function by specifying it explicitly in curly brackets.
11738
11739 .vitem &*def:*&<&'variable&~name'&>
11740 .cindex "expansion" "checking for empty variable"
11741 .cindex "&%def%& expansion condition"
11742 The &%def%& condition must be followed by the name of one of the expansion
11743 variables defined in section &<<SECTexpvar>>&. The condition is true if the
11744 variable does not contain the empty string. For example:
11745 .code
11746 ${if def:sender_ident {from $sender_ident}}
11747 .endd
11748 Note that the variable name is given without a leading &%$%& character. If the
11749 variable does not exist, the expansion fails.
11750
11751 .vitem "&*def:header_*&<&'header&~name'&>&*:*&&~&~or&~&&&
11752         &~&*def:h_*&<&'header&~name'&>&*:*&"
11753 .cindex "expansion" "checking header line existence"
11754 This condition is true if a message is being processed and the named header
11755 exists in the message. For example,
11756 .code
11757 ${if def:header_reply-to:{$h_reply-to:}{$h_from:}}
11758 .endd
11759 &*Note*&: No &%$%& appears before &%header_%& or &%h_%& in the condition, and
11760 the header name must be terminated by a colon if white space does not follow.
11761
11762 .vitem &*eq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11763        &*eqi&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11764 .cindex "string" "comparison"
11765 .cindex "expansion" "string comparison"
11766 .cindex "&%eq%& expansion condition"
11767 .cindex "&%eqi%& expansion condition"
11768 The two substrings are first expanded. The condition is true if the two
11769 resulting strings are identical. For &%eq%& the comparison includes the case of
11770 letters, whereas for &%eqi%& the comparison is case-independent, where
11771 case is defined per the system C locale.
11772
11773 .vitem &*exists&~{*&<&'file&~name'&>&*}*&
11774 .cindex "expansion" "file existence test"
11775 .cindex "file" "existence test"
11776 .cindex "&%exists%&, expansion condition"
11777 The substring is first expanded and then interpreted as an absolute path. The
11778 condition is true if the named file (or directory) exists. The existence test
11779 is done by calling the &[stat()]& function. The use of the &%exists%& test in
11780 users' filter files may be locked out by the system administrator.
11781
11782 .new
11783 &*Note:*& Testing a path using this condition is not a sufficient way of
11784 de-tainting it.
11785 Consider using a dsearch lookup.
11786 .wen
11787
11788 .vitem &*first_delivery*&
11789 .cindex "delivery" "first"
11790 .cindex "first delivery"
11791 .cindex "expansion" "first delivery test"
11792 .cindex "&%first_delivery%& expansion condition"
11793 This condition, which has no data, is true during a message's first delivery
11794 attempt. It is false during any subsequent delivery attempts.
11795
11796
11797 .vitem "&*forall{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&" &&&
11798        "&*forany{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&"
11799 .cindex "list" "iterative conditions"
11800 .cindex "expansion" "&*forall*& condition"
11801 .cindex "expansion" "&*forany*& condition"
11802 .vindex "&$item$&"
11803 These conditions iterate over a list. The first argument is expanded to form
11804 the list. By default, the list separator is a colon, but it can be changed by
11805 the normal method (&<<SECTlistsepchange>>&).
11806 The second argument is interpreted as a condition that is to
11807 be applied to each item in the list in turn. During the interpretation of the
11808 condition, the current list item is placed in a variable called &$item$&.
11809 .ilist
11810 For &*forany*&, interpretation stops if the condition is true for any item, and
11811 the result of the whole condition is true. If the condition is false for all
11812 items in the list, the overall condition is false.
11813 .next
11814 For &*forall*&, interpretation stops if the condition is false for any item,
11815 and the result of the whole condition is false. If the condition is true for
11816 all items in the list, the overall condition is true.
11817 .endlist
11818 Note that negation of &*forany*& means that the condition must be false for all
11819 items for the overall condition to succeed, and negation of &*forall*& means
11820 that the condition must be false for at least one item. In this example, the
11821 list separator is changed to a comma:
11822 .code
11823 ${if forany{<, $recipients}{match{$item}{^user3@}}{yes}{no}}
11824 .endd
11825 The value of &$item$& is saved and restored while &%forany%& or &%forall%& is
11826 being processed, to enable these expansion items to be nested.
11827
11828 To scan a named list, expand it with the &*listnamed*& operator.
11829
11830 .vitem "&*forall_json{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&" &&&
11831        "&*forany_json{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&" &&&
11832        "&*forall_jsons{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&" &&&
11833        "&*forany_jsons{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&"
11834 .cindex JSON "iterative conditions"
11835 .cindex JSON expansions
11836 .cindex expansion "&*forall_json*& condition"
11837 .cindex expansion "&*forany_json*& condition"
11838 .cindex expansion "&*forall_jsons*& condition"
11839 .cindex expansion "&*forany_jsons*& condition"
11840 As for the above, except that the first argument must, after expansion,
11841 be a JSON array.
11842 The array separator is not changeable.
11843 For the &"jsons"& variants the elements are expected to be JSON strings
11844 and have their quotes removed before the evaluation of the condition.
11845
11846
11847
11848 .vitem &*ge&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11849        &*gei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11850 .cindex "string" "comparison"
11851 .cindex "expansion" "string comparison"
11852 .cindex "&%ge%& expansion condition"
11853 .cindex "&%gei%& expansion condition"
11854 The two substrings are first expanded. The condition is true if the first
11855 string is lexically greater than or equal to the second string. For &%ge%& the
11856 comparison includes the case of letters, whereas for &%gei%& the comparison is
11857 case-independent.
11858 Case and collation order are defined per the system C locale.
11859
11860 .vitem &*gt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11861        &*gti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11862 .cindex "string" "comparison"
11863 .cindex "expansion" "string comparison"
11864 .cindex "&%gt%& expansion condition"
11865 .cindex "&%gti%& expansion condition"
11866 The two substrings are first expanded. The condition is true if the first
11867 string is lexically greater than the second string. For &%gt%& the comparison
11868 includes the case of letters, whereas for &%gti%& the comparison is
11869 case-independent.
11870 Case and collation order are defined per the system C locale.
11871
11872
11873 .new
11874 .vitem &*inbound_srs&~{*&<&'local&~part'&>&*}{*&<&'secret'&>&*}*&
11875 SRS decode.  See SECT &<<SECTSRS>>& for details.
11876 .wen
11877
11878
11879 .vitem &*inlist&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11880        &*inlisti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11881 .cindex "string" "comparison"
11882 .cindex "list" "iterative conditions"
11883 Both strings are expanded; the second string is treated as a list of simple
11884 strings; if the first string is a member of the second, then the condition
11885 is true.
11886 For the case-independent &%inlisti%& condition, case is defined per the system C locale.
11887
11888 These are simpler to use versions of the more powerful &*forany*& condition.
11889 Examples, and the &*forany*& equivalents:
11890 .code
11891 ${if inlist{needle}{foo:needle:bar}}
11892   ${if forany{foo:needle:bar}{eq{$item}{needle}}}
11893 ${if inlisti{Needle}{fOo:NeeDLE:bAr}}
11894   ${if forany{fOo:NeeDLE:bAr}{eqi{$item}{Needle}}}
11895 .endd
11896
11897 .vitem &*isip&~{*&<&'string'&>&*}*&  &&&
11898        &*isip4&~{*&<&'string'&>&*}*& &&&
11899        &*isip6&~{*&<&'string'&>&*}*&
11900 .cindex "IP address" "testing string format"
11901 .cindex "string" "testing for IP address"
11902 .cindex "&%isip%& expansion condition"
11903 .cindex "&%isip4%& expansion condition"
11904 .cindex "&%isip6%& expansion condition"
11905 The substring is first expanded, and then tested to see if it has the form of
11906 an IP address. Both IPv4 and IPv6 addresses are valid for &%isip%&, whereas
11907 &%isip4%& and &%isip6%& test specifically for IPv4 or IPv6 addresses.
11908
11909 For an IPv4 address, the test is for four dot-separated components, each of
11910 which consists of from one to three digits. For an IPv6 address, up to eight
11911 colon-separated components are permitted, each containing from one to four
11912 hexadecimal digits. There may be fewer than eight components if an empty
11913 component (adjacent colons) is present. Only one empty component is permitted.
11914
11915 &*Note*&: The checks used to be just on the form of the address; actual numerical
11916 values were not considered. Thus, for example, 999.999.999.999 passed the IPv4
11917 check.
11918 This is no longer the case.
11919
11920 The main use of these tests is to distinguish between IP addresses and
11921 host names, or between IPv4 and IPv6 addresses. For example, you could use
11922 .code
11923 ${if isip4{$sender_host_address}...
11924 .endd
11925 to test which IP version an incoming SMTP connection is using.
11926
11927 .vitem &*ldapauth&~{*&<&'ldap&~query'&>&*}*&
11928 .cindex "LDAP" "use for authentication"
11929 .cindex "expansion" "LDAP authentication test"
11930 .cindex "&%ldapauth%& expansion condition"
11931 This condition supports user authentication using LDAP. See section
11932 &<<SECTldap>>& for details of how to use LDAP in lookups and the syntax of
11933 queries. For this use, the query must contain a user name and password. The
11934 query itself is not used, and can be empty. The condition is true if the
11935 password is not empty, and the user name and password are accepted by the LDAP
11936 server. An empty password is rejected without calling LDAP because LDAP binds
11937 with an empty password are considered anonymous regardless of the username, and
11938 will succeed in most configurations. See chapter &<<CHAPSMTPAUTH>>& for details
11939 of SMTP authentication, and chapter &<<CHAPplaintext>>& for an example of how
11940 this can be used.
11941
11942
11943 .vitem &*le&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11944        &*lei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11945 .cindex "string" "comparison"
11946 .cindex "expansion" "string comparison"
11947 .cindex "&%le%& expansion condition"
11948 .cindex "&%lei%& expansion condition"
11949 The two substrings are first expanded. The condition is true if the first
11950 string is lexically less than or equal to the second string. For &%le%& the
11951 comparison includes the case of letters, whereas for &%lei%& the comparison is
11952 case-independent.
11953 Case and collation order are defined per the system C locale.
11954
11955 .vitem &*lt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11956        &*lti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11957 .cindex "string" "comparison"
11958 .cindex "expansion" "string comparison"
11959 .cindex "&%lt%& expansion condition"
11960 .cindex "&%lti%& expansion condition"
11961 The two substrings are first expanded. The condition is true if the first
11962 string is lexically less than the second string. For &%lt%& the comparison
11963 includes the case of letters, whereas for &%lti%& the comparison is
11964 case-independent.
11965 Case and collation order are defined per the system C locale.
11966
11967
11968 .vitem &*match&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11969 .cindex "expansion" "regular expression comparison"
11970 .cindex "regular expressions" "match in expanded string"
11971 .cindex "&%match%& expansion condition"
11972 The two substrings are first expanded. The second is then treated as a regular
11973 expression and applied to the first. Because of the pre-expansion, if the
11974 regular expression contains dollar, or backslash characters, they must be
11975 escaped. Care must also be taken if the regular expression contains braces
11976 (curly brackets). A closing brace must be escaped so that it is not taken as a
11977 premature termination of <&'string2'&>. The easiest approach is to use the
11978 &`\N`& feature to disable expansion of the regular expression.
11979 For example,
11980 .code
11981 ${if match {$local_part}{\N^\d{3}\N} ...
11982 .endd
11983 If the whole expansion string is in double quotes, further escaping of
11984 backslashes is also required.
11985
11986 The condition is true if the regular expression match succeeds.
11987 The regular expression is not required to begin with a circumflex
11988 metacharacter, but if there is no circumflex, the expression is not anchored,
11989 and it may match anywhere in the subject, not just at the start. If you want
11990 the pattern to match at the end of the subject, you must include the &`$`&
11991 metacharacter at an appropriate point.
11992 All character handling is done in bytes and is not UTF-8 aware,
11993 but we might change this in a future Exim release.
11994
11995 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%if%& expansion"
11996 At the start of an &%if%& expansion the values of the numeric variable
11997 substitutions &$1$& etc. are remembered. Obeying a &%match%& condition that
11998 succeeds causes them to be reset to the substrings of that condition and they
11999 will have these values during the expansion of the success string. At the end
12000 of the &%if%& expansion, the previous values are restored. After testing a
12001 combination of conditions using &%or%&, the subsequent values of the numeric
12002 variables are those of the condition that succeeded.
12003
12004 .vitem &*match_address&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
12005 .cindex "&%match_address%& expansion condition"
12006 See &*match_local_part*&.
12007
12008 .vitem &*match_domain&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
12009 .cindex "&%match_domain%& expansion condition"
12010 See &*match_local_part*&.
12011
12012 .vitem &*match_ip&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
12013 .cindex "&%match_ip%& expansion condition"
12014 This condition matches an IP address to a list of IP address patterns. It must
12015 be followed by two argument strings. The first (after expansion) must be an IP
12016 address or an empty string. The second (not expanded) is a restricted host
12017 list that can match only an IP address, not a host name. For example:
12018 .code
12019 ${if match_ip{$sender_host_address}{1.2.3.4:5.6.7.8}{...}{...}}
12020 .endd
12021 The specific types of host list item that are permitted in the list are:
12022
12023 .ilist
12024 An IP address, optionally with a CIDR mask.
12025 .next
12026 A single asterisk, which matches any IP address.
12027 .next
12028 An empty item, which matches only if the IP address is empty. This could be
12029 useful for testing for a locally submitted message or one from specific hosts
12030 in a single test such as
12031 . ==== As this is a nested list, any displays it contains must be indented
12032 . ==== as otherwise they are too far to the left. This comment applies to
12033 . ==== the use of xmlto plus fop. There's no problem when formatting with
12034 . ==== sdop, with or without the extra indent.
12035 .code
12036   ${if match_ip{$sender_host_address}{:4.3.2.1:...}{...}{...}}
12037 .endd
12038 where the first item in the list is the empty string.
12039 .next
12040 The item @[] matches any of the local host's interface addresses.
12041 .next
12042 Single-key lookups are assumed to be like &"net-"& style lookups in host lists,
12043 even if &`net-`& is not specified. There is never any attempt to turn the IP
12044 address into a host name. The most common type of linear search for
12045 &*match_ip*& is likely to be &*iplsearch*&, in which the file can contain CIDR
12046 masks. For example:
12047 .code
12048   ${if match_ip{$sender_host_address}{iplsearch;/some/file}...
12049 .endd
12050 It is of course possible to use other kinds of lookup, and in such a case, you
12051 do need to specify the &`net-`& prefix if you want to specify a specific
12052 address mask, for example:
12053 .code
12054   ${if match_ip{$sender_host_address}{net24-dbm;/some/file}...
12055 .endd
12056 However, unless you are combining a &%match_ip%& condition with others, it is
12057 just as easy to use the fact that a lookup is itself a condition, and write:
12058 .code
12059   ${lookup{${mask:$sender_host_address/24}}dbm{/a/file}...
12060 .endd
12061 .endlist ilist
12062
12063 Note that <&'string2'&> is not itself subject to string expansion, unless
12064 Exim was built with the EXPAND_LISTMATCH_RHS option.
12065
12066 Consult section &<<SECThoslispatip>>& for further details of these patterns.
12067
12068 .vitem &*match_local_part&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
12069 .cindex "domain list" "in expansion condition"
12070 .cindex "address list" "in expansion condition"
12071 .cindex "local part" "list, in expansion condition"
12072 .cindex "&%match_local_part%& expansion condition"
12073 This condition, together with &%match_address%& and &%match_domain%&, make it
12074 possible to test domain, address, and local part lists within expansions. Each
12075 condition requires two arguments: an item and a list to match. A trivial
12076 example is:
12077 .code
12078 ${if match_domain{a.b.c}{x.y.z:a.b.c:p.q.r}{yes}{no}}
12079 .endd
12080 In each case, the second argument may contain any of the allowable items for a
12081 list of the appropriate type. Also, because the second argument
12082 is a standard form of list, it is possible to refer to a named list.
12083 Thus, you can use conditions like this:
12084 .code
12085 ${if match_domain{$domain}{+local_domains}{...
12086 .endd
12087 .cindex "&`+caseful`&"
12088 For address lists, the matching starts off caselessly, but the &`+caseful`&
12089 item can be used, as in all address lists, to cause subsequent items to
12090 have their local parts matched casefully. Domains are always matched
12091 caselessly.
12092
12093 Note that <&'string2'&> is not itself subject to string expansion, unless
12094 Exim was built with the EXPAND_LISTMATCH_RHS option.
12095
12096 &*Note*&: Host lists are &'not'& supported in this way. This is because
12097 hosts have two identities: a name and an IP address, and it is not clear
12098 how to specify cleanly how such a test would work. However, IP addresses can be
12099 matched using &%match_ip%&.
12100
12101 .vitem &*pam&~{*&<&'string1'&>&*:*&<&'string2'&>&*:...}*&
12102 .cindex "PAM authentication"
12103 .cindex "AUTH" "with PAM"
12104 .cindex "Solaris" "PAM support"
12105 .cindex "expansion" "PAM authentication test"
12106 .cindex "&%pam%& expansion condition"
12107 &'Pluggable Authentication Modules'&
12108 (&url(https://mirrors.edge.kernel.org/pub/linux/libs/pam/)) are a facility that is
12109 available in the latest releases of Solaris and in some GNU/Linux
12110 distributions. The Exim support, which is intended for use in conjunction with
12111 the SMTP AUTH command, is available only if Exim is compiled with
12112 .code
12113 SUPPORT_PAM=yes
12114 .endd
12115 in &_Local/Makefile_&. You probably need to add &%-lpam%& to EXTRALIBS, and
12116 in some releases of GNU/Linux &%-ldl%& is also needed.
12117
12118 The argument string is first expanded, and the result must be a
12119 colon-separated list of strings. Leading and trailing white space is ignored.
12120 The PAM module is initialized with the service name &"exim"& and the user name
12121 taken from the first item in the colon-separated data string (<&'string1'&>).
12122 The remaining items in the data string are passed over in response to requests
12123 from the authentication function. In the simple case there will only be one
12124 request, for a password, so the data consists of just two strings.
12125
12126 There can be problems if any of the strings are permitted to contain colon
12127 characters. In the usual way, these have to be doubled to avoid being taken as
12128 separators.
12129 The &%listquote%& expansion item can be used for this.
12130 For example, the configuration
12131 of a LOGIN authenticator might contain this setting:
12132 .code
12133 server_condition = ${if pam{$auth1:${listquote{:}{$auth2}}}}
12134 .endd
12135 In some operating systems, PAM authentication can be done only from a process
12136 running as root. Since Exim is running as the Exim user when receiving
12137 messages, this means that PAM cannot be used directly in those systems.
12138 . --- 2018-09-07: the pam_exim modified variant has gone, removed claims re using Exim via that
12139
12140
12141 .vitem &*pwcheck&~{*&<&'string1'&>&*:*&<&'string2'&>&*}*&
12142 .cindex "&'pwcheck'& daemon"
12143 .cindex "Cyrus"
12144 .cindex "expansion" "&'pwcheck'& authentication test"
12145 .cindex "&%pwcheck%& expansion condition"
12146 This condition supports user authentication using the Cyrus &'pwcheck'& daemon.
12147 This is one way of making it possible for passwords to be checked by a process
12148 that is not running as root. &*Note*&: The use of &'pwcheck'& is now
12149 deprecated. Its replacement is &'saslauthd'& (see below).
12150
12151 The pwcheck support is not included in Exim by default. You need to specify
12152 the location of the pwcheck daemon's socket in &_Local/Makefile_& before
12153 building Exim. For example:
12154 .code
12155 CYRUS_PWCHECK_SOCKET=/var/pwcheck/pwcheck
12156 .endd
12157 You do not need to install the full Cyrus software suite in order to use
12158 the pwcheck daemon. You can compile and install just the daemon alone
12159 from the Cyrus SASL library. Ensure that &'exim'& is the only user that has
12160 access to the &_/var/pwcheck_& directory.
12161
12162 The &%pwcheck%& condition takes one argument, which must be the user name and
12163 password, separated by a colon. For example, in a LOGIN authenticator
12164 configuration, you might have this:
12165 .code
12166 server_condition = ${if pwcheck{$auth1:$auth2}}
12167 .endd
12168 Again, for a PLAIN authenticator configuration, this would be:
12169 .code
12170 server_condition = ${if pwcheck{$auth2:$auth3}}
12171 .endd
12172 .vitem &*queue_running*&
12173 .cindex "queue runner" "detecting when delivering from"
12174 .cindex "expansion" "queue runner test"
12175 .cindex "&%queue_running%& expansion condition"
12176 This condition, which has no data, is true during delivery attempts that are
12177 initiated by queue runner processes, and false otherwise.
12178
12179
12180 .vitem &*radius&~{*&<&'authentication&~string'&>&*}*&
12181 .cindex "Radius"
12182 .cindex "expansion" "Radius authentication"
12183 .cindex "&%radius%& expansion condition"
12184 Radius authentication (RFC 2865) is supported in a similar way to PAM. You must
12185 set RADIUS_CONFIG_FILE in &_Local/Makefile_& to specify the location of
12186 the Radius client configuration file in order to build Exim with Radius
12187 support.
12188
12189 With just that one setting, Exim expects to be linked with the &%radiusclient%&
12190 library, using the original API. If you are using release 0.4.0 or later of
12191 this library, you need to set
12192 .code
12193 RADIUS_LIB_TYPE=RADIUSCLIENTNEW
12194 .endd
12195 in &_Local/Makefile_& when building Exim. You can also link Exim with the
12196 &%libradius%& library that comes with FreeBSD. To do this, set
12197 .code
12198 RADIUS_LIB_TYPE=RADLIB
12199 .endd
12200 in &_Local/Makefile_&, in addition to setting RADIUS_CONFIGURE_FILE.
12201 You may also have to supply a suitable setting in EXTRALIBS so that the
12202 Radius library can be found when Exim is linked.
12203
12204 The string specified by RADIUS_CONFIG_FILE is expanded and passed to the
12205 Radius client library, which calls the Radius server. The condition is true if
12206 the authentication is successful. For example:
12207 .code
12208 server_condition = ${if radius{<arguments>}}
12209 .endd
12210
12211
12212 .vitem "&*saslauthd&~{{*&<&'user'&>&*}{*&<&'password'&>&*}&&&
12213         {*&<&'service'&>&*}{*&<&'realm'&>&*}}*&"
12214 .cindex "&'saslauthd'& daemon"
12215 .cindex "Cyrus"
12216 .cindex "expansion" "&'saslauthd'& authentication test"
12217 .cindex "&%saslauthd%& expansion condition"
12218 This condition supports user authentication using the Cyrus &'saslauthd'&
12219 daemon. This replaces the older &'pwcheck'& daemon, which is now deprecated.
12220 Using this daemon is one way of making it possible for passwords to be checked
12221 by a process that is not running as root.
12222
12223 The saslauthd support is not included in Exim by default. You need to specify
12224 the location of the saslauthd daemon's socket in &_Local/Makefile_& before
12225 building Exim. For example:
12226 .code
12227 CYRUS_SASLAUTHD_SOCKET=/var/state/saslauthd/mux
12228 .endd
12229 You do not need to install the full Cyrus software suite in order to use
12230 the saslauthd daemon. You can compile and install just the daemon alone
12231 from the Cyrus SASL library.
12232
12233 Up to four arguments can be supplied to the &%saslauthd%& condition, but only
12234 two are mandatory. For example:
12235 .code
12236 server_condition = ${if saslauthd{{$auth1}{$auth2}}}
12237 .endd
12238 The service and the realm are optional (which is why the arguments are enclosed
12239 in their own set of braces). For details of the meaning of the service and
12240 realm, and how to run the daemon, consult the Cyrus documentation.
12241 .endlist vlist
12242
12243
12244
12245 .section "Combining expansion conditions" "SECID84"
12246 .cindex "expansion" "combining conditions"
12247 Several conditions can be tested at once by combining them using the &%and%&
12248 and &%or%& combination conditions. Note that &%and%& and &%or%& are complete
12249 conditions on their own, and precede their lists of sub-conditions. Each
12250 sub-condition must be enclosed in braces within the overall braces that contain
12251 the list. No repetition of &%if%& is used.
12252
12253
12254 .vlist
12255 .vitem &*or&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
12256 .cindex "&""or""& expansion condition"
12257 .cindex "expansion" "&""or""& of conditions"
12258 The sub-conditions are evaluated from left to right. The condition is true if
12259 any one of the sub-conditions is true.
12260 For example,
12261 .code
12262 ${if or {{eq{$local_part}{spqr}}{eq{$domain}{testing.com}}}...
12263 .endd
12264 When a true sub-condition is found, the following ones are parsed but not
12265 evaluated. If there are several &"match"& sub-conditions the values of the
12266 numeric variables afterwards are taken from the first one that succeeds.
12267
12268 .vitem &*and&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
12269 .cindex "&""and""& expansion condition"
12270 .cindex "expansion" "&""and""& of conditions"
12271 The sub-conditions are evaluated from left to right. The condition is true if
12272 all of the sub-conditions are true. If there are several &"match"&
12273 sub-conditions, the values of the numeric variables afterwards are taken from
12274 the last one. When a false sub-condition is found, the following ones are
12275 parsed but not evaluated.
12276 .endlist
12277 .ecindex IIDexpcond
12278
12279
12280
12281
12282 .section "Expansion variables" "SECTexpvar"
12283 .cindex "expansion" "variables, list of"
12284 This section contains an alphabetical list of all the expansion variables. Some
12285 of them are available only when Exim is compiled with specific options such as
12286 support for TLS or the content scanning extension.
12287
12288 .vlist
12289 .vitem "&$0$&, &$1$&, etc"
12290 .cindex "numerical variables (&$1$& &$2$& etc)"
12291 When a &%match%& expansion condition succeeds, these variables contain the
12292 captured substrings identified by the regular expression during subsequent
12293 processing of the success string of the containing &%if%& expansion item.
12294 In the expansion condition case
12295 they do not retain their values afterwards; in fact, their previous
12296 values are restored at the end of processing an &%if%& item. The numerical
12297 variables may also be set externally by some other matching process which
12298 precedes the expansion of the string. For example, the commands available in
12299 Exim filter files include an &%if%& command with its own regular expression
12300 matching condition.
12301
12302 .vitem "&$acl_arg1$&, &$acl_arg2$&, etc"
12303 Within an acl condition, expansion condition or expansion item
12304 any arguments are copied to these variables,
12305 any unused variables being made empty.
12306
12307 .vitem "&$acl_c...$&"
12308 Values can be placed in these variables by the &%set%& modifier in an ACL. They
12309 can be given any name that starts with &$acl_c$& and is at least six characters
12310 long, but the sixth character must be either a digit or an underscore. For
12311 example: &$acl_c5$&, &$acl_c_mycount$&. The values of the &$acl_c...$&
12312 variables persist throughout the lifetime of an SMTP connection. They can be
12313 used to pass information between ACLs and between different invocations of the
12314 same ACL. When a message is received, the values of these variables are saved
12315 with the message, and can be accessed by filters, routers, and transports
12316 during subsequent delivery.
12317
12318 .vitem "&$acl_m...$&"
12319 These variables are like the &$acl_c...$& variables, except that their values
12320 are reset after a message has been received. Thus, if several messages are
12321 received in one SMTP connection, &$acl_m...$& values are not passed on from one
12322 message to the next, as &$acl_c...$& values are. The &$acl_m...$& variables are
12323 also reset by MAIL, RSET, EHLO, HELO, and after starting a TLS session. When a
12324 message is received, the values of these variables are saved with the message,
12325 and can be accessed by filters, routers, and transports during subsequent
12326 delivery.
12327
12328 .vitem &$acl_narg$&
12329 Within an acl condition, expansion condition or expansion item
12330 this variable has the number of arguments.
12331
12332 .vitem &$acl_verify_message$&
12333 .vindex "&$acl_verify_message$&"
12334 After an address verification has failed, this variable contains the failure
12335 message. It retains its value for use in subsequent modifiers of the verb.
12336 The message can be preserved by coding like this:
12337 .code
12338 warn !verify = sender
12339      set acl_m0 = $acl_verify_message
12340 .endd
12341 You can use &$acl_verify_message$& during the expansion of the &%message%& or
12342 &%log_message%& modifiers, to include information about the verification
12343 failure.
12344 .new
12345 &*Note*&: The variable is cleared at the end of processing the ACL verb.
12346 .wen
12347
12348 .vitem &$address_data$&
12349 .vindex "&$address_data$&"
12350 This variable is set by means of the &%address_data%& option in routers. The
12351 value then remains with the address while it is processed by subsequent routers
12352 and eventually a transport. If the transport is handling multiple addresses,
12353 the value from the first address is used. See chapter &<<CHAProutergeneric>>&
12354 for more details. &*Note*&: The contents of &$address_data$& are visible in
12355 user filter files.
12356
12357 If &$address_data$& is set when the routers are called from an ACL to verify
12358 a recipient address, the final value is still in the variable for subsequent
12359 conditions and modifiers of the ACL statement. If routing the address caused it
12360 to be redirected to just one address, the child address is also routed as part
12361 of the verification, and in this case the final value of &$address_data$& is
12362 from the child's routing.
12363
12364 If &$address_data$& is set when the routers are called from an ACL to verify a
12365 sender address, the final value is also preserved, but this time in
12366 &$sender_address_data$&, to distinguish it from data from a recipient
12367 address.
12368
12369 In both cases (recipient and sender verification), the value does not persist
12370 after the end of the current ACL statement. If you want to preserve
12371 these values for longer, you can save them in ACL variables.
12372
12373 .vitem &$address_file$&
12374 .vindex "&$address_file$&"
12375 When, as a result of aliasing, forwarding, or filtering, a message is directed
12376 to a specific file, this variable holds the name of the file when the transport
12377 is running. At other times, the variable is empty. For example, using the
12378 default configuration, if user &%r2d2%& has a &_.forward_& file containing
12379 .code
12380 /home/r2d2/savemail
12381 .endd
12382 then when the &(address_file)& transport is running, &$address_file$&
12383 contains the text string &`/home/r2d2/savemail`&.
12384 .cindex "Sieve filter" "value of &$address_file$&"
12385 For Sieve filters, the value may be &"inbox"& or a relative folder name. It is
12386 then up to the transport configuration to generate an appropriate absolute path
12387 to the relevant file.
12388
12389 .vitem &$address_pipe$&
12390 .vindex "&$address_pipe$&"
12391 When, as a result of aliasing or forwarding, a message is directed to a pipe,
12392 this variable holds the pipe command when the transport is running.
12393
12394 .vitem "&$auth1$& &-- &$auth4$&"
12395 .vindex "&$auth1$&, &$auth2$&, etc"
12396 These variables are used in SMTP authenticators (see chapters
12397 &<<CHAPplaintext>>&&--&<<CHAPtlsauth>>&). Elsewhere, they are empty.
12398
12399 .vitem &$authenticated_id$&
12400 .cindex "authentication" "id"
12401 .vindex "&$authenticated_id$&"
12402 When a server successfully authenticates a client it may be configured to
12403 preserve some of the authentication information in the variable
12404 &$authenticated_id$& (see chapter &<<CHAPSMTPAUTH>>&). For example, a
12405 user/password authenticator configuration might preserve the user name for use
12406 in the routers. Note that this is not the same information that is saved in
12407 &$sender_host_authenticated$&.
12408
12409 When a message is submitted locally (that is, not over a TCP connection)
12410 the value of &$authenticated_id$& is normally the login name of the calling
12411 process. However, a trusted user can override this by means of the &%-oMai%&
12412 command line option.
12413 This second case also sets up information used by the
12414 &$authresults$& expansion item.
12415
12416 .vitem &$authenticated_fail_id$&
12417 .cindex "authentication" "fail" "id"
12418 .vindex "&$authenticated_fail_id$&"
12419 When an authentication attempt fails, the variable &$authenticated_fail_id$&
12420 will contain the failed authentication id. If more than one authentication
12421 id is attempted, it will contain only the last one. The variable is
12422 available for processing in the ACL's, generally the quit or notquit ACL.
12423 A message to a local recipient could still be accepted without requiring
12424 authentication, which means this variable could also be visible in all of
12425 the ACL's as well.
12426
12427
12428 .vitem &$authenticated_sender$&
12429 .cindex "sender" "authenticated"
12430 .cindex "authentication" "sender"
12431 .cindex "AUTH" "on MAIL command"
12432 .vindex "&$authenticated_sender$&"
12433 When acting as a server, Exim takes note of the AUTH= parameter on an incoming
12434 SMTP MAIL command if it believes the sender is sufficiently trusted, as
12435 described in section &<<SECTauthparamail>>&. Unless the data is the string
12436 &"<>"&, it is set as the authenticated sender of the message, and the value is
12437 available during delivery in the &$authenticated_sender$& variable. If the
12438 sender is not trusted, Exim accepts the syntax of AUTH=, but ignores the data.
12439
12440 .vindex "&$qualify_domain$&"
12441 When a message is submitted locally (that is, not over a TCP connection), the
12442 value of &$authenticated_sender$& is an address constructed from the login
12443 name of the calling process and &$qualify_domain$&, except that a trusted user
12444 can override this by means of the &%-oMas%& command line option.
12445
12446
12447 .vitem &$authentication_failed$&
12448 .cindex "authentication" "failure"
12449 .vindex "&$authentication_failed$&"
12450 This variable is set to &"1"& in an Exim server if a client issues an AUTH
12451 command that does not succeed. Otherwise it is set to &"0"&. This makes it
12452 possible to distinguish between &"did not try to authenticate"&
12453 (&$sender_host_authenticated$& is empty and &$authentication_failed$& is set to
12454 &"0"&) and &"tried to authenticate but failed"& (&$sender_host_authenticated$&
12455 is empty and &$authentication_failed$& is set to &"1"&). Failure includes any
12456 negative response to an AUTH command, including (for example) an attempt to use
12457 an undefined mechanism.
12458
12459 .vitem &$av_failed$&
12460 .cindex "content scanning" "AV scanner failure"
12461 This variable is available when Exim is compiled with the content-scanning
12462 extension. It is set to &"0"& by default, but will be set to &"1"& if any
12463 problem occurs with the virus scanner (specified by &%av_scanner%&) during
12464 the ACL malware condition.
12465
12466 .vitem &$body_linecount$&
12467 .cindex "message body" "line count"
12468 .cindex "body of message" "line count"
12469 .vindex "&$body_linecount$&"
12470 When a message is being received or delivered, this variable contains the
12471 number of lines in the message's body. See also &$message_linecount$&.
12472
12473 .vitem &$body_zerocount$&
12474 .cindex "message body" "binary zero count"
12475 .cindex "body of message" "binary zero count"
12476 .cindex "binary zero" "in message body"
12477 .vindex "&$body_zerocount$&"
12478 When a message is being received or delivered, this variable contains the
12479 number of binary zero bytes (ASCII NULs) in the message's body.
12480
12481 .vitem &$bounce_recipient$&
12482 .vindex "&$bounce_recipient$&"
12483 This is set to the recipient address of a bounce message while Exim is creating
12484 it. It is useful if a customized bounce message text file is in use (see
12485 chapter &<<CHAPemsgcust>>&).
12486
12487 .vitem &$bounce_return_size_limit$&
12488 .vindex "&$bounce_return_size_limit$&"
12489 This contains the value set in the &%bounce_return_size_limit%& option, rounded
12490 up to a multiple of 1000. It is useful when a customized error message text
12491 file is in use (see chapter &<<CHAPemsgcust>>&).
12492
12493 .vitem &$caller_gid$&
12494 .cindex "gid (group id)" "caller"
12495 .vindex "&$caller_gid$&"
12496 The real group id under which the process that called Exim was running. This is
12497 not the same as the group id of the originator of a message (see
12498 &$originator_gid$&). If Exim re-execs itself, this variable in the new
12499 incarnation normally contains the Exim gid.
12500
12501 .vitem &$caller_uid$&
12502 .cindex "uid (user id)" "caller"
12503 .vindex "&$caller_uid$&"
12504 The real user id under which the process that called Exim was running. This is
12505 not the same as the user id of the originator of a message (see
12506 &$originator_uid$&). If Exim re-execs itself, this variable in the new
12507 incarnation normally contains the Exim uid.
12508
12509 .vitem &$callout_address$&
12510 .vindex "&$callout_address$&"
12511 After a callout for verification, spamd or malware daemon service, the
12512 address that was connected to.
12513
12514 .vitem &$compile_number$&
12515 .vindex "&$compile_number$&"
12516 The building process for Exim keeps a count of the number
12517 of times it has been compiled. This serves to distinguish different
12518 compilations of the same version of Exim.
12519
12520 .vitem &$config_dir$&
12521 .vindex "&$config_dir$&"
12522 The directory name of the main configuration file. That is, the content of
12523 &$config_file$& with the last component stripped. The value does not
12524 contain the trailing slash. If &$config_file$& does not contain a slash,
12525 &$config_dir$& is ".".
12526
12527 .vitem &$config_file$&
12528 .vindex "&$config_file$&"
12529 The name of the main configuration file Exim is using.
12530
12531 .vitem &$dkim_verify_status$&
12532 Results of DKIM verification.
12533 For details see section &<<SECDKIMVFY>>&.
12534
12535 .vitem &$dkim_cur_signer$& &&&
12536        &$dkim_verify_reason$& &&&
12537        &$dkim_domain$& &&&
12538        &$dkim_identity$& &&&
12539        &$dkim_selector$& &&&
12540        &$dkim_algo$& &&&
12541        &$dkim_canon_body$& &&&
12542        &$dkim_canon_headers$& &&&
12543        &$dkim_copiedheaders$& &&&
12544        &$dkim_bodylength$& &&&
12545        &$dkim_created$& &&&
12546        &$dkim_expires$& &&&
12547        &$dkim_headernames$& &&&
12548        &$dkim_key_testing$& &&&
12549        &$dkim_key_nosubdomains$& &&&
12550        &$dkim_key_srvtype$& &&&
12551        &$dkim_key_granularity$& &&&
12552        &$dkim_key_notes$& &&&
12553        &$dkim_key_length$&
12554 These variables are only available within the DKIM ACL.
12555 For details see section &<<SECDKIMVFY>>&.
12556
12557 .vitem &$dkim_signers$&
12558 .vindex &$dkim_signers$&
12559 When a message has been received this variable contains
12560 a colon-separated list of signer domains and identities for the message.
12561 For details see section &<<SECDKIMVFY>>&.
12562
12563 .vitem &$dmarc_domain_policy$& &&&
12564        &$dmarc_status$& &&&
12565        &$dmarc_status_text$& &&&
12566        &$dmarc_used_domains$&
12567 Results of DMARC verification.
12568 For details see section &<<SECDMARC>>&.
12569
12570 .vitem &$dnslist_domain$& &&&
12571        &$dnslist_matched$& &&&
12572        &$dnslist_text$& &&&
12573        &$dnslist_value$&
12574 .vindex "&$dnslist_domain$&"
12575 .vindex "&$dnslist_matched$&"
12576 .vindex "&$dnslist_text$&"
12577 .vindex "&$dnslist_value$&"
12578 .cindex "black list (DNS)"
12579 When a DNS (black) list lookup succeeds, these variables are set to contain
12580 the following data from the lookup: the list's domain name, the key that was
12581 looked up, the contents of any associated TXT record, and the value from the
12582 main A record. See section &<<SECID204>>& for more details.
12583
12584 .vitem &$domain$&
12585 .vindex "&$domain$&"
12586 When an address is being routed, or delivered on its own, this variable
12587 contains the domain. Uppercase letters in the domain are converted into lower
12588 case for &$domain$&.
12589
12590 Global address rewriting happens when a message is received, so the value of
12591 &$domain$& during routing and delivery is the value after rewriting. &$domain$&
12592 is set during user filtering, but not during system filtering, because a
12593 message may have many recipients and the system filter is called just once.
12594
12595 When more than one address is being delivered at once (for example, several
12596 RCPT commands in one SMTP delivery), &$domain$& is set only if they all
12597 have the same domain. Transports can be restricted to handling only one domain
12598 at a time if the value of &$domain$& is required at transport time &-- this is
12599 the default for local transports. For further details of the environment in
12600 which local transports are run, see chapter &<<CHAPenvironment>>&.
12601
12602 .oindex "&%delay_warning_condition%&"
12603 At the end of a delivery, if all deferred addresses have the same domain, it is
12604 set in &$domain$& during the expansion of &%delay_warning_condition%&.
12605
12606 The &$domain$& variable is also used in some other circumstances:
12607
12608 .ilist
12609 When an ACL is running for a RCPT command, &$domain$& contains the domain of
12610 the recipient address. The domain of the &'sender'& address is in
12611 &$sender_address_domain$& at both MAIL time and at RCPT time. &$domain$& is not
12612 normally set during the running of the MAIL ACL. However, if the sender address
12613 is verified with a callout during the MAIL ACL, the sender domain is placed in
12614 &$domain$& during the expansions of &%hosts%&, &%interface%&, and &%port%& in
12615 the &(smtp)& transport.
12616
12617 .next
12618 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
12619 &$domain$& contains the domain portion of the address that is being rewritten;
12620 it can be used in the expansion of the replacement address, for example, to
12621 rewrite domains by file lookup.
12622
12623 .next
12624 With one important exception, whenever a domain list is being scanned,
12625 &$domain$& contains the subject domain. &*Exception*&: When a domain list in
12626 a &%sender_domains%& condition in an ACL is being processed, the subject domain
12627 is in &$sender_address_domain$& and not in &$domain$&. It works this way so
12628 that, in a RCPT ACL, the sender domain list can be dependent on the
12629 recipient domain (which is what is in &$domain$& at this time).
12630
12631 .next
12632 .cindex "ETRN" "value of &$domain$&"
12633 .oindex "&%smtp_etrn_command%&"
12634 When the &%smtp_etrn_command%& option is being expanded, &$domain$& contains
12635 the complete argument of the ETRN command (see section &<<SECTETRN>>&).
12636 .endlist
12637
12638 .cindex "tainted data"
12639 If the origin of the data is an incoming message,
12640 the result of expanding this variable is tainted and may not
12641 be further expanded or used as a filename.
12642 When an untainted version is needed, one should be obtained from
12643 looking up the value in a local (therefore trusted) database.
12644 Often &$domain_data$& is usable in this role.
12645
12646
12647 .vitem &$domain_data$&
12648 .vindex "&$domain_data$&"
12649 When the &%domains%& condition on a router
12650 .new
12651 or an ACL
12652 matches a domain
12653 against a list, the match value is copied to &$domain_data$&.
12654 This is an enhancement over previous versions of Exim, when it only
12655 applied to the data read by a lookup.
12656 For details on match values see section &<<SECTlistresults>>& et. al.
12657 .wen
12658
12659 If the router routes the
12660 address to a transport, the value is available in that transport. If the
12661 transport is handling multiple addresses, the value from the first address is
12662 used.
12663
12664 &$domain_data$& set in an ACL is available during
12665 the rest of the ACL statement.
12666
12667 .vitem &$exim_gid$&
12668 .vindex "&$exim_gid$&"
12669 This variable contains the numerical value of the Exim group id.
12670
12671 .vitem &$exim_path$&
12672 .vindex "&$exim_path$&"
12673 This variable contains the path to the Exim binary.
12674
12675 .vitem &$exim_uid$&
12676 .vindex "&$exim_uid$&"
12677 This variable contains the numerical value of the Exim user id.
12678
12679 .vitem &$exim_version$&
12680 .vindex "&$exim_version$&"
12681 This variable contains the version string of the Exim build.
12682 The first character is a major version number, currently 4.
12683 Then after a dot, the next group of digits is a minor version number.
12684 There may be other characters following the minor version.
12685 This value may be overridden by the &%exim_version%& main config option.
12686
12687 .vitem &$header_$&<&'name'&>
12688 This is not strictly an expansion variable. It is expansion syntax for
12689 inserting the message header line with the given name. Note that the name must
12690 be terminated by colon or white space, because it may contain a wide variety of
12691 characters. Note also that braces must &'not'& be used.
12692 See the full description in section &<<SECTexpansionitems>>& above.
12693
12694 .vitem &$headers_added$&
12695 .vindex "&$headers_added$&"
12696 Within an ACL this variable contains the headers added so far by
12697 the ACL modifier add_header (section &<<SECTaddheadacl>>&).
12698 The headers are a newline-separated list.
12699
12700 .vitem &$home$&
12701 .vindex "&$home$&"
12702 When the &%check_local_user%& option is set for a router, the user's home
12703 directory is placed in &$home$& when the check succeeds. In particular, this
12704 means it is set during the running of users' filter files. A router may also
12705 explicitly set a home directory for use by a transport; this can be overridden
12706 by a setting on the transport itself.
12707
12708 When running a filter test via the &%-bf%& option, &$home$& is set to the value
12709 of the environment variable HOME, which is subject to the
12710 &%keep_environment%& and &%add_environment%& main config options.
12711
12712 .vitem &$host$&
12713 .vindex "&$host$&"
12714 If a router assigns an address to a transport (any transport), and passes a
12715 list of hosts with the address, the value of &$host$& when the transport starts
12716 to run is the name of the first host on the list. Note that this applies both
12717 to local and remote transports.
12718
12719 .cindex "transport" "filter"
12720 .cindex "filter" "transport filter"
12721 For the &(smtp)& transport, if there is more than one host, the value of
12722 &$host$& changes as the transport works its way through the list. In
12723 particular, when the &(smtp)& transport is expanding its options for encryption
12724 using TLS, or for specifying a transport filter (see chapter
12725 &<<CHAPtransportgeneric>>&), &$host$& contains the name of the host to which it
12726 is connected.
12727
12728 When used in the client part of an authenticator configuration (see chapter
12729 &<<CHAPSMTPAUTH>>&), &$host$& contains the name of the server to which the
12730 client is connected.
12731
12732
12733 .vitem &$host_address$&
12734 .vindex "&$host_address$&"
12735 This variable is set to the remote host's IP address whenever &$host$& is set
12736 for a remote connection. It is also set to the IP address that is being checked
12737 when the &%ignore_target_hosts%& option is being processed.
12738
12739 .vitem &$host_data$&
12740 .vindex "&$host_data$&"
12741 If a &%hosts%& condition in an ACL is satisfied by means of a lookup, the
12742 result of the lookup is made available in the &$host_data$& variable. This
12743 allows you, for example, to do things like this:
12744 .code
12745 deny  hosts = net-lsearch;/some/file
12746       message = $host_data
12747 .endd
12748 .vitem &$host_lookup_deferred$&
12749 .cindex "host name" "lookup, failure of"
12750 .vindex "&$host_lookup_deferred$&"
12751 This variable normally contains &"0"&, as does &$host_lookup_failed$&. When a
12752 message comes from a remote host and there is an attempt to look up the host's
12753 name from its IP address, and the attempt is not successful, one of these
12754 variables is set to &"1"&.
12755
12756 .ilist
12757 If the lookup receives a definite negative response (for example, a DNS lookup
12758 succeeded, but no records were found), &$host_lookup_failed$& is set to &"1"&.
12759
12760 .next
12761 If there is any kind of problem during the lookup, such that Exim cannot
12762 tell whether or not the host name is defined (for example, a timeout for a DNS
12763 lookup), &$host_lookup_deferred$& is set to &"1"&.
12764 .endlist ilist
12765
12766 Looking up a host's name from its IP address consists of more than just a
12767 single reverse lookup. Exim checks that a forward lookup of at least one of the
12768 names it receives from a reverse lookup yields the original IP address. If this
12769 is not the case, Exim does not accept the looked up name(s), and
12770 &$host_lookup_failed$& is set to &"1"&. Thus, being able to find a name from an
12771 IP address (for example, the existence of a PTR record in the DNS) is not
12772 sufficient on its own for the success of a host name lookup. If the reverse
12773 lookup succeeds, but there is a lookup problem such as a timeout when checking
12774 the result, the name is not accepted, and &$host_lookup_deferred$& is set to
12775 &"1"&. See also &$sender_host_name$&.
12776
12777 .cindex authentication "expansion item"
12778 Performing these checks sets up information used by the
12779 &%authresults%& expansion item.
12780
12781
12782 .vitem &$host_lookup_failed$&
12783 .vindex "&$host_lookup_failed$&"
12784 See &$host_lookup_deferred$&.
12785
12786 .vitem &$host_port$&
12787 .vindex "&$host_port$&"
12788 This variable is set to the remote host's TCP port whenever &$host$& is set
12789 for an outbound connection.
12790
12791 .vitem &$initial_cwd$&
12792 .vindex "&$initial_cwd$&
12793 This variable contains the full path name of the initial working
12794 directory of the current Exim process. This may differ from the current
12795 working directory, as Exim changes this to "/" during early startup, and
12796 to &$spool_directory$& later.
12797
12798 .vitem &$inode$&
12799 .vindex "&$inode$&"
12800 The only time this variable is set is while expanding the &%directory_file%&
12801 option in the &(appendfile)& transport. The variable contains the inode number
12802 of the temporary file which is about to be renamed. It can be used to construct
12803 a unique name for the file.
12804
12805 .vitem &$interface_address$&
12806 .vindex "&$interface_address$&"
12807 This is an obsolete name for &$received_ip_address$&.
12808
12809 .vitem &$interface_port$&
12810 .vindex "&$interface_port$&"
12811 This is an obsolete name for &$received_port$&.
12812
12813 .vitem &$item$&
12814 .vindex "&$item$&"
12815 This variable is used during the expansion of &*forall*& and &*forany*&
12816 conditions (see section &<<SECTexpcond>>&), and &*filter*&, &*map*&, and
12817 &*reduce*& items (see section &<<SECTexpcond>>&). In other circumstances, it is
12818 empty.
12819
12820 .vitem &$ldap_dn$&
12821 .vindex "&$ldap_dn$&"
12822 This variable, which is available only when Exim is compiled with LDAP support,
12823 contains the DN from the last entry in the most recently successful LDAP
12824 lookup.
12825
12826 .vitem &$load_average$&
12827 .vindex "&$load_average$&"
12828 This variable contains the system load average, multiplied by 1000 so that it
12829 is an integer. For example, if the load average is 0.21, the value of the
12830 variable is 210. The value is recomputed every time the variable is referenced.
12831
12832 .vitem &$local_part$&
12833 .vindex "&$local_part$&"
12834 When an address is being routed, or delivered on its own, this
12835 variable contains the local part. When a number of addresses are being
12836 delivered together (for example, multiple RCPT commands in an SMTP
12837 session), &$local_part$& is not set.
12838
12839 Global address rewriting happens when a message is received, so the value of
12840 &$local_part$& during routing and delivery is the value after rewriting.
12841 &$local_part$& is set during user filtering, but not during system filtering,
12842 because a message may have many recipients and the system filter is called just
12843 once.
12844
12845 .cindex "tainted data"
12846 If the origin of the data is an incoming message,
12847 the result of expanding this variable is tainted and
12848 may not be further expanded or used as a filename.
12849
12850 &*Warning*&: the content of this variable is usually provided by a potential
12851 attacker.
12852 Consider carefully the implications of using it unvalidated as a name
12853 for file access.
12854 This presents issues for users' &_.forward_& and filter files.
12855 For traditional full user accounts, use &%check_local_users%& and the
12856 &$local_part_data$& variable rather than this one.
12857 For virtual users, store a suitable pathname component in the database
12858 which is used for account name validation, and use that retrieved value
12859 rather than this variable.
12860 Often &$local_part_data$& is usable in this role.
12861 If needed, use a router &%address_data%& or &%set%& option for
12862 the retrieved data.
12863
12864 When a message is being delivered to a file, pipe, or autoreply transport as a
12865 result of aliasing or forwarding, &$local_part$& is set to the local part of
12866 the parent address, not to the filename or command (see &$address_file$& and
12867 &$address_pipe$&).
12868
12869 When an ACL is running for a RCPT command, &$local_part$& contains the
12870 local part of the recipient address.
12871
12872 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
12873 &$local_part$& contains the local part of the address that is being rewritten;
12874 it can be used in the expansion of the replacement address, for example.
12875
12876 In all cases, all quoting is removed from the local part. For example, for both
12877 the addresses
12878 .code
12879 "abc:xyz"@test.example
12880 abc\:xyz@test.example
12881 .endd
12882 the value of &$local_part$& is
12883 .code
12884 abc:xyz
12885 .endd
12886 If you use &$local_part$& to create another address, you should always wrap it
12887 inside a quoting operator. For example, in a &(redirect)& router you could
12888 have:
12889 .code
12890 data = ${quote_local_part:$local_part}@new.domain.example
12891 .endd
12892 &*Note*&: The value of &$local_part$& is normally lower cased. If you want
12893 to process local parts in a case-dependent manner in a router, you can set the
12894 &%caseful_local_part%& option (see chapter &<<CHAProutergeneric>>&).
12895
12896 .vitem &$local_part_data$&
12897 .vindex "&$local_part_data$&"
12898 When the &%local_parts%& condition on a router or ACL
12899 matches a local part list
12900 .new
12901 the match value is copied to &$local_part_data$&.
12902 This is an enhancement over previous versions of Exim, when it only
12903 applied to the data read by a lookup.
12904 For details on match values see section &<<SECTlistresults>>& et. al.
12905 .wen
12906
12907 The &%check_local_user%& router option also sets this variable.
12908
12909 .vindex &$local_part_prefix$& &&&
12910         &$local_part_prefix_v$& &&&
12911         &$local_part_suffix$& &&&
12912         &$local_part_suffix_v$&
12913 .cindex affix variables
12914 If a local part prefix or suffix has been recognized, it is not included in the
12915 value of &$local_part$& during routing and subsequent delivery. The values of
12916 any prefix or suffix are in &$local_part_prefix$& and
12917 &$local_part_suffix$&, respectively.
12918 .cindex "tainted data"
12919 If the specification did not include a wildcard then
12920 the affix variable value is not tainted.
12921
12922 If the affix specification included a wildcard then the portion of
12923 the affix matched by the wildcard is in
12924 &$local_part_prefix_v$& or &$local_part_suffix_v$& as appropriate,
12925 and both the whole and varying values are tainted.
12926
12927 .vitem &$local_scan_data$&
12928 .vindex "&$local_scan_data$&"
12929 This variable contains the text returned by the &[local_scan()]& function when
12930 a message is received. See chapter &<<CHAPlocalscan>>& for more details.
12931
12932 .vitem &$local_user_gid$&
12933 .vindex "&$local_user_gid$&"
12934 See &$local_user_uid$&.
12935
12936 .vitem &$local_user_uid$&
12937 .vindex "&$local_user_uid$&"
12938 This variable and &$local_user_gid$& are set to the uid and gid after the
12939 &%check_local_user%& router precondition succeeds. This means that their values
12940 are available for the remaining preconditions (&%senders%&, &%require_files%&,
12941 and &%condition%&), for the &%address_data%& expansion, and for any
12942 router-specific expansions. At all other times, the values in these variables
12943 are &`(uid_t)(-1)`& and &`(gid_t)(-1)`&, respectively.
12944
12945 .vitem &$localhost_number$&
12946 .vindex "&$localhost_number$&"
12947 This contains the expanded value of the
12948 &%localhost_number%& option. The expansion happens after the main options have
12949 been read.
12950
12951 .vitem &$log_inodes$&
12952 .vindex "&$log_inodes$&"
12953 The number of free inodes in the disk partition where Exim's
12954 log files are being written. The value is recalculated whenever the variable is
12955 referenced. If the relevant file system does not have the concept of inodes,
12956 the value of is -1. See also the &%check_log_inodes%& option.
12957
12958 .vitem &$log_space$&
12959 .vindex "&$log_space$&"
12960 The amount of free space (as a number of kilobytes) in the disk
12961 partition where Exim's log files are being written. The value is recalculated
12962 whenever the variable is referenced. If the operating system does not have the
12963 ability to find the amount of free space (only true for experimental systems),
12964 the space value is -1. See also the &%check_log_space%& option.
12965
12966
12967 .vitem &$lookup_dnssec_authenticated$&
12968 .vindex "&$lookup_dnssec_authenticated$&"
12969 This variable is set after a DNS lookup done by
12970 a dnsdb lookup expansion, dnslookup router or smtp transport.
12971 .cindex "DNS" "DNSSEC"
12972 It will be empty if &(DNSSEC)& was not requested,
12973 &"no"& if the result was not labelled as authenticated data
12974 and &"yes"& if it was.
12975 Results that are labelled as authoritative answer that match
12976 the &%dns_trust_aa%& configuration variable count also
12977 as authenticated data.
12978
12979 .vitem &$mailstore_basename$&
12980 .vindex "&$mailstore_basename$&"
12981 This variable is set only when doing deliveries in &"mailstore"& format in the
12982 &(appendfile)& transport. During the expansion of the &%mailstore_prefix%&,
12983 &%mailstore_suffix%&, &%message_prefix%&, and &%message_suffix%& options, it
12984 contains the basename of the files that are being written, that is, the name
12985 without the &".tmp"&, &".env"&, or &".msg"& suffix. At all other times, this
12986 variable is empty.
12987
12988 .vitem &$malware_name$&
12989 .vindex "&$malware_name$&"
12990 This variable is available when Exim is compiled with the
12991 content-scanning extension. It is set to the name of the virus that was found
12992 when the ACL &%malware%& condition is true (see section &<<SECTscanvirus>>&).
12993
12994 .vitem &$max_received_linelength$&
12995 .vindex "&$max_received_linelength$&"
12996 .cindex "maximum" "line length"
12997 .cindex "line length" "maximum"
12998 This variable contains the number of bytes in the longest line that was
12999 received as part of the message, not counting the line termination
13000 character(s).
13001 It is not valid if the &%spool_files_wireformat%& option is used.
13002
13003 .vitem &$message_age$&
13004 .cindex "message" "age of"
13005 .vindex "&$message_age$&"
13006 This variable is set at the start of a delivery attempt to contain the number
13007 of seconds since the message was received. It does not change during a single
13008 delivery attempt.
13009
13010 .vitem &$message_body$&
13011 .cindex "body of message" "expansion variable"
13012 .cindex "message body" "in expansion"
13013 .cindex "binary zero" "in message body"
13014 .vindex "&$message_body$&"
13015 .oindex "&%message_body_visible%&"
13016 This variable contains the initial portion of a message's body while it is
13017 being delivered, and is intended mainly for use in filter files. The maximum
13018 number of characters of the body that are put into the variable is set by the
13019 &%message_body_visible%& configuration option; the default is 500.
13020
13021 .oindex "&%message_body_newlines%&"
13022 By default, newlines are converted into spaces in &$message_body$&, to make it
13023 easier to search for phrases that might be split over a line break. However,
13024 this can be disabled by setting &%message_body_newlines%& to be true. Binary
13025 zeros are always converted into spaces.
13026
13027 .vitem &$message_body_end$&
13028 .cindex "body of message" "expansion variable"
13029 .cindex "message body" "in expansion"
13030 .vindex "&$message_body_end$&"
13031 This variable contains the final portion of a message's
13032 body while it is being delivered. The format and maximum size are as for
13033 &$message_body$&.
13034
13035 .vitem &$message_body_size$&
13036 .cindex "body of message" "size"
13037 .cindex "message body" "size"
13038 .vindex "&$message_body_size$&"
13039 When a message is being delivered, this variable contains the size of the body
13040 in bytes. The count starts from the character after the blank line that
13041 separates the body from the header. Newlines are included in the count. See
13042 also &$message_size$&, &$body_linecount$&, and &$body_zerocount$&.
13043
13044 If the spool file is wireformat
13045 (see the &%spool_files_wireformat%& main option)
13046 the CRLF line-terminators are included in the count.
13047
13048 .vitem &$message_exim_id$&
13049 .vindex "&$message_exim_id$&"
13050 When a message is being received or delivered, this variable contains the
13051 unique message id that is generated and used by Exim to identify the message.
13052 An id is not created for a message until after its header has been successfully
13053 received. &*Note*&: This is &'not'& the contents of the &'Message-ID:'& header
13054 line; it is the local id that Exim assigns to the message, for example:
13055 &`1BXTIK-0001yO-VA`&.
13056
13057 .vitem &$message_headers$&
13058 .vindex &$message_headers$&
13059 This variable contains a concatenation of all the header lines when a message
13060 is being processed, except for lines added by routers or transports. The header
13061 lines are separated by newline characters. Their contents are decoded in the
13062 same way as a header line that is inserted by &%bheader%&.
13063
13064 .vitem &$message_headers_raw$&
13065 .vindex &$message_headers_raw$&
13066 This variable is like &$message_headers$& except that no processing of the
13067 contents of header lines is done.
13068
13069 .vitem &$message_id$&
13070 This is an old name for &$message_exim_id$&. It is now deprecated.
13071
13072 .vitem &$message_linecount$&
13073 .vindex "&$message_linecount$&"
13074 This variable contains the total number of lines in the header and body of the
13075 message. Compare &$body_linecount$&, which is the count for the body only.
13076 During the DATA and content-scanning ACLs, &$message_linecount$& contains the
13077 number of lines received. Before delivery happens (that is, before filters,
13078 routers, and transports run) the count is increased to include the
13079 &'Received:'& header line that Exim standardly adds, and also any other header
13080 lines that are added by ACLs. The blank line that separates the message header
13081 from the body is not counted.
13082
13083 As with the special case of &$message_size$&, during the expansion of the
13084 appendfile transport's maildir_tag option in maildir format, the value of
13085 &$message_linecount$& is the precise size of the number of newlines in the
13086 file that has been written (minus one for the blank line between the
13087 header and the body).
13088
13089 Here is an example of the use of this variable in a DATA ACL:
13090 .code
13091 deny condition = \
13092       ${if <{250}{${eval:$message_linecount - $body_linecount}}}
13093      message   = Too many lines in message header
13094 .endd
13095 In the MAIL and RCPT ACLs, the value is zero because at that stage the
13096 message has not yet been received.
13097
13098 This variable is not valid if the &%spool_files_wireformat%& option is used.
13099
13100 .vitem &$message_size$&
13101 .cindex "size" "of message"
13102 .cindex "message" "size"
13103 .vindex "&$message_size$&"
13104 When a message is being processed, this variable contains its size in bytes. In
13105 most cases, the size includes those headers that were received with the
13106 message, but not those (such as &'Envelope-to:'&) that are added to individual
13107 deliveries as they are written. However, there is one special case: during the
13108 expansion of the &%maildir_tag%& option in the &(appendfile)& transport while
13109 doing a delivery in maildir format, the value of &$message_size$& is the
13110 precise size of the file that has been written. See also
13111 &$message_body_size$&, &$body_linecount$&, and &$body_zerocount$&.
13112
13113 .cindex "RCPT" "value of &$message_size$&"
13114 While running a per message ACL (mail/rcpt/predata), &$message_size$&
13115 contains the size supplied on the MAIL command, or -1 if no size was given. The
13116 value may not, of course, be truthful.
13117
13118 .vitem &$mime_anomaly_level$& &&&
13119        &$mime_anomaly_text$& &&&
13120        &$mime_boundary$& &&&
13121        &$mime_charset$& &&&
13122        &$mime_content_description$& &&&
13123        &$mime_content_disposition$& &&&
13124        &$mime_content_id$& &&&
13125        &$mime_content_size$& &&&
13126        &$mime_content_transfer_encoding$& &&&
13127        &$mime_content_type$& &&&
13128        &$mime_decoded_filename$& &&&
13129        &$mime_filename$& &&&
13130        &$mime_is_coverletter$& &&&
13131        &$mime_is_multipart$& &&&
13132        &$mime_is_rfc822$& &&&
13133        &$mime_part_count$&
13134 A number of variables whose names start with &$mime$& are
13135 available when Exim is compiled with the content-scanning extension. For
13136 details, see section &<<SECTscanmimepart>>&.
13137
13138 .vitem "&$n0$& &-- &$n9$&"
13139 These variables are counters that can be incremented by means
13140 of the &%add%& command in filter files.
13141
13142 .vitem &$original_domain$&
13143 .vindex "&$domain$&"
13144 .vindex "&$original_domain$&"
13145 When a top-level address is being processed for delivery, this contains the
13146 same value as &$domain$&. However, if a &"child"& address (for example,
13147 generated by an alias, forward, or filter file) is being processed, this
13148 variable contains the domain of the original address (lower cased). This
13149 differs from &$parent_domain$& only when there is more than one level of
13150 aliasing or forwarding. When more than one address is being delivered in a
13151 single transport run, &$original_domain$& is not set.
13152
13153 If a new address is created by means of a &%deliver%& command in a system
13154 filter, it is set up with an artificial &"parent"& address. This has the local
13155 part &'system-filter'& and the default qualify domain.
13156
13157 .vitem &$original_local_part$&
13158 .vindex "&$local_part$&"
13159 .vindex "&$original_local_part$&"
13160 When a top-level address is being processed for delivery, this contains the
13161 same value as &$local_part$&, unless a prefix or suffix was removed from the
13162 local part, because &$original_local_part$& always contains the full local
13163 part. When a &"child"& address (for example, generated by an alias, forward, or
13164 filter file) is being processed, this variable contains the full local part of
13165 the original address.
13166
13167 If the router that did the redirection processed the local part
13168 case-insensitively, the value in &$original_local_part$& is in lower case.
13169 This variable differs from &$parent_local_part$& only when there is more than
13170 one level of aliasing or forwarding. When more than one address is being
13171 delivered in a single transport run, &$original_local_part$& is not set.
13172
13173 If a new address is created by means of a &%deliver%& command in a system
13174 filter, it is set up with an artificial &"parent"& address. This has the local
13175 part &'system-filter'& and the default qualify domain.
13176
13177 .vitem &$originator_gid$&
13178 .cindex "gid (group id)" "of originating user"
13179 .cindex "sender" "gid"
13180 .vindex "&$caller_gid$&"
13181 .vindex "&$originator_gid$&"
13182 This variable contains the value of &$caller_gid$& that was set when the
13183 message was received. For messages received via the command line, this is the
13184 gid of the sending user. For messages received by SMTP over TCP/IP, this is
13185 normally the gid of the Exim user.
13186
13187 .vitem &$originator_uid$&
13188 .cindex "uid (user id)" "of originating user"
13189 .cindex "sender" "uid"
13190 .vindex "&$caller_uid$&"
13191 .vindex "&$originator_uid$&"
13192 The value of &$caller_uid$& that was set when the message was received. For
13193 messages received via the command line, this is the uid of the sending user.
13194 For messages received by SMTP over TCP/IP, this is normally the uid of the Exim
13195 user.
13196
13197 .vitem &$parent_domain$&
13198 .vindex "&$parent_domain$&"
13199 This variable is similar to &$original_domain$& (see
13200 above), except that it refers to the immediately preceding parent address.
13201
13202 .vitem &$parent_local_part$&
13203 .vindex "&$parent_local_part$&"
13204 This variable is similar to &$original_local_part$&
13205 (see above), except that it refers to the immediately preceding parent address.
13206
13207 .vitem &$pid$&
13208 .cindex "pid (process id)" "of current process"
13209 .vindex "&$pid$&"
13210 This variable contains the current process id.
13211
13212 .vitem &$pipe_addresses$&
13213 .cindex "filter" "transport filter"
13214 .cindex "transport" "filter"
13215 .vindex "&$pipe_addresses$&"
13216 This is not an expansion variable, but is mentioned here because the string
13217 &`$pipe_addresses`& is handled specially in the command specification for the
13218 &(pipe)& transport (chapter &<<CHAPpipetransport>>&) and in transport filters
13219 (described under &%transport_filter%& in chapter &<<CHAPtransportgeneric>>&).
13220 It cannot be used in general expansion strings, and provokes an &"unknown
13221 variable"& error if encountered.
13222
13223 .vitem &$primary_hostname$&
13224 .vindex "&$primary_hostname$&"
13225 This variable contains the value set by &%primary_hostname%& in the
13226 configuration file, or read by the &[uname()]& function. If &[uname()]& returns
13227 a single-component name, Exim calls &[gethostbyname()]& (or
13228 &[getipnodebyname()]& where available) in an attempt to acquire a fully
13229 qualified host name. See also &$smtp_active_hostname$&.
13230
13231
13232 .vitem &$proxy_external_address$& &&&
13233        &$proxy_external_port$& &&&
13234        &$proxy_local_address$& &&&
13235        &$proxy_local_port$& &&&
13236        &$proxy_session$&
13237 These variables are only available when built with Proxy Protocol
13238 or SOCKS5 support.
13239 For details see chapter &<<SECTproxyInbound>>&.
13240
13241 .vitem &$prdr_requested$&
13242 .cindex "PRDR" "variable for"
13243 This variable is set to &"yes"& if PRDR was requested by the client for the
13244 current message, otherwise &"no"&.
13245
13246 .vitem &$prvscheck_address$& &&&
13247        &$prvscheck_keynum$& &&&
13248        &$prvscheck_result$&
13249 These variables are used in conjunction with the &%prvscheck%& expansion item,
13250 which is described in sections &<<SECTexpansionitems>>& and
13251 &<<SECTverifyPRVS>>&.
13252
13253 .vitem &$qualify_domain$&
13254 .vindex "&$qualify_domain$&"
13255 The value set for the &%qualify_domain%& option in the configuration file.
13256
13257 .vitem &$qualify_recipient$&
13258 .vindex "&$qualify_recipient$&"
13259 The value set for the &%qualify_recipient%& option in the configuration file,
13260 or if not set, the value of &$qualify_domain$&.
13261
13262 .vitem &$queue_name$&
13263 .vindex &$queue_name$&
13264 .cindex "named queues" variable
13265 .cindex queues named
13266 The name of the spool queue in use; empty for the default queue.
13267
13268 .vitem &$queue_size$&
13269 .vindex "&$queue_size$&"
13270 .cindex "queue" "size of"
13271 .cindex "spool" "number of messages"
13272 This variable contains the number of messages queued.
13273 It is evaluated on demand, but no more often than once every minute.
13274 If there is no daemon notifier socket open, the value will be
13275 an empty string.
13276
13277 .vitem &$r_...$&
13278 .vindex &$r_...$&
13279 .cindex router variables
13280 Values can be placed in these variables by the &%set%& option of a router.
13281 They can be given any name that starts with &$r_$&.
13282 The values persist for the address being handled through subsequent routers
13283 and the eventual transport.
13284
13285 .vitem &$rcpt_count$&
13286 .vindex "&$rcpt_count$&"
13287 When a message is being received by SMTP, this variable contains the number of
13288 RCPT commands received for the current message. If this variable is used in a
13289 RCPT ACL, its value includes the current command.
13290
13291 .vitem &$rcpt_defer_count$&
13292 .vindex "&$rcpt_defer_count$&"
13293 .cindex "4&'xx'& responses" "count of"
13294 When a message is being received by SMTP, this variable contains the number of
13295 RCPT commands in the current message that have previously been rejected with a
13296 temporary (4&'xx'&) response.
13297
13298 .vitem &$rcpt_fail_count$&
13299 .vindex "&$rcpt_fail_count$&"
13300 When a message is being received by SMTP, this variable contains the number of
13301 RCPT commands in the current message that have previously been rejected with a
13302 permanent (5&'xx'&) response.
13303
13304 .vitem &$received_count$&
13305 .vindex "&$received_count$&"
13306 This variable contains the number of &'Received:'& header lines in the message,
13307 including the one added by Exim (so its value is always greater than zero). It
13308 is available in the DATA ACL, the non-SMTP ACL, and while routing and
13309 delivering.
13310
13311 .vitem &$received_for$&
13312 .vindex "&$received_for$&"
13313 If there is only a single recipient address in an incoming message, this
13314 variable contains that address when the &'Received:'& header line is being
13315 built. The value is copied after recipient rewriting has happened, but before
13316 the &[local_scan()]& function is run.
13317
13318 .vitem &$received_ip_address$&
13319 .vindex "&$received_ip_address$&"
13320 As soon as an Exim server starts processing an incoming TCP/IP connection, this
13321 variable is set to the address of the local IP interface, and &$received_port$&
13322 is set to the local port number. (The remote IP address and port are in
13323 &$sender_host_address$& and &$sender_host_port$&.) When testing with &%-bh%&,
13324 the port value is -1 unless it has been set using the &%-oMi%& command line
13325 option.
13326
13327 As well as being useful in ACLs (including the &"connect"& ACL), these variable
13328 could be used, for example, to make the filename for a TLS certificate depend
13329 on which interface and/or port is being used for the incoming connection. The
13330 values of &$received_ip_address$& and &$received_port$& are saved with any
13331 messages that are received, thus making these variables available at delivery
13332 time.
13333 For outbound connections see &$sending_ip_address$&.
13334
13335 .vitem &$received_port$&
13336 .vindex "&$received_port$&"
13337 See &$received_ip_address$&.
13338
13339 .vitem &$received_protocol$&
13340 .vindex "&$received_protocol$&"
13341 When a message is being processed, this variable contains the name of the
13342 protocol by which it was received. Most of the names used by Exim are defined
13343 by RFCs 821, 2821, and 3848. They start with &"smtp"& (the client used HELO) or
13344 &"esmtp"& (the client used EHLO). This can be followed by &"s"& for secure
13345 (encrypted) and/or &"a"& for authenticated. Thus, for example, if the protocol
13346 is set to &"esmtpsa"&, the message was received over an encrypted SMTP
13347 connection and the client was successfully authenticated.
13348
13349 Exim uses the protocol name &"smtps"& for the case when encryption is
13350 automatically set up on connection without the use of STARTTLS (see
13351 &%tls_on_connect_ports%&), and the client uses HELO to initiate the
13352 encrypted SMTP session. The name &"smtps"& is also used for the rare situation
13353 where the client initially uses EHLO, sets up an encrypted connection using
13354 STARTTLS, and then uses HELO afterwards.
13355
13356 The &%-oMr%& option provides a way of specifying a custom protocol name for
13357 messages that are injected locally by trusted callers. This is commonly used to
13358 identify messages that are being re-injected after some kind of scanning.
13359
13360 .vitem &$received_time$&
13361 .vindex "&$received_time$&"
13362 This variable contains the date and time when the current message was received,
13363 as a number of seconds since the start of the Unix epoch.
13364
13365 .vitem &$recipient_data$&
13366 .vindex "&$recipient_data$&"
13367 This variable is set after an indexing lookup success in an ACL &%recipients%&
13368 condition. It contains the data from the lookup, and the value remains set
13369 until the next &%recipients%& test. Thus, you can do things like this:
13370 .display
13371 &`require recipients  = cdb*@;/some/file`&
13372 &`deny    `&&'some further test involving'& &`$recipient_data`&
13373 .endd
13374 &*Warning*&: This variable is set only when a lookup is used as an indexing
13375 method in the address list, using the semicolon syntax as in the example above.
13376 The variable is not set for a lookup that is used as part of the string
13377 expansion that all such lists undergo before being interpreted.
13378
13379 .vitem &$recipient_verify_failure$&
13380 .vindex "&$recipient_verify_failure$&"
13381 In an ACL, when a recipient verification fails, this variable contains
13382 information about the failure. It is set to one of the following words:
13383
13384 .ilist
13385 &"qualify"&: The address was unqualified (no domain), and the message
13386 was neither local nor came from an exempted host.
13387
13388 .next
13389 &"route"&: Routing failed.
13390
13391 .next
13392 &"mail"&: Routing succeeded, and a callout was attempted; rejection occurred at
13393 or before the MAIL command (that is, on initial connection, HELO, or
13394 MAIL).
13395
13396 .next
13397 &"recipient"&: The RCPT command in a callout was rejected.
13398 .next
13399
13400 &"postmaster"&: The postmaster check in a callout was rejected.
13401 .endlist
13402
13403 The main use of this variable is expected to be to distinguish between
13404 rejections of MAIL and rejections of RCPT.
13405
13406 .vitem &$recipients$&
13407 .vindex "&$recipients$&"
13408 This variable contains a list of envelope recipients for a message. A comma and
13409 a space separate the addresses in the replacement text. However, the variable
13410 is not generally available, to prevent exposure of Bcc recipients in
13411 unprivileged users' filter files. You can use &$recipients$& only in these
13412 cases:
13413
13414 .olist
13415 In a system filter file.
13416 .next
13417 In the ACLs associated with the DATA command and with non-SMTP messages, that
13418 is, the ACLs defined by &%acl_smtp_predata%&, &%acl_smtp_data%&,
13419 &%acl_smtp_mime%&, &%acl_not_smtp_start%&, &%acl_not_smtp%&, and
13420 &%acl_not_smtp_mime%&.
13421 .next
13422 From within a &[local_scan()]& function.
13423 .endlist
13424
13425
13426 .vitem &$recipients_count$&
13427 .vindex "&$recipients_count$&"
13428 When a message is being processed, this variable contains the number of
13429 envelope recipients that came with the message. Duplicates are not excluded
13430 from the count. While a message is being received over SMTP, the number
13431 increases for each accepted recipient. It can be referenced in an ACL.
13432
13433
13434 .vitem &$regex_match_string$&
13435 .vindex "&$regex_match_string$&"
13436 This variable is set to contain the matching regular expression after a
13437 &%regex%& ACL condition has matched (see section &<<SECTscanregex>>&).
13438
13439 .vitem "&$regex1$&, &$regex2$&, etc"
13440 .cindex "regex submatch variables (&$1regex$& &$2regex$& etc)"
13441 When a &%regex%& or &%mime_regex%& ACL condition succeeds,
13442 these variables contain the
13443 captured substrings identified by the regular expression.
13444
13445
13446 .vitem &$reply_address$&
13447 .vindex "&$reply_address$&"
13448 When a message is being processed, this variable contains the contents of the
13449 &'Reply-To:'& header line if one exists and it is not empty, or otherwise the
13450 contents of the &'From:'& header line. Apart from the removal of leading
13451 white space, the value is not processed in any way. In particular, no RFC 2047
13452 decoding or character code translation takes place.
13453
13454 .vitem &$return_path$&
13455 .vindex "&$return_path$&"
13456 When a message is being delivered, this variable contains the return path &--
13457 the sender field that will be sent as part of the envelope. It is not enclosed
13458 in <> characters. At the start of routing an address, &$return_path$& has the
13459 same value as &$sender_address$&, but if, for example, an incoming message to a
13460 mailing list has been expanded by a router which specifies a different address
13461 for bounce messages, &$return_path$& subsequently contains the new bounce
13462 address, whereas &$sender_address$& always contains the original sender address
13463 that was received with the message. In other words, &$sender_address$& contains
13464 the incoming envelope sender, and &$return_path$& contains the outgoing
13465 envelope sender.
13466
13467 .vitem &$return_size_limit$&
13468 .vindex "&$return_size_limit$&"
13469 This is an obsolete name for &$bounce_return_size_limit$&.
13470
13471 .vitem &$router_name$&
13472 .cindex "router" "name"
13473 .cindex "name" "of router"
13474 .vindex "&$router_name$&"
13475 During the running of a router this variable contains its name.
13476
13477 .vitem &$runrc$&
13478 .cindex "return code" "from &%run%& expansion"
13479 .vindex "&$runrc$&"
13480 This variable contains the return code from a command that is run by the
13481 &%${run...}%& expansion item. &*Warning*&: In a router or transport, you cannot
13482 assume the order in which option values are expanded, except for those
13483 preconditions whose order of testing is documented. Therefore, you cannot
13484 reliably expect to set &$runrc$& by the expansion of one option, and use it in
13485 another.
13486
13487 .vitem &$self_hostname$&
13488 .oindex "&%self%&" "value of host name"
13489 .vindex "&$self_hostname$&"
13490 When an address is routed to a supposedly remote host that turns out to be the
13491 local host, what happens is controlled by the &%self%& generic router option.
13492 One of its values causes the address to be passed to another router. When this
13493 happens, &$self_hostname$& is set to the name of the local host that the
13494 original router encountered. In other circumstances its contents are null.
13495
13496 .vitem &$sender_address$&
13497 .vindex "&$sender_address$&"
13498 When a message is being processed, this variable contains the sender's address
13499 that was received in the message's envelope. The case of letters in the address
13500 is retained, in both the local part and the domain. For bounce messages, the
13501 value of this variable is the empty string. See also &$return_path$&.
13502
13503 .vitem &$sender_address_data$&
13504 .vindex "&$address_data$&"
13505 .vindex "&$sender_address_data$&"
13506 If &$address_data$& is set when the routers are called from an ACL to verify a
13507 sender address, the final value is preserved in &$sender_address_data$&, to
13508 distinguish it from data from a recipient address. The value does not persist
13509 after the end of the current ACL statement. If you want to preserve it for
13510 longer, you can save it in an ACL variable.
13511
13512 .vitem &$sender_address_domain$&
13513 .vindex "&$sender_address_domain$&"
13514 The domain portion of &$sender_address$&.
13515
13516 .vitem &$sender_address_local_part$&
13517 .vindex "&$sender_address_local_part$&"
13518 The local part portion of &$sender_address$&.
13519
13520 .vitem &$sender_data$&
13521 .vindex "&$sender_data$&"
13522 This variable is set after a lookup success in an ACL &%senders%& condition or
13523 in a router &%senders%& option. It contains the data from the lookup, and the
13524 value remains set until the next &%senders%& test. Thus, you can do things like
13525 this:
13526 .display
13527 &`require senders      = cdb*@;/some/file`&
13528 &`deny    `&&'some further test involving'& &`$sender_data`&
13529 .endd
13530 &*Warning*&: This variable is set only when a lookup is used as an indexing
13531 method in the address list, using the semicolon syntax as in the example above.
13532 The variable is not set for a lookup that is used as part of the string
13533 expansion that all such lists undergo before being interpreted.
13534
13535 .vitem &$sender_fullhost$&
13536 .vindex "&$sender_fullhost$&"
13537 When a message is received from a remote host, this variable contains the host
13538 name and IP address in a single string. It ends with the IP address in square
13539 brackets, followed by a colon and a port number if the logging of ports is
13540 enabled. The format of the rest of the string depends on whether the host
13541 issued a HELO or EHLO SMTP command, and whether the host name was verified by
13542 looking up its IP address. (Looking up the IP address can be forced by the
13543 &%host_lookup%& option, independent of verification.) A plain host name at the
13544 start of the string is a verified host name; if this is not present,
13545 verification either failed or was not requested. A host name in parentheses is
13546 the argument of a HELO or EHLO command. This is omitted if it is identical to
13547 the verified host name or to the host's IP address in square brackets.
13548
13549 .vitem &$sender_helo_dnssec$&
13550 .vindex "&$sender_helo_dnssec$&"
13551 This boolean variable is true if a successful HELO verification was
13552 .cindex "DNS" "DNSSEC"
13553 done using DNS information the resolver library stated was authenticated data.
13554
13555 .vitem &$sender_helo_name$&
13556 .vindex "&$sender_helo_name$&"
13557 When a message is received from a remote host that has issued a HELO or EHLO
13558 command, the argument of that command is placed in this variable. It is also
13559 set if HELO or EHLO is used when a message is received using SMTP locally via
13560 the &%-bs%& or &%-bS%& options.
13561
13562 .vitem &$sender_host_address$&
13563 .vindex "&$sender_host_address$&"
13564 When a message is received from a remote host using SMTP,
13565 this variable contains that
13566 host's IP address. For locally non-SMTP submitted messages, it is empty.
13567
13568 .vitem &$sender_host_authenticated$&
13569 .vindex "&$sender_host_authenticated$&"
13570 This variable contains the name (not the public name) of the authenticator
13571 driver that successfully authenticated the client from which the message was
13572 received. It is empty if there was no successful authentication. See also
13573 &$authenticated_id$&.
13574
13575 .vitem &$sender_host_dnssec$&
13576 .vindex "&$sender_host_dnssec$&"
13577 If an attempt to populate &$sender_host_name$& has been made
13578 (by reference, &%hosts_lookup%& or
13579 otherwise) then this boolean will have been set true if, and only if, the
13580 resolver library states that both
13581 the reverse and forward DNS were authenticated data.  At all
13582 other times, this variable is false.
13583
13584 .cindex "DNS" "DNSSEC"
13585 It is likely that you will need to coerce DNSSEC support on in the resolver
13586 library, by setting:
13587 .code
13588 dns_dnssec_ok = 1
13589 .endd
13590
13591 In addition, on Linux with glibc 2.31 or newer the resolver library will
13592 default to stripping out a successful validation status.
13593 This will break a previously working Exim installation.
13594 Provided that you do trust the resolver (ie, is on localhost) you can tell
13595 glibc to pass through any successful validation with a new option in
13596 &_/etc/resolv.conf_&:
13597 .code
13598 options trust-ad
13599 .endd
13600
13601 Exim does not perform DNSSEC validation itself, instead leaving that to a
13602 validating resolver (e.g. unbound, or bind with suitable configuration).
13603
13604 If you have changed &%host_lookup_order%& so that &`bydns`& is not the first
13605 mechanism in the list, then this variable will be false.
13606
13607 This requires that your system resolver library support EDNS0 (and that
13608 DNSSEC flags exist in the system headers).  If the resolver silently drops
13609 all EDNS0 options, then this will have no effect.  OpenBSD's asr resolver
13610 is known to currently ignore EDNS0, documented in CAVEATS of asr_run(3).
13611
13612
13613 .vitem &$sender_host_name$&
13614 .vindex "&$sender_host_name$&"
13615 When a message is received from a remote host, this variable contains the
13616 host's name as obtained by looking up its IP address. For messages received by
13617 other means, this variable is empty.
13618
13619 .vindex "&$host_lookup_failed$&"
13620 If the host name has not previously been looked up, a reference to
13621 &$sender_host_name$& triggers a lookup (for messages from remote hosts).
13622 A looked up name is accepted only if it leads back to the original IP address
13623 via a forward lookup. If either the reverse or the forward lookup fails to find
13624 any data, or if the forward lookup does not yield the original IP address,
13625 &$sender_host_name$& remains empty, and &$host_lookup_failed$& is set to &"1"&.
13626
13627 .vindex "&$host_lookup_deferred$&"
13628 However, if either of the lookups cannot be completed (for example, there is a
13629 DNS timeout), &$host_lookup_deferred$& is set to &"1"&, and
13630 &$host_lookup_failed$& remains set to &"0"&.
13631
13632 Once &$host_lookup_failed$& is set to &"1"&, Exim does not try to look up the
13633 host name again if there is a subsequent reference to &$sender_host_name$&
13634 in the same Exim process, but it does try again if &$host_lookup_deferred$&
13635 is set to &"1"&.
13636
13637 Exim does not automatically look up every calling host's name. If you want
13638 maximum efficiency, you should arrange your configuration so that it avoids
13639 these lookups altogether. The lookup happens only if one or more of the
13640 following are true:
13641
13642 .ilist
13643 A string containing &$sender_host_name$& is expanded.
13644 .next
13645 The calling host matches the list in &%host_lookup%&. In the default
13646 configuration, this option is set to *, so it must be changed if lookups are
13647 to be avoided. (In the code, the default for &%host_lookup%& is unset.)
13648 .next
13649 Exim needs the host name in order to test an item in a host list. The items
13650 that require this are described in sections &<<SECThoslispatnam>>& and
13651 &<<SECThoslispatnamsk>>&.
13652 .next
13653 The calling host matches &%helo_try_verify_hosts%& or &%helo_verify_hosts%&.
13654 In this case, the host name is required to compare with the name quoted in any
13655 EHLO or HELO commands that the client issues.
13656 .next
13657 The remote host issues a EHLO or HELO command that quotes one of the
13658 domains in &%helo_lookup_domains%&. The default value of this option is
13659 . ==== As this is a nested list, any displays it contains must be indented
13660 . ==== as otherwise they are too far to the left.
13661 .code
13662   helo_lookup_domains = @ : @[]
13663 .endd
13664 which causes a lookup if a remote host (incorrectly) gives the server's name or
13665 IP address in an EHLO or HELO command.
13666 .endlist
13667
13668
13669 .vitem &$sender_host_port$&
13670 .vindex "&$sender_host_port$&"
13671 When a message is received from a remote host, this variable contains the port
13672 number that was used on the remote host.
13673
13674 .vitem &$sender_ident$&
13675 .vindex "&$sender_ident$&"
13676 When a message is received from a remote host, this variable contains the
13677 identification received in response to an RFC 1413 request. When a message has
13678 been received locally, this variable contains the login name of the user that
13679 called Exim.
13680
13681 .vitem &$sender_rate_$&&'xxx'&
13682 A number of variables whose names begin &$sender_rate_$& are set as part of the
13683 &%ratelimit%& ACL condition. Details are given in section
13684 &<<SECTratelimiting>>&.
13685
13686 .vitem &$sender_rcvhost$&
13687 .cindex "DNS" "reverse lookup"
13688 .cindex "reverse DNS lookup"
13689 .vindex "&$sender_rcvhost$&"
13690 This is provided specifically for use in &'Received:'& headers. It starts with
13691 either the verified host name (as obtained from a reverse DNS lookup) or, if
13692 there is no verified host name, the IP address in square brackets. After that
13693 there may be text in parentheses. When the first item is a verified host name,
13694 the first thing in the parentheses is the IP address in square brackets,
13695 followed by a colon and a port number if port logging is enabled. When the
13696 first item is an IP address, the port is recorded as &"port=&'xxxx'&"& inside
13697 the parentheses.
13698
13699 There may also be items of the form &"helo=&'xxxx'&"& if HELO or EHLO
13700 was used and its argument was not identical to the real host name or IP
13701 address, and &"ident=&'xxxx'&"& if an RFC 1413 ident string is available. If
13702 all three items are present in the parentheses, a newline and tab are inserted
13703 into the string, to improve the formatting of the &'Received:'& header.
13704
13705 .vitem &$sender_verify_failure$&
13706 .vindex "&$sender_verify_failure$&"
13707 In an ACL, when a sender verification fails, this variable contains information
13708 about the failure. The details are the same as for
13709 &$recipient_verify_failure$&.
13710
13711 .vitem &$sending_ip_address$&
13712 .vindex "&$sending_ip_address$&"
13713 This variable is set whenever an outgoing SMTP connection to another host has
13714 been set up. It contains the IP address of the local interface that is being
13715 used. This is useful if a host that has more than one IP address wants to take
13716 on different personalities depending on which one is being used. For incoming
13717 connections, see &$received_ip_address$&.
13718
13719 .vitem &$sending_port$&
13720 .vindex "&$sending_port$&"
13721 This variable is set whenever an outgoing SMTP connection to another host has
13722 been set up. It contains the local port that is being used. For incoming
13723 connections, see &$received_port$&.
13724
13725 .vitem &$smtp_active_hostname$&
13726 .vindex "&$smtp_active_hostname$&"
13727 During an incoming SMTP session, this variable contains the value of the active
13728 host name, as specified by the &%smtp_active_hostname%& option. The value of
13729 &$smtp_active_hostname$& is saved with any message that is received, so its
13730 value can be consulted during routing and delivery.
13731
13732 .vitem &$smtp_command$&
13733 .vindex "&$smtp_command$&"
13734 During the processing of an incoming SMTP command, this variable contains the
13735 entire command. This makes it possible to distinguish between HELO and EHLO in
13736 the HELO ACL, and also to distinguish between commands such as these:
13737 .code
13738 MAIL FROM:<>
13739 MAIL FROM: <>
13740 .endd
13741 For a MAIL command, extra parameters such as SIZE can be inspected. For a RCPT
13742 command, the address in &$smtp_command$& is the original address before any
13743 rewriting, whereas the values in &$local_part$& and &$domain$& are taken from
13744 the address after SMTP-time rewriting.
13745
13746 .vitem &$smtp_command_argument$&
13747 .cindex "SMTP" "command, argument for"
13748 .vindex "&$smtp_command_argument$&"
13749 While an ACL is running to check an SMTP command, this variable contains the
13750 argument, that is, the text that follows the command name, with leading white
13751 space removed. Following the introduction of &$smtp_command$&, this variable is
13752 somewhat redundant, but is retained for backwards compatibility.
13753
13754 .vitem &$smtp_command_history$&
13755 .cindex SMTP "command history"
13756 .vindex "&$smtp_command_history$&"
13757 A comma-separated list (with no whitespace) of the most-recent SMTP commands
13758 received, in time-order left to right.  Only a limited number of commands
13759 are remembered.
13760
13761 .vitem &$smtp_count_at_connection_start$&
13762 .vindex "&$smtp_count_at_connection_start$&"
13763 This variable is set greater than zero only in processes spawned by the Exim
13764 daemon for handling incoming SMTP connections. The name is deliberately long,
13765 in order to emphasize what the contents are. When the daemon accepts a new
13766 connection, it increments this variable. A copy of the variable is passed to
13767 the child process that handles the connection, but its value is fixed, and
13768 never changes. It is only an approximation of how many incoming connections
13769 there actually are, because many other connections may come and go while a
13770 single connection is being processed. When a child process terminates, the
13771 daemon decrements its copy of the variable.
13772
13773 .vitem "&$sn0$& &-- &$sn9$&"
13774 These variables are copies of the values of the &$n0$& &-- &$n9$& accumulators
13775 that were current at the end of the system filter file. This allows a system
13776 filter file to set values that can be tested in users' filter files. For
13777 example, a system filter could set a value indicating how likely it is that a
13778 message is junk mail.
13779
13780 .vitem &$spam_score$& &&&
13781        &$spam_score_int$& &&&
13782        &$spam_bar$& &&&
13783        &$spam_report$& &&&
13784        &$spam_action$&
13785 A number of variables whose names start with &$spam$& are available when Exim
13786 is compiled with the content-scanning extension. For details, see section
13787 &<<SECTscanspamass>>&.
13788
13789 .vitem &$spf_header_comment$& &&&
13790        &$spf_received$& &&&
13791        &$spf_result$& &&&
13792        &$spf_result_guessed$& &&&
13793        &$spf_smtp_comment$&
13794 These variables are only available if Exim is built with SPF support.
13795 For details see section &<<SECSPF>>&.
13796
13797 .vitem &$spool_directory$&
13798 .vindex "&$spool_directory$&"
13799 The name of Exim's spool directory.
13800
13801 .vitem &$spool_inodes$&
13802 .vindex "&$spool_inodes$&"
13803 The number of free inodes in the disk partition where Exim's spool files are
13804 being written. The value is recalculated whenever the variable is referenced.
13805 If the relevant file system does not have the concept of inodes, the value of
13806 is -1. See also the &%check_spool_inodes%& option.
13807
13808 .vitem &$spool_space$&
13809 .vindex "&$spool_space$&"
13810 The amount of free space (as a number of kilobytes) in the disk partition where
13811 Exim's spool files are being written. The value is recalculated whenever the
13812 variable is referenced. If the operating system does not have the ability to
13813 find the amount of free space (only true for experimental systems), the space
13814 value is -1. For example, to check in an ACL that there is at least 50
13815 megabytes free on the spool, you could write:
13816 .code
13817 condition = ${if > {$spool_space}{50000}}
13818 .endd
13819 See also the &%check_spool_space%& option.
13820
13821
13822 .vitem &$thisaddress$&
13823 .vindex "&$thisaddress$&"
13824 This variable is set only during the processing of the &%foranyaddress%&
13825 command in a filter file. Its use is explained in the description of that
13826 command, which can be found in the separate document entitled &'Exim's
13827 interfaces to mail filtering'&.
13828
13829 .vitem &$tls_in_bits$&
13830 .vindex "&$tls_in_bits$&"
13831 Contains an approximation of the TLS cipher's bit-strength
13832 on the inbound connection; the meaning of
13833 this depends upon the TLS implementation used.
13834 If TLS has not been negotiated, the value will be 0.
13835 The value of this is automatically fed into the Cyrus SASL authenticator
13836 when acting as a server, to specify the "external SSF" (a SASL term).
13837
13838 The deprecated &$tls_bits$& variable refers to the inbound side
13839 except when used in the context of an outbound SMTP delivery, when it refers to
13840 the outbound.
13841
13842 .vitem &$tls_out_bits$&
13843 .vindex "&$tls_out_bits$&"
13844 Contains an approximation of the TLS cipher's bit-strength
13845 on an outbound SMTP connection; the meaning of
13846 this depends upon the TLS implementation used.
13847 If TLS has not been negotiated, the value will be 0.
13848
13849 .vitem &$tls_in_ourcert$&
13850 .vindex "&$tls_in_ourcert$&"
13851 .cindex certificate variables
13852 This variable refers to the certificate presented to the peer of an
13853 inbound connection when the message was received.
13854 It is only useful as the argument of a
13855 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13856 or a &%def%& condition.
13857
13858 &*Note*&: Under versions of OpenSSL preceding 1.1.1,
13859 when a list of more than one
13860 file is used for &%tls_certificate%&, this variable is not reliable.
13861 The macro "_TLS_BAD_MULTICERT_IN_OURCERT" will be defined for those versions.
13862
13863 .vitem &$tls_in_peercert$&
13864 .vindex "&$tls_in_peercert$&"
13865 This variable refers to the certificate presented by the peer of an
13866 inbound connection when the message was received.
13867 It is only useful as the argument of a
13868 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13869 or a &%def%& condition.
13870 If certificate verification fails it may refer to a failing chain element
13871 which is not the leaf.
13872
13873 .vitem &$tls_out_ourcert$&
13874 .vindex "&$tls_out_ourcert$&"
13875 This variable refers to the certificate presented to the peer of an
13876 outbound connection.  It is only useful as the argument of a
13877 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13878 or a &%def%& condition.
13879
13880 .vitem &$tls_out_peercert$&
13881 .vindex "&$tls_out_peercert$&"
13882 This variable refers to the certificate presented by the peer of an
13883 outbound connection.  It is only useful as the argument of a
13884 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13885 or a &%def%& condition.
13886 If certificate verification fails it may refer to a failing chain element
13887 which is not the leaf.
13888
13889 .vitem &$tls_in_certificate_verified$&
13890 .vindex "&$tls_in_certificate_verified$&"
13891 This variable is set to &"1"& if a TLS certificate was verified when the
13892 message was received, and &"0"& otherwise.
13893
13894 The deprecated &$tls_certificate_verified$& variable refers to the inbound side
13895 except when used in the context of an outbound SMTP delivery, when it refers to
13896 the outbound.
13897
13898 .vitem &$tls_out_certificate_verified$&
13899 .vindex "&$tls_out_certificate_verified$&"
13900 This variable is set to &"1"& if a TLS certificate was verified when an
13901 outbound SMTP connection was made,
13902 and &"0"& otherwise.
13903
13904 .vitem &$tls_in_cipher$&
13905 .vindex "&$tls_in_cipher$&"
13906 .vindex "&$tls_cipher$&"
13907 When a message is received from a remote host over an encrypted SMTP
13908 connection, this variable is set to the cipher suite that was negotiated, for
13909 example DES-CBC3-SHA. In other circumstances, in particular, for message
13910 received over unencrypted connections, the variable is empty. Testing
13911 &$tls_in_cipher$& for emptiness is one way of distinguishing between encrypted and
13912 non-encrypted connections during ACL processing.
13913
13914 The deprecated &$tls_cipher$& variable is the same as &$tls_in_cipher$& during message reception,
13915 but in the context of an outward SMTP delivery taking place via the &(smtp)& transport
13916 becomes the same as &$tls_out_cipher$&.
13917
13918 .vitem &$tls_in_cipher_std$&
13919 .vindex "&$tls_in_cipher_std$&"
13920 As above, but returning the RFC standard name for the cipher suite.
13921
13922 .vitem &$tls_out_cipher$&
13923 .vindex "&$tls_out_cipher$&"
13924 This variable is
13925 cleared before any outgoing SMTP connection is made,
13926 and then set to the outgoing cipher suite if one is negotiated. See chapter
13927 &<<CHAPTLS>>& for details of TLS support and chapter &<<CHAPsmtptrans>>& for
13928 details of the &(smtp)& transport.
13929
13930 .vitem &$tls_out_cipher_std$&
13931 .vindex "&$tls_out_cipher_std$&"
13932 As above, but returning the RFC standard name for the cipher suite.
13933
13934 .vitem &$tls_out_dane$&
13935 .vindex &$tls_out_dane$&
13936 DANE active status.  See section &<<SECDANE>>&.
13937
13938 .vitem &$tls_in_ocsp$&
13939 .vindex "&$tls_in_ocsp$&"
13940 When a message is received from a remote client connection
13941 the result of any OCSP request from the client is encoded in this variable:
13942 .code
13943 0 OCSP proof was not requested (default value)
13944 1 No response to request
13945 2 Response not verified
13946 3 Verification failed
13947 4 Verification succeeded
13948 .endd
13949
13950 .vitem &$tls_out_ocsp$&
13951 .vindex "&$tls_out_ocsp$&"
13952 When a message is sent to a remote host connection
13953 the result of any OCSP request made is encoded in this variable.
13954 See &$tls_in_ocsp$& for values.
13955
13956 .vitem &$tls_in_peerdn$&
13957 .vindex "&$tls_in_peerdn$&"
13958 .vindex "&$tls_peerdn$&"
13959 .cindex certificate "extracting fields"
13960 When a message is received from a remote host over an encrypted SMTP
13961 connection, and Exim is configured to request a certificate from the client,
13962 the value of the Distinguished Name of the certificate is made available in the
13963 &$tls_in_peerdn$& during subsequent processing.
13964 If certificate verification fails it may refer to a failing chain element
13965 which is not the leaf.
13966
13967 The deprecated &$tls_peerdn$& variable refers to the inbound side
13968 except when used in the context of an outbound SMTP delivery, when it refers to
13969 the outbound.
13970
13971 .vitem &$tls_out_peerdn$&
13972 .vindex "&$tls_out_peerdn$&"
13973 When a message is being delivered to a remote host over an encrypted SMTP
13974 connection, and Exim is configured to request a certificate from the server,
13975 the value of the Distinguished Name of the certificate is made available in the
13976 &$tls_out_peerdn$& during subsequent processing.
13977 If certificate verification fails it may refer to a failing chain element
13978 which is not the leaf.
13979
13980
13981 .new
13982 .vitem &$tls_in_resumption$& &&&
13983        &$tls_out_resumption$&
13984 .vindex &$tls_in_resumption$&
13985 .vindex &$tls_out_resumption$&
13986 .cindex TLS resumption
13987 Observability for TLS session resumption.  See &<<SECTresumption>>& for details.
13988 .wen
13989
13990
13991 .vitem &$tls_in_sni$&
13992 .vindex "&$tls_in_sni$&"
13993 .vindex "&$tls_sni$&"
13994 .cindex "TLS" "Server Name Indication"
13995 .cindex "TLS" SNI
13996 .cindex SNI "observability on server"
13997 When a TLS session is being established, if the client sends the Server
13998 Name Indication extension, the value will be placed in this variable.
13999 If the variable appears in &%tls_certificate%& then this option and
14000 some others, described in &<<SECTtlssni>>&,
14001 will be re-expanded early in the TLS session, to permit
14002 a different certificate to be presented (and optionally a different key to be
14003 used) to the client, based upon the value of the SNI extension.
14004
14005 The deprecated &$tls_sni$& variable refers to the inbound side
14006 except when used in the context of an outbound SMTP delivery, when it refers to
14007 the outbound.
14008
14009 .vitem &$tls_out_sni$&
14010 .vindex "&$tls_out_sni$&"
14011 .cindex "TLS" "Server Name Indication"
14012 .cindex "TLS" SNI
14013 .cindex SNI "observability in client"
14014 During outbound
14015 SMTP deliveries, this variable reflects the value of the &%tls_sni%& option on
14016 the transport.
14017
14018 .vitem &$tls_out_tlsa_usage$&
14019 .vindex &$tls_out_tlsa_usage$&
14020 Bitfield of TLSA record types found.  See section &<<SECDANE>>&.
14021
14022 .vitem &$tls_in_ver$&
14023 .vindex "&$tls_in_ver$&"
14024 When a message is received from a remote host over an encrypted SMTP connection
14025 this variable is set to the protocol version, eg &'TLS1.2'&.
14026
14027 .vitem &$tls_out_ver$&
14028 .vindex "&$tls_out_ver$&"
14029 When a message is being delivered to a remote host over an encrypted SMTP connection
14030 this variable is set to the protocol version.
14031
14032
14033 .vitem &$tod_bsdinbox$&
14034 .vindex "&$tod_bsdinbox$&"
14035 The time of day and the date, in the format required for BSD-style mailbox
14036 files, for example: Thu Oct 17 17:14:09 1995.
14037
14038 .vitem &$tod_epoch$&
14039 .vindex "&$tod_epoch$&"
14040 The time and date as a number of seconds since the start of the Unix epoch.
14041
14042 .vitem &$tod_epoch_l$&
14043 .vindex "&$tod_epoch_l$&"
14044 The time and date as a number of microseconds since the start of the Unix epoch.
14045
14046 .vitem &$tod_full$&
14047 .vindex "&$tod_full$&"
14048 A full version of the time and date, for example: Wed, 16 Oct 1995 09:51:40
14049 +0100. The timezone is always given as a numerical offset from UTC, with
14050 positive values used for timezones that are ahead (east) of UTC, and negative
14051 values for those that are behind (west).
14052
14053 .vitem &$tod_log$&
14054 .vindex "&$tod_log$&"
14055 The time and date in the format used for writing Exim's log files, for example:
14056 1995-10-12 15:32:29, but without a timezone.
14057
14058 .vitem &$tod_logfile$&
14059 .vindex "&$tod_logfile$&"
14060 This variable contains the date in the format yyyymmdd. This is the format that
14061 is used for datestamping log files when &%log_file_path%& contains the &`%D`&
14062 flag.
14063
14064 .vitem &$tod_zone$&
14065 .vindex "&$tod_zone$&"
14066 This variable contains the numerical value of the local timezone, for example:
14067 -0500.
14068
14069 .vitem &$tod_zulu$&
14070 .vindex "&$tod_zulu$&"
14071 This variable contains the UTC date and time in &"Zulu"& format, as specified
14072 by ISO 8601, for example: 20030221154023Z.
14073
14074 .vitem &$transport_name$&
14075 .cindex "transport" "name"
14076 .cindex "name" "of transport"
14077 .vindex "&$transport_name$&"
14078 During the running of a transport, this variable contains its name.
14079
14080 .vitem &$value$&
14081 .vindex "&$value$&"
14082 This variable contains the result of an expansion lookup, extraction operation,
14083 or external command, as described above. It is also used during a
14084 &*reduce*& expansion.
14085
14086 .vitem &$verify_mode$&
14087 .vindex "&$verify_mode$&"
14088 While a router or transport is being run in verify mode or for cutthrough delivery,
14089 contains "S" for sender-verification or "R" for recipient-verification.
14090 Otherwise, empty.
14091
14092 .vitem &$version_number$&
14093 .vindex "&$version_number$&"
14094 The version number of Exim. Same as &$exim_version$&, may be overridden
14095 by the &%exim_version%& main config option.
14096
14097 .vitem &$warn_message_delay$&
14098 .vindex "&$warn_message_delay$&"
14099 This variable is set only during the creation of a message warning about a
14100 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
14101
14102 .vitem &$warn_message_recipients$&
14103 .vindex "&$warn_message_recipients$&"
14104 This variable is set only during the creation of a message warning about a
14105 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
14106 .endlist
14107 .ecindex IIDstrexp
14108
14109
14110
14111 . ////////////////////////////////////////////////////////////////////////////
14112 . ////////////////////////////////////////////////////////////////////////////
14113
14114 .chapter "Embedded Perl" "CHAPperl"
14115 .scindex IIDperl "Perl" "calling from Exim"
14116 Exim can be built to include an embedded Perl interpreter. When this is done,
14117 Perl subroutines can be called as part of the string expansion process. To make
14118 use of the Perl support, you need version 5.004 or later of Perl installed on
14119 your system. To include the embedded interpreter in the Exim binary, include
14120 the line
14121 .code
14122 EXIM_PERL = perl.o
14123 .endd
14124 in your &_Local/Makefile_& and then build Exim in the normal way.
14125
14126
14127 .section "Setting up so Perl can be used" "SECID85"
14128 .oindex "&%perl_startup%&"
14129 Access to Perl subroutines is via a global configuration option called
14130 &%perl_startup%& and an expansion string operator &%${perl ...}%&. If there is
14131 no &%perl_startup%& option in the Exim configuration file then no Perl
14132 interpreter is started and there is almost no overhead for Exim (since none of
14133 the Perl library will be paged in unless used). If there is a &%perl_startup%&
14134 option then the associated value is taken to be Perl code which is executed in
14135 a newly created Perl interpreter.
14136
14137 The value of &%perl_startup%& is not expanded in the Exim sense, so you do not
14138 need backslashes before any characters to escape special meanings. The option
14139 should usually be something like
14140 .code
14141 perl_startup = do '/etc/exim.pl'
14142 .endd
14143 where &_/etc/exim.pl_& is Perl code which defines any subroutines you want to
14144 use from Exim. Exim can be configured either to start up a Perl interpreter as
14145 soon as it is entered, or to wait until the first time it is needed. Starting
14146 the interpreter at the beginning ensures that it is done while Exim still has
14147 its setuid privilege, but can impose an unnecessary overhead if Perl is not in
14148 fact used in a particular run. Also, note that this does not mean that Exim is
14149 necessarily running as root when Perl is called at a later time. By default,
14150 the interpreter is started only when it is needed, but this can be changed in
14151 two ways:
14152
14153 .ilist
14154 .oindex "&%perl_at_start%&"
14155 Setting &%perl_at_start%& (a boolean option) in the configuration requests
14156 a startup when Exim is entered.
14157 .next
14158 The command line option &%-ps%& also requests a startup when Exim is entered,
14159 overriding the setting of &%perl_at_start%&.
14160 .endlist
14161
14162 There is also a command line option &%-pd%& (for delay) which suppresses the
14163 initial startup, even if &%perl_at_start%& is set.
14164
14165 .ilist
14166 .oindex "&%perl_taintmode%&"
14167 .cindex "Perl" "taintmode"
14168 To provide more security executing Perl code via the embedded Perl
14169 interpreter, the &%perl_taintmode%& option can be set. This enables the
14170 taint mode of the Perl interpreter. You are encouraged to set this
14171 option to a true value. To avoid breaking existing installations, it
14172 defaults to false.
14173
14174 .new
14175 &*Note*&: This is entirely separate from Exim's tainted-data tracking.
14176 .wen
14177
14178
14179 .section "Calling Perl subroutines" "SECID86"
14180 When the configuration file includes a &%perl_startup%& option you can make use
14181 of the string expansion item to call the Perl subroutines that are defined
14182 by the &%perl_startup%& code. The operator is used in any of the following
14183 forms:
14184 .code
14185 ${perl{foo}}
14186 ${perl{foo}{argument}}
14187 ${perl{foo}{argument1}{argument2} ... }
14188 .endd
14189 which calls the subroutine &%foo%& with the given arguments. A maximum of eight
14190 arguments may be passed. Passing more than this results in an expansion failure
14191 with an error message of the form
14192 .code
14193 Too many arguments passed to Perl subroutine "foo" (max is 8)
14194 .endd
14195 The return value of the Perl subroutine is evaluated in a scalar context before
14196 it is passed back to Exim to be inserted into the expanded string. If the
14197 return value is &'undef'&, the expansion is forced to fail in the same way as
14198 an explicit &"fail"& on an &%if%& or &%lookup%& item. If the subroutine aborts
14199 by obeying Perl's &%die%& function, the expansion fails with the error message
14200 that was passed to &%die%&.
14201
14202
14203 .section "Calling Exim functions from Perl" "SECID87"
14204 Within any Perl code called from Exim, the function &'Exim::expand_string()'&
14205 is available to call back into Exim's string expansion function. For example,
14206 the Perl code
14207 .code
14208 my $lp = Exim::expand_string('$local_part');
14209 .endd
14210 makes the current Exim &$local_part$& available in the Perl variable &$lp$&.
14211 Note those are single quotes and not double quotes to protect against
14212 &$local_part$& being interpolated as a Perl variable.
14213
14214 If the string expansion is forced to fail by a &"fail"& item, the result of
14215 &'Exim::expand_string()'& is &%undef%&. If there is a syntax error in the
14216 expansion string, the Perl call from the original expansion string fails with
14217 an appropriate error message, in the same way as if &%die%& were used.
14218
14219 .cindex "debugging" "from embedded Perl"
14220 .cindex "log" "writing from embedded Perl"
14221 Two other Exim functions are available for use from within Perl code.
14222 &'Exim::debug_write()'& writes a string to the standard error stream if Exim's
14223 debugging is enabled. If you want a newline at the end, you must supply it.
14224 &'Exim::log_write()'& writes a string to Exim's main log, adding a leading
14225 timestamp. In this case, you should not supply a terminating newline.
14226
14227
14228 .section "Use of standard output and error by Perl" "SECID88"
14229 .cindex "Perl" "standard output and error"
14230 You should not write to the standard error or output streams from within your
14231 Perl code, as it is not defined how these are set up. In versions of Exim
14232 before 4.50, it is possible for the standard output or error to refer to the
14233 SMTP connection during message reception via the daemon. Writing to this stream
14234 is certain to cause chaos. From Exim 4.50 onwards, the standard output and
14235 error streams are connected to &_/dev/null_& in the daemon. The chaos is
14236 avoided, but the output is lost.
14237
14238 .cindex "Perl" "use of &%warn%&"
14239 The Perl &%warn%& statement writes to the standard error stream by default.
14240 Calls to &%warn%& may be embedded in Perl modules that you use, but over which
14241 you have no control. When Exim starts up the Perl interpreter, it arranges for
14242 output from the &%warn%& statement to be written to the Exim main log. You can
14243 change this by including appropriate Perl magic somewhere in your Perl code.
14244 For example, to discard &%warn%& output completely, you need this:
14245 .code
14246 $SIG{__WARN__} = sub { };
14247 .endd
14248 Whenever a &%warn%& is obeyed, the anonymous subroutine is called. In this
14249 example, the code for the subroutine is empty, so it does nothing, but you can
14250 include any Perl code that you like. The text of the &%warn%& message is passed
14251 as the first subroutine argument.
14252 .ecindex IIDperl
14253
14254
14255 . ////////////////////////////////////////////////////////////////////////////
14256 . ////////////////////////////////////////////////////////////////////////////
14257
14258 .chapter "Starting the daemon and the use of network interfaces" &&&
14259          "CHAPinterfaces" &&&
14260          "Starting the daemon"
14261 .cindex "daemon" "starting"
14262 .cindex "interface" "listening"
14263 .cindex "network interface"
14264 .cindex "interface" "network"
14265 .cindex "IP address" "for listening"
14266 .cindex "daemon" "listening IP addresses"
14267 .cindex "TCP/IP" "setting listening interfaces"
14268 .cindex "TCP/IP" "setting listening ports"
14269 A host that is connected to a TCP/IP network may have one or more physical
14270 hardware network interfaces. Each of these interfaces may be configured as one
14271 or more &"logical"& interfaces, which are the entities that a program actually
14272 works with. Each of these logical interfaces is associated with an IP address.
14273 In addition, TCP/IP software supports &"loopback"& interfaces (127.0.0.1 in
14274 IPv4 and ::1 in IPv6), which do not use any physical hardware. Exim requires
14275 knowledge about the host's interfaces for use in three different circumstances:
14276
14277 .olist
14278 When a listening daemon is started, Exim needs to know which interfaces
14279 and ports to listen on.
14280 .next
14281 When Exim is routing an address, it needs to know which IP addresses
14282 are associated with local interfaces. This is required for the correct
14283 processing of MX lists by removing the local host and others with the
14284 same or higher priority values. Also, Exim needs to detect cases
14285 when an address is routed to an IP address that in fact belongs to the
14286 local host. Unless the &%self%& router option or the &%allow_localhost%&
14287 option of the smtp transport is set (as appropriate), this is treated
14288 as an error situation.
14289 .next
14290 When Exim connects to a remote host, it may need to know which interface to use
14291 for the outgoing connection.
14292 .endlist
14293
14294
14295 Exim's default behaviour is likely to be appropriate in the vast majority
14296 of cases. If your host has only one interface, and you want all its IP
14297 addresses to be treated in the same way, and you are using only the
14298 standard SMTP port, you should not need to take any special action. The
14299 rest of this chapter does not apply to you.
14300
14301 In a more complicated situation you may want to listen only on certain
14302 interfaces, or on different ports, and for this reason there are a number of
14303 options that can be used to influence Exim's behaviour. The rest of this
14304 chapter describes how they operate.
14305
14306 When a message is received over TCP/IP, the interface and port that were
14307 actually used are set in &$received_ip_address$& and &$received_port$&.
14308
14309
14310
14311 .section "Starting a listening daemon" "SECID89"
14312 When a listening daemon is started (by means of the &%-bd%& command line
14313 option), the interfaces and ports on which it listens are controlled by the
14314 following options:
14315
14316 .ilist
14317 &%daemon_smtp_ports%& contains a list of default ports
14318 or service names.
14319 (For backward compatibility, this option can also be specified in the singular.)
14320 .next
14321 &%local_interfaces%& contains list of interface IP addresses on which to
14322 listen. Each item may optionally also specify a port.
14323 .endlist
14324
14325 The default list separator in both cases is a colon, but this can be changed as
14326 described in section &<<SECTlistsepchange>>&. When IPv6 addresses are involved,
14327 it is usually best to change the separator to avoid having to double all the
14328 colons. For example:
14329 .code
14330 local_interfaces = <; 127.0.0.1 ; \
14331                       192.168.23.65 ; \
14332                       ::1 ; \
14333                       3ffe:ffff:836f::fe86:a061
14334 .endd
14335 There are two different formats for specifying a port along with an IP address
14336 in &%local_interfaces%&:
14337
14338 .olist
14339 The port is added onto the address with a dot separator. For example, to listen
14340 on port 1234 on two different IP addresses:
14341 .code
14342 local_interfaces = <; 192.168.23.65.1234 ; \
14343                       3ffe:ffff:836f::fe86:a061.1234
14344 .endd
14345 .next
14346 The IP address is enclosed in square brackets, and the port is added
14347 with a colon separator, for example:
14348 .code
14349 local_interfaces = <; [192.168.23.65]:1234 ; \
14350                       [3ffe:ffff:836f::fe86:a061]:1234
14351 .endd
14352 .endlist
14353
14354 When a port is not specified, the value of &%daemon_smtp_ports%& is used. The
14355 default setting contains just one port:
14356 .code
14357 daemon_smtp_ports = smtp
14358 .endd
14359 If more than one port is listed, each interface that does not have its own port
14360 specified listens on all of them. Ports that are listed in
14361 &%daemon_smtp_ports%& can be identified either by name (defined in
14362 &_/etc/services_&) or by number. However, when ports are given with individual
14363 IP addresses in &%local_interfaces%&, only numbers (not names) can be used.
14364
14365
14366
14367 .section "Special IP listening addresses" "SECID90"
14368 The addresses 0.0.0.0 and ::0 are treated specially. They are interpreted
14369 as &"all IPv4 interfaces"& and &"all IPv6 interfaces"&, respectively. In each
14370 case, Exim tells the TCP/IP stack to &"listen on all IPv&'x'& interfaces"&
14371 instead of setting up separate listening sockets for each interface. The
14372 default value of &%local_interfaces%& is
14373 .code
14374 local_interfaces = 0.0.0.0
14375 .endd
14376 when Exim is built without IPv6 support; otherwise it is:
14377 .code
14378 local_interfaces = <; ::0 ; 0.0.0.0
14379 .endd
14380 Thus, by default, Exim listens on all available interfaces, on the SMTP port.
14381
14382
14383
14384 .section "Overriding local_interfaces and daemon_smtp_ports" "SECID91"
14385 The &%-oX%& command line option can be used to override the values of
14386 &%daemon_smtp_ports%& and/or &%local_interfaces%& for a particular daemon
14387 instance. Another way of doing this would be to use macros and the &%-D%&
14388 option. However, &%-oX%& can be used by any admin user, whereas modification of
14389 the runtime configuration by &%-D%& is allowed only when the caller is root or
14390 exim.
14391
14392 The value of &%-oX%& is a list of items. The default colon separator can be
14393 changed in the usual way (&<<SECTlistsepchange>>&) if required.
14394 If there are any items that do not
14395 contain dots or colons (that is, are not IP addresses), the value of
14396 &%daemon_smtp_ports%& is replaced by the list of those items. If there are any
14397 items that do contain dots or colons, the value of &%local_interfaces%& is
14398 replaced by those items. Thus, for example,
14399 .code
14400 -oX 1225
14401 .endd
14402 overrides &%daemon_smtp_ports%&, but leaves &%local_interfaces%& unchanged,
14403 whereas
14404 .code
14405 -oX 192.168.34.5.1125
14406 .endd
14407 overrides &%local_interfaces%&, leaving &%daemon_smtp_ports%& unchanged.
14408 (However, since &%local_interfaces%& now contains no items without ports, the
14409 value of &%daemon_smtp_ports%& is no longer relevant in this example.)
14410
14411
14412
14413 .section "Support for the submissions (aka SSMTP or SMTPS) protocol" "SECTsupobssmt"
14414 .cindex "submissions protocol"
14415 .cindex "ssmtp protocol"
14416 .cindex "smtps protocol"
14417 .cindex "SMTP" "ssmtp protocol"
14418 .cindex "SMTP" "smtps protocol"
14419 Exim supports the use of TLS-on-connect, used by mail clients in the
14420 &"submissions"& protocol, historically also known as SMTPS or SSMTP.
14421 For some years, IETF Standards Track documents only blessed the
14422 STARTTLS-based Submission service (port 587) while common practice was to support
14423 the same feature set on port 465, but using TLS-on-connect.
14424 If your installation needs to provide service to mail clients
14425 (Mail User Agents, MUAs) then you should provide service on both the 587 and
14426 the 465 TCP ports.
14427
14428 If the &%tls_on_connect_ports%& option is set to a list of port numbers or
14429 service names, connections to those ports must first establish TLS, before
14430 proceeding to the application layer use of the SMTP protocol.
14431
14432 The common use of this option is expected to be
14433 .code
14434 tls_on_connect_ports = 465
14435 .endd
14436 per RFC 8314.
14437 There is also a command line option &%-tls-on-connect%&, which forces all ports
14438 to behave in this way when a daemon is started.
14439
14440 &*Warning*&: Setting &%tls_on_connect_ports%& does not of itself cause the
14441 daemon to listen on those ports. You must still specify them in
14442 &%daemon_smtp_ports%&, &%local_interfaces%&, or the &%-oX%& option. (This is
14443 because &%tls_on_connect_ports%& applies to &%inetd%& connections as well as to
14444 connections via the daemon.)
14445
14446
14447
14448
14449 .section "IPv6 address scopes" "SECID92"
14450 .cindex "IPv6" "address scopes"
14451 IPv6 addresses have &"scopes"&, and a host with multiple hardware interfaces
14452 can, in principle, have the same link-local IPv6 address on different
14453 interfaces. Thus, additional information is needed, over and above the IP
14454 address, to distinguish individual interfaces. A convention of using a
14455 percent sign followed by something (often the interface name) has been
14456 adopted in some cases, leading to addresses like this:
14457 .code
14458 fe80::202:b3ff:fe03:45c1%eth0
14459 .endd
14460 To accommodate this usage, a percent sign followed by an arbitrary string is
14461 allowed at the end of an IPv6 address. By default, Exim calls &[getaddrinfo()]&
14462 to convert a textual IPv6 address for actual use. This function recognizes the
14463 percent convention in operating systems that support it, and it processes the
14464 address appropriately. Unfortunately, some older libraries have problems with
14465 &[getaddrinfo()]&. If
14466 .code
14467 IPV6_USE_INET_PTON=yes
14468 .endd
14469 is set in &_Local/Makefile_& (or an OS-dependent Makefile) when Exim is built,
14470 Exim uses &'inet_pton()'& to convert a textual IPv6 address for actual use,
14471 instead of &[getaddrinfo()]&. (Before version 4.14, it always used this
14472 function.) Of course, this means that the additional functionality of
14473 &[getaddrinfo()]& &-- recognizing scoped addresses &-- is lost.
14474
14475 .section "Disabling IPv6" "SECID93"
14476 .cindex "IPv6" "disabling"
14477 Sometimes it happens that an Exim binary that was compiled with IPv6 support is
14478 run on a host whose kernel does not support IPv6. The binary will fall back to
14479 using IPv4, but it may waste resources looking up AAAA records, and trying to
14480 connect to IPv6 addresses, causing delays to mail delivery. If you set the
14481 .oindex "&%disable_ipv6%&"
14482 &%disable_ipv6%& option true, even if the Exim binary has IPv6 support, no IPv6
14483 activities take place. AAAA records are never looked up, and any IPv6 addresses
14484 that are listed in &%local_interfaces%&, data for the &(manualroute)& router,
14485 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
14486 to handle IPv6 literal addresses.
14487
14488 On the other hand, when IPv6 is in use, there may be times when you want to
14489 disable it for certain hosts or domains. You can use the &%dns_ipv4_lookup%&
14490 option to globally suppress the lookup of AAAA records for specified domains,
14491 and you can use the &%ignore_target_hosts%& generic router option to ignore
14492 IPv6 addresses in an individual router.
14493
14494
14495
14496 .section "Examples of starting a listening daemon" "SECID94"
14497 The default case in an IPv6 environment is
14498 .code
14499 daemon_smtp_ports = smtp
14500 local_interfaces = <; ::0 ; 0.0.0.0
14501 .endd
14502 This specifies listening on the smtp port on all IPv6 and IPv4 interfaces.
14503 Either one or two sockets may be used, depending on the characteristics of
14504 the TCP/IP stack. (This is complicated and messy; for more information,
14505 read the comments in the &_daemon.c_& source file.)
14506
14507 To specify listening on ports 25 and 26 on all interfaces:
14508 .code
14509 daemon_smtp_ports = 25 : 26
14510 .endd
14511 (leaving &%local_interfaces%& at the default setting) or, more explicitly:
14512 .code
14513 local_interfaces = <; ::0.25     ; ::0.26 \
14514                       0.0.0.0.25 ; 0.0.0.0.26
14515 .endd
14516 To listen on the default port on all IPv4 interfaces, and on port 26 on the
14517 IPv4 loopback address only:
14518 .code
14519 local_interfaces = 0.0.0.0 : 127.0.0.1.26
14520 .endd
14521 To specify listening on the default port on specific interfaces only:
14522 .code
14523 local_interfaces = 10.0.0.67 : 192.168.34.67
14524 .endd
14525 &*Warning*&: Such a setting excludes listening on the loopback interfaces.
14526
14527
14528
14529 .section "Recognizing the local host" "SECTreclocipadd"
14530 The &%local_interfaces%& option is also used when Exim needs to determine
14531 whether or not an IP address refers to the local host. That is, the IP
14532 addresses of all the interfaces on which a daemon is listening are always
14533 treated as local.
14534
14535 For this usage, port numbers in &%local_interfaces%& are ignored. If either of
14536 the items 0.0.0.0 or ::0 are encountered, Exim gets a complete list of
14537 available interfaces from the operating system, and extracts the relevant
14538 (that is, IPv4 or IPv6) addresses to use for checking.
14539
14540 Some systems set up large numbers of virtual interfaces in order to provide
14541 many virtual web servers. In this situation, you may want to listen for
14542 email on only a few of the available interfaces, but nevertheless treat all
14543 interfaces as local when routing. You can do this by setting
14544 &%extra_local_interfaces%& to a list of IP addresses, possibly including the
14545 &"all"& wildcard values. These addresses are recognized as local, but are not
14546 used for listening. Consider this example:
14547 .code
14548 local_interfaces = <; 127.0.0.1 ; ::1 ; \
14549                       192.168.53.235 ; \
14550                       3ffe:2101:12:1:a00:20ff:fe86:a061
14551
14552 extra_local_interfaces = <; ::0 ; 0.0.0.0
14553 .endd
14554 The daemon listens on the loopback interfaces and just one IPv4 and one IPv6
14555 address, but all available interface addresses are treated as local when
14556 Exim is routing.
14557
14558 In some environments the local host name may be in an MX list, but with an IP
14559 address that is not assigned to any local interface. In other cases it may be
14560 desirable to treat other host names as if they referred to the local host. Both
14561 these cases can be handled by setting the &%hosts_treat_as_local%& option.
14562 This contains host names rather than IP addresses. When a host is referenced
14563 during routing, either via an MX record or directly, it is treated as the local
14564 host if its name matches &%hosts_treat_as_local%&, or if any of its IP
14565 addresses match &%local_interfaces%& or &%extra_local_interfaces%&.
14566
14567
14568
14569 .section "Delivering to a remote host" "SECID95"
14570 Delivery to a remote host is handled by the smtp transport. By default, it
14571 allows the system's TCP/IP functions to choose which interface to use (if
14572 there is more than one) when connecting to a remote host. However, the
14573 &%interface%& option can be set to specify which interface is used. See the
14574 description of the smtp transport in chapter &<<CHAPsmtptrans>>& for more
14575 details.
14576
14577
14578
14579
14580 . ////////////////////////////////////////////////////////////////////////////
14581 . ////////////////////////////////////////////////////////////////////////////
14582
14583 .chapter "Main configuration" "CHAPmainconfig"
14584 .scindex IIDconfima "configuration file" "main section"
14585 .scindex IIDmaiconf "main configuration"
14586 The first part of the runtime configuration file contains three types of item:
14587
14588 .ilist
14589 Macro definitions: These lines start with an upper case letter. See section
14590 &<<SECTmacrodefs>>& for details of macro processing.
14591 .next
14592 Named list definitions: These lines start with one of the words &"domainlist"&,
14593 &"hostlist"&, &"addresslist"&, or &"localpartlist"&. Their use is described in
14594 section &<<SECTnamedlists>>&.
14595 .next
14596 Main configuration settings: Each setting occupies one line of the file
14597 (with possible continuations). If any setting is preceded by the word
14598 &"hide"&, the &%-bP%& command line option displays its value to admin users
14599 only. See section &<<SECTcos>>& for a description of the syntax of these option
14600 settings.
14601 .endlist
14602
14603 This chapter specifies all the main configuration options, along with their
14604 types and default values. For ease of finding a particular option, they appear
14605 in alphabetical order in section &<<SECTalomo>>& below. However, because there
14606 are now so many options, they are first listed briefly in functional groups, as
14607 an aid to finding the name of the option you are looking for. Some options are
14608 listed in more than one group.
14609
14610 .section "Miscellaneous" "SECID96"
14611 .table2
14612 .row &%add_environment%&             "environment variables"
14613 .row &%allow_insecure_tainted_data%& "turn taint errors into warnings"
14614 .row &%bi_command%&                  "to run for &%-bi%& command line option"
14615 .row &%debug_store%&                 "do extra internal checks"
14616 .row &%disable_ipv6%&                "do no IPv6 processing"
14617 .row &%keep_environment%&            "environment variables"
14618 .row &%keep_malformed%&              "for broken files &-- should not happen"
14619 .row &%localhost_number%&            "for unique message ids in clusters"
14620 .row &%message_body_newlines%&       "retain newlines in &$message_body$&"
14621 .row &%message_body_visible%&        "how much to show in &$message_body$&"
14622 .row &%mua_wrapper%&                 "run in &""MUA wrapper""& mode"
14623 .row &%print_topbitchars%&           "top-bit characters are printing"
14624 .row &%spool_wireformat%&            "use wire-format spool data files when possible"
14625 .row &%timezone%&                    "force time zone"
14626 .endtable
14627
14628
14629 .section "Exim parameters" "SECID97"
14630 .table2
14631 .row &%exim_group%&                  "override compiled-in value"
14632 .row &%exim_path%&                   "override compiled-in value"
14633 .row &%exim_user%&                   "override compiled-in value"
14634 .row &%primary_hostname%&            "default from &[uname()]&"
14635 .row &%split_spool_directory%&       "use multiple directories"
14636 .row &%spool_directory%&             "override compiled-in value"
14637 .endtable
14638
14639
14640
14641 .section "Privilege controls" "SECID98"
14642 .table2
14643 .row &%admin_groups%&                "groups that are Exim admin users"
14644 .row &%commandline_checks_require_admin%& "require admin for various checks"
14645 .row &%deliver_drop_privilege%&      "drop root for delivery processes"
14646 .row &%local_from_check%&            "insert &'Sender:'& if necessary"
14647 .row &%local_from_prefix%&           "for testing &'From:'& for local sender"
14648 .row &%local_from_suffix%&           "for testing &'From:'& for local sender"
14649 .row &%local_sender_retain%&         "keep &'Sender:'& from untrusted user"
14650 .row &%never_users%&                 "do not run deliveries as these"
14651 .row &%prod_requires_admin%&         "forced delivery requires admin user"
14652 .row &%queue_list_requires_admin%&   "queue listing requires admin user"
14653 .row &%trusted_groups%&              "groups that are trusted"
14654 .row &%trusted_users%&               "users that are trusted"
14655 .endtable
14656
14657
14658
14659 .section "Logging" "SECID99"
14660 .table2
14661 .row &%event_action%&                "custom logging"
14662 .row &%hosts_connection_nolog%&      "exemption from connect logging"
14663 .row &%log_file_path%&               "override compiled-in value"
14664 .row &%log_selector%&                "set/unset optional logging"
14665 .row &%log_timezone%&                "add timezone to log lines"
14666 .row &%message_logs%&                "create per-message logs"
14667 .row &%preserve_message_logs%&       "after message completion"
14668 .row &%process_log_path%&            "for SIGUSR1 and &'exiwhat'&"
14669 .row &%slow_lookup_log%&             "control logging of slow DNS lookups"
14670 .row &%syslog_duplication%&          "controls duplicate log lines on syslog"
14671 .row &%syslog_facility%&             "set syslog &""facility""& field"
14672 .row &%syslog_pid%&                  "pid in syslog lines"
14673 .row &%syslog_processname%&          "set syslog &""ident""& field"
14674 .row &%syslog_timestamp%&            "timestamp syslog lines"
14675 .row &%write_rejectlog%&             "control use of message log"
14676 .endtable
14677
14678
14679
14680 .section "Frozen messages" "SECID100"
14681 .table2
14682 .row &%auto_thaw%&                   "sets time for retrying frozen messages"
14683 .row &%freeze_tell%&                 "send message when freezing"
14684 .row &%move_frozen_messages%&        "to another directory"
14685 .row &%timeout_frozen_after%&        "keep frozen messages only so long"
14686 .endtable
14687
14688
14689
14690 .section "Data lookups" "SECID101"
14691 .table2
14692 .row &%ibase_servers%&               "InterBase servers"
14693 .row &%ldap_ca_cert_dir%&            "dir of CA certs to verify LDAP server's"
14694 .row &%ldap_ca_cert_file%&           "file of CA certs to verify LDAP server's"
14695 .row &%ldap_cert_file%&              "client cert file for LDAP"
14696 .row &%ldap_cert_key%&               "client key file for LDAP"
14697 .row &%ldap_cipher_suite%&           "TLS negotiation preference control"
14698 .row &%ldap_default_servers%&        "used if no server in query"
14699 .row &%ldap_require_cert%&           "action to take without LDAP server cert"
14700 .row &%ldap_start_tls%&              "require TLS within LDAP"
14701 .row &%ldap_version%&                "set protocol version"
14702 .row &%lookup_open_max%&             "lookup files held open"
14703 .row &%mysql_servers%&               "default MySQL servers"
14704 .row &%oracle_servers%&              "Oracle servers"
14705 .row &%pgsql_servers%&               "default PostgreSQL servers"
14706 .row &%sqlite_lock_timeout%&         "as it says"
14707 .endtable
14708
14709
14710
14711 .section "Message ids" "SECID102"
14712 .table2
14713 .row &%message_id_header_domain%&    "used to build &'Message-ID:'& header"
14714 .row &%message_id_header_text%&      "ditto"
14715 .endtable
14716
14717
14718
14719 .section "Embedded Perl Startup" "SECID103"
14720 .table2
14721 .row &%perl_at_start%&               "always start the interpreter"
14722 .row &%perl_startup%&                "code to obey when starting Perl"
14723 .row &%perl_taintmode%&              "enable taint mode in Perl"
14724 .endtable
14725
14726
14727
14728 .section "Daemon" "SECID104"
14729 .table2
14730 .row &%daemon_smtp_ports%&           "default ports"
14731 .row &%daemon_startup_retries%&      "number of times to retry"
14732 .row &%daemon_startup_sleep%&        "time to sleep between tries"
14733 .row &%extra_local_interfaces%&      "not necessarily listened on"
14734 .row &%local_interfaces%&            "on which to listen, with optional ports"
14735 .row &%notifier_socket%&             "override compiled-in value"
14736 .row &%pid_file_path%&               "override compiled-in value"
14737 .row &%queue_run_max%&               "maximum simultaneous queue runners"
14738 .row &%smtp_backlog_monitor%&        "level to log listen backlog"
14739 .endtable
14740
14741
14742
14743 .section "Resource control" "SECID105"
14744 .table2
14745 .row &%check_log_inodes%&            "before accepting a message"
14746 .row &%check_log_space%&             "before accepting a message"
14747 .row &%check_spool_inodes%&          "before accepting a message"
14748 .row &%check_spool_space%&           "before accepting a message"
14749 .row &%deliver_queue_load_max%&      "no queue deliveries if load high"
14750 .row &%queue_only_load%&             "queue incoming if load high"
14751 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
14752 .row &%queue_run_max%&               "maximum simultaneous queue runners"
14753 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
14754 .row &%smtp_accept_max%&             "simultaneous incoming connections"
14755 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
14756 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
14757 .row &%smtp_accept_max_per_connection%& "messages per connection"
14758 .row &%smtp_accept_max_per_host%&    "connections from one host"
14759 .row &%smtp_accept_queue%&           "queue mail if more connections"
14760 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
14761                                            connection"
14762 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
14763 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
14764 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
14765 .row &%smtp_load_reserve%&           "SMTP from reserved hosts if load high"
14766 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
14767 .endtable
14768
14769
14770
14771 .section "Policy controls" "SECID106"
14772 .table2
14773 .row &%acl_not_smtp%&                "ACL for non-SMTP messages"
14774 .row &%acl_not_smtp_mime%&           "ACL for non-SMTP MIME parts"
14775 .row &%acl_not_smtp_start%&          "ACL for start of non-SMTP message"
14776 .row &%acl_smtp_auth%&               "ACL for AUTH"
14777 .row &%acl_smtp_connect%&            "ACL for connection"
14778 .row &%acl_smtp_data%&               "ACL for DATA"
14779 .row &%acl_smtp_data_prdr%&          "ACL for DATA, per-recipient"
14780 .row &%acl_smtp_dkim%&               "ACL for DKIM verification"
14781 .row &%acl_smtp_etrn%&               "ACL for ETRN"
14782 .row &%acl_smtp_expn%&               "ACL for EXPN"
14783 .row &%acl_smtp_helo%&               "ACL for EHLO or HELO"
14784 .row &%acl_smtp_mail%&               "ACL for MAIL"
14785 .row &%acl_smtp_mailauth%&           "ACL for AUTH on MAIL command"
14786 .row &%acl_smtp_mime%&               "ACL for MIME parts"
14787 .row &%acl_smtp_notquit%&            "ACL for non-QUIT terminations"
14788 .row &%acl_smtp_predata%&            "ACL for start of data"
14789 .row &%acl_smtp_quit%&               "ACL for QUIT"
14790 .row &%acl_smtp_rcpt%&               "ACL for RCPT"
14791 .row &%acl_smtp_starttls%&           "ACL for STARTTLS"
14792 .row &%acl_smtp_vrfy%&               "ACL for VRFY"
14793 .row &%av_scanner%&                  "specify virus scanner"
14794 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
14795                                       words""&"
14796 .row &%dns_cname_loops%&             "follow CNAMEs returned by resolver"
14797 .row &%dns_csa_search_limit%&        "control CSA parent search depth"
14798 .row &%dns_csa_use_reverse%&         "en/disable CSA IP reverse search"
14799 .row &%header_maxsize%&              "total size of message header"
14800 .row &%header_line_maxsize%&         "individual header line limit"
14801 .row &%helo_accept_junk_hosts%&      "allow syntactic junk from these hosts"
14802 .row &%helo_allow_chars%&            "allow illegal chars in HELO names"
14803 .row &%helo_lookup_domains%&         "lookup hostname for these HELO names"
14804 .row &%helo_try_verify_hosts%&       "HELO soft-checked for these hosts"
14805 .row &%helo_verify_hosts%&           "HELO hard-checked for these hosts"
14806 .row &%host_lookup%&                 "host name looked up for these hosts"
14807 .row &%host_lookup_order%&           "order of DNS and local name lookups"
14808 .row &%hosts_proxy%&                 "use proxy protocol for these hosts"
14809 .row &%host_reject_connection%&      "reject connection from these hosts"
14810 .row &%hosts_treat_as_local%&        "useful in some cluster configurations"
14811 .row &%local_scan_timeout%&          "timeout for &[local_scan()]&"
14812 .row &%message_size_limit%&          "for all messages"
14813 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
14814 .row &%proxy_protocol_timeout%&      "timeout for proxy protocol negotiation"
14815 .row &%spamd_address%&               "set interface to SpamAssassin"
14816 .row &%strict_acl_vars%&             "object to unset ACL variables"
14817 .row &%spf_smtp_comment_template%&   "template for &$spf_smtp_comment$&"
14818 .endtable
14819
14820
14821
14822 .section "Callout cache" "SECID107"
14823 .table2
14824 .row &%callout_domain_negative_expire%& "timeout for negative domain cache &&&
14825                                          item"
14826 .row &%callout_domain_positive_expire%& "timeout for positive domain cache &&&
14827                                          item"
14828 .row &%callout_negative_expire%&     "timeout for negative address cache item"
14829 .row &%callout_positive_expire%&     "timeout for positive address cache item"
14830 .row &%callout_random_local_part%&   "string to use for &""random""& testing"
14831 .endtable
14832
14833
14834
14835 .section "TLS" "SECID108"
14836 .table2
14837 .row &%gnutls_compat_mode%&          "use GnuTLS compatibility mode"
14838 .row &%gnutls_allow_auto_pkcs11%&    "allow GnuTLS to autoload PKCS11 modules"
14839 .row &%hosts_require_alpn%&          "mandatory ALPN"
14840 .row &%openssl_options%&             "adjust OpenSSL compatibility options"
14841 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
14842 .row &%tls_alpn%&                    "acceptable protocol names"
14843 .row &%tls_certificate%&             "location of server certificate"
14844 .row &%tls_crl%&                     "certificate revocation list"
14845 .row &%tls_dh_max_bits%&             "clamp D-H bit count suggestion"
14846 .row &%tls_dhparam%&                 "DH parameters for server"
14847 .row &%tls_eccurve%&                 "EC curve selection for server"
14848 .row &%tls_ocsp_file%&               "location of server certificate status proof"
14849 .row &%tls_on_connect_ports%&        "specify SSMTP (SMTPS) ports"
14850 .row &%tls_privatekey%&              "location of server private key"
14851 .row &%tls_remember_esmtp%&          "don't reset after starting TLS"
14852 .row &%tls_require_ciphers%&         "specify acceptable ciphers"
14853 .row &%tls_try_verify_hosts%&        "try to verify client certificate"
14854 .row &%tls_verify_certificates%&     "expected client certificates"
14855 .row &%tls_verify_hosts%&            "insist on client certificate verify"
14856 .endtable
14857
14858
14859
14860 .section "Local user handling" "SECID109"
14861 .table2
14862 .row &%finduser_retries%&            "useful in NIS environments"
14863 .row &%gecos_name%&                  "used when creating &'Sender:'&"
14864 .row &%gecos_pattern%&               "ditto"
14865 .row &%max_username_length%&         "for systems that truncate"
14866 .row &%unknown_login%&               "used when no login name found"
14867 .row &%unknown_username%&            "ditto"
14868 .row &%uucp_from_pattern%&           "for recognizing &""From ""& lines"
14869 .row &%uucp_from_sender%&            "ditto"
14870 .endtable
14871
14872
14873
14874 .section "All incoming messages (SMTP and non-SMTP)" "SECID110"
14875 .table2
14876 .row &%header_maxsize%&              "total size of message header"
14877 .row &%header_line_maxsize%&         "individual header line limit"
14878 .row &%message_size_limit%&          "applies to all messages"
14879 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
14880 .row &%received_header_text%&        "expanded to make &'Received:'&"
14881 .row &%received_headers_max%&        "for mail loop detection"
14882 .row &%recipients_max%&              "limit per message"
14883 .row &%recipients_max_reject%&       "permanently reject excess recipients"
14884 .endtable
14885
14886
14887
14888
14889 .section "Non-SMTP incoming messages" "SECID111"
14890 .table2
14891 .row &%receive_timeout%&             "for non-SMTP messages"
14892 .endtable
14893
14894
14895
14896
14897
14898 .section "Incoming SMTP messages" "SECID112"
14899 See also the &'Policy controls'& section above.
14900
14901 .table2
14902 .row &%dkim_verify_hashes%&          "DKIM hash methods accepted for signatures"
14903 .row &%dkim_verify_keytypes%&        "DKIM key types accepted for signatures"
14904 .row &%dkim_verify_min_keysizes%&    "DKIM key sizes accepted for signatures"
14905 .row &%dkim_verify_signers%&         "DKIM domains for which DKIM ACL is run"
14906 .row &%dmarc_forensic_sender%&       "DMARC sender for report messages"
14907 .row &%dmarc_history_file%&          "DMARC results log"
14908 .row &%dmarc_tld_file%&              "DMARC toplevel domains file"
14909 .row &%host_lookup%&                 "host name looked up for these hosts"
14910 .row &%host_lookup_order%&           "order of DNS and local name lookups"
14911 .row &%recipient_unqualified_hosts%& "may send unqualified recipients"
14912 .row &%rfc1413_hosts%&               "make ident calls to these hosts"
14913 .row &%rfc1413_query_timeout%&       "zero disables ident calls"
14914 .row &%sender_unqualified_hosts%&    "may send unqualified senders"
14915 .row &%smtp_accept_keepalive%&       "some TCP/IP magic"
14916 .row &%smtp_accept_max%&             "simultaneous incoming connections"
14917 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
14918 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
14919 .row &%smtp_accept_max_per_connection%& "messages per connection"
14920 .row &%smtp_accept_max_per_host%&    "connections from one host"
14921 .row &%smtp_accept_queue%&           "queue mail if more connections"
14922 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
14923                                            connection"
14924 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
14925 .row &%smtp_active_hostname%&        "host name to use in messages"
14926 .row &%smtp_banner%&                 "text for welcome banner"
14927 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
14928 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
14929 .row &%smtp_enforce_sync%&           "of SMTP command/responses"
14930 .row &%smtp_etrn_command%&           "what to run for ETRN"
14931 .row &%smtp_etrn_serialize%&         "only one at once"
14932 .row &%smtp_load_reserve%&           "only reserve hosts if this load"
14933 .row &%smtp_max_unknown_commands%&   "before dropping connection"
14934 .row &%smtp_ratelimit_hosts%&        "apply ratelimiting to these hosts"
14935 .row &%smtp_ratelimit_mail%&         "ratelimit for MAIL commands"
14936 .row &%smtp_ratelimit_rcpt%&         "ratelimit for RCPT commands"
14937 .row &%smtp_receive_timeout%&        "per command or data line"
14938 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
14939 .row &%smtp_return_error_details%&   "give detail on rejections"
14940 .endtable
14941
14942
14943
14944 .section "SMTP extensions" "SECID113"
14945 .table2
14946 .row &%accept_8bitmime%&             "advertise 8BITMIME"
14947 .row &%auth_advertise_hosts%&        "advertise AUTH to these hosts"
14948 .row &%chunking_advertise_hosts%&    "advertise CHUNKING to these hosts"
14949 .row &%dsn_advertise_hosts%&         "advertise DSN extensions to these hosts"
14950 .row &%ignore_fromline_hosts%&       "allow &""From ""& from these hosts"
14951 .row &%ignore_fromline_local%&       "allow &""From ""& from local SMTP"
14952 .row &%pipelining_advertise_hosts%&  "advertise pipelining to these hosts"
14953 .row &%pipelining_connect_advertise_hosts%& "advertise pipelining to these hosts"
14954 .row &%prdr_enable%&                 "advertise PRDR to all hosts"
14955 .row &%smtputf8_advertise_hosts%&    "advertise SMTPUTF8 to these hosts"
14956 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
14957 .endtable
14958
14959
14960
14961 .section "Processing messages" "SECID114"
14962 .table2
14963 .row &%allow_domain_literals%&       "recognize domain literal syntax"
14964 .row &%allow_mx_to_ip%&              "allow MX to point to IP address"
14965 .row &%allow_utf8_domains%&          "in addresses"
14966 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
14967                                       words""&"
14968 .row &%delivery_date_remove%&        "from incoming messages"
14969 .row &%envelope_to_remove%&          "from incoming messages"
14970 .row &%extract_addresses_remove_arguments%& "affects &%-t%& processing"
14971 .row &%headers_charset%&             "default for translations"
14972 .row &%qualify_domain%&              "default for senders"
14973 .row &%qualify_recipient%&           "default for recipients"
14974 .row &%return_path_remove%&          "from incoming messages"
14975 .row &%strip_excess_angle_brackets%& "in addresses"
14976 .row &%strip_trailing_dot%&          "at end of addresses"
14977 .row &%untrusted_set_sender%&        "untrusted can set envelope sender"
14978 .endtable
14979
14980
14981
14982 .section "System filter" "SECID115"
14983 .table2
14984 .row &%system_filter%&               "locate system filter"
14985 .row &%system_filter_directory_transport%& "transport for delivery to a &&&
14986                                             directory"
14987 .row &%system_filter_file_transport%& "transport for delivery to a file"
14988 .row &%system_filter_group%&         "group for filter running"
14989 .row &%system_filter_pipe_transport%& "transport for delivery to a pipe"
14990 .row &%system_filter_reply_transport%& "transport for autoreply delivery"
14991 .row &%system_filter_user%&          "user for filter running"
14992 .endtable
14993
14994
14995
14996 .section "Routing and delivery" "SECID116"
14997 .table2
14998 .row &%disable_ipv6%&                "do no IPv6 processing"
14999 .row &%dns_again_means_nonexist%&    "for broken domains"
15000 .row &%dns_check_names_pattern%&     "pre-DNS syntax check"
15001 .row &%dns_dnssec_ok%&               "parameter for resolver"
15002 .row &%dns_ipv4_lookup%&             "only v4 lookup for these domains"
15003 .row &%dns_retrans%&                 "parameter for resolver"
15004 .row &%dns_retry%&                   "parameter for resolver"
15005 .row &%dns_trust_aa%&                "DNS zones trusted as authentic"
15006 .row &%dns_use_edns0%&               "parameter for resolver"
15007 .row &%hold_domains%&                "hold delivery for these domains"
15008 .row &%local_interfaces%&            "for routing checks"
15009 .row &%queue_domains%&               "no immediate delivery for these"
15010 .row &%queue_fast_ramp%&             "parallel delivery with 2-phase queue run"
15011 .row &%queue_only%&                  "no immediate delivery at all"
15012 .row &%queue_only_file%&             "no immediate delivery if file exists"
15013 .row &%queue_only_load%&             "no immediate delivery if load is high"
15014 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
15015 .row &%queue_only_override%&         "allow command line to override"
15016 .row &%queue_run_in_order%&          "order of arrival"
15017 .row &%queue_run_max%&               "of simultaneous queue runners"
15018 .row &%queue_smtp_domains%&          "no immediate SMTP delivery for these"
15019 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
15020 .row &%remote_sort_domains%&         "order of remote deliveries"
15021 .row &%retry_data_expire%&           "timeout for retry data"
15022 .row &%retry_interval_max%&          "safety net for retry rules"
15023 .endtable
15024
15025
15026
15027 .section "Bounce and warning messages" "SECID117"
15028 .table2
15029 .row &%bounce_message_file%&         "content of bounce"
15030 .row &%bounce_message_text%&         "content of bounce"
15031 .row &%bounce_return_body%&          "include body if returning message"
15032 .row &%bounce_return_linesize_limit%& "limit on returned message line length"
15033 .row &%bounce_return_message%&       "include original message in bounce"
15034 .row &%bounce_return_size_limit%&    "limit on returned message"
15035 .row &%bounce_sender_authentication%& "send authenticated sender with bounce"
15036 .row &%dsn_from%&                    "set &'From:'& contents in bounces"
15037 .row &%errors_copy%&                 "copy bounce messages"
15038 .row &%errors_reply_to%&             "&'Reply-to:'& in bounces"
15039 .row &%delay_warning%&               "time schedule"
15040 .row &%delay_warning_condition%&     "condition for warning messages"
15041 .row &%ignore_bounce_errors_after%&  "discard undeliverable bounces"
15042 .row &%smtp_return_error_details%&   "give detail on rejections"
15043 .row &%warn_message_file%&           "content of warning message"
15044 .endtable
15045
15046
15047
15048 .section "Alphabetical list of main options" "SECTalomo"
15049 Those options that undergo string expansion before use are marked with
15050 &dagger;.
15051
15052 .option accept_8bitmime main boolean true
15053 .cindex "8BITMIME"
15054 .cindex "8-bit characters"
15055 .cindex "log" "selectors"
15056 .cindex "log" "8BITMIME"
15057 .cindex "ESMTP extensions" 8BITMIME
15058 This option causes Exim to send 8BITMIME in its response to an SMTP
15059 EHLO command, and to accept the BODY= parameter on MAIL commands.
15060 However, though Exim is 8-bit clean, it is not a protocol converter, and it
15061 takes no steps to do anything special with messages received by this route.
15062
15063 Historically Exim kept this option off by default, but the maintainers
15064 feel that in today's Internet, this causes more problems than it solves.
15065 It now defaults to true.
15066 A more detailed analysis of the issues is provided by Dan Bernstein:
15067 .display
15068 &url(https://cr.yp.to/smtp/8bitmime.html)
15069 .endd
15070
15071 To log received 8BITMIME status use
15072 .code
15073 log_selector = +8bitmime
15074 .endd
15075
15076 .option acl_not_smtp main string&!! unset
15077 .cindex "&ACL;" "for non-SMTP messages"
15078 .cindex "non-SMTP messages" "ACLs for"
15079 This option defines the ACL that is run when a non-SMTP message has been
15080 read and is on the point of being accepted. See chapter &<<CHAPACL>>& for
15081 further details.
15082
15083 .option acl_not_smtp_mime main string&!! unset
15084 This option defines the ACL that is run for individual MIME parts of non-SMTP
15085 messages. It operates in exactly the same way as &%acl_smtp_mime%& operates for
15086 SMTP messages.
15087
15088 .option acl_not_smtp_start main string&!! unset
15089 .cindex "&ACL;" "at start of non-SMTP message"
15090 .cindex "non-SMTP messages" "ACLs for"
15091 This option defines the ACL that is run before Exim starts reading a
15092 non-SMTP message. See chapter &<<CHAPACL>>& for further details.
15093
15094 .option acl_smtp_auth main string&!! unset
15095 .cindex "&ACL;" "setting up for SMTP commands"
15096 .cindex "AUTH" "ACL for"
15097 This option defines the ACL that is run when an SMTP AUTH command is
15098 received. See chapter &<<CHAPACL>>& for further details.
15099
15100 .option acl_smtp_connect main string&!! unset
15101 .cindex "&ACL;" "on SMTP connection"
15102 This option defines the ACL that is run when an SMTP connection is received.
15103 See chapter &<<CHAPACL>>& for further details.
15104
15105 .option acl_smtp_data main string&!! unset
15106 .cindex "DATA" "ACL for"
15107 This option defines the ACL that is run after an SMTP DATA command has been
15108 processed and the message itself has been received, but before the final
15109 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
15110
15111 .option acl_smtp_data_prdr main string&!! accept
15112 .cindex "PRDR" "ACL for"
15113 .cindex "DATA" "PRDR ACL for"
15114 .cindex "&ACL;" "PRDR-related"
15115 .cindex "&ACL;" "per-user data processing"
15116 This option defines the ACL that,
15117 if the PRDR feature has been negotiated,
15118 is run for each recipient after an SMTP DATA command has been
15119 processed and the message itself has been received, but before the
15120 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
15121
15122 .option acl_smtp_dkim main string&!! unset
15123 .cindex DKIM "ACL for"
15124 This option defines the ACL that is run for each DKIM signature
15125 (by default, or as specified in the dkim_verify_signers option)
15126 of a received message.
15127 See section &<<SECDKIMVFY>>& for further details.
15128
15129 .option acl_smtp_etrn main string&!! unset
15130 .cindex "ETRN" "ACL for"
15131 This option defines the ACL that is run when an SMTP ETRN command is
15132 received. See chapter &<<CHAPACL>>& for further details.
15133
15134 .option acl_smtp_expn main string&!! unset
15135 .cindex "EXPN" "ACL for"
15136 This option defines the ACL that is run when an SMTP EXPN command is
15137 received. See chapter &<<CHAPACL>>& for further details.
15138
15139 .option acl_smtp_helo main string&!! unset
15140 .cindex "EHLO" "ACL for"
15141 .cindex "HELO" "ACL for"
15142 This option defines the ACL that is run when an SMTP EHLO or HELO
15143 command is received. See chapter &<<CHAPACL>>& for further details.
15144
15145
15146 .option acl_smtp_mail main string&!! unset
15147 .cindex "MAIL" "ACL for"
15148 This option defines the ACL that is run when an SMTP MAIL command is
15149 received. See chapter &<<CHAPACL>>& for further details.
15150
15151 .option acl_smtp_mailauth main string&!! unset
15152 .cindex "AUTH" "on MAIL command"
15153 This option defines the ACL that is run when there is an AUTH parameter on
15154 a MAIL command. See chapter &<<CHAPACL>>& for details of ACLs, and chapter
15155 &<<CHAPSMTPAUTH>>& for details of authentication.
15156
15157 .option acl_smtp_mime main string&!! unset
15158 .cindex "MIME content scanning" "ACL for"
15159 This option is available when Exim is built with the content-scanning
15160 extension. It defines the ACL that is run for each MIME part in a message. See
15161 section &<<SECTscanmimepart>>& for details.
15162
15163 .option acl_smtp_notquit main string&!! unset
15164 .cindex "not-QUIT, ACL for"
15165 This option defines the ACL that is run when an SMTP session
15166 ends without a QUIT command being received.
15167 See chapter &<<CHAPACL>>& for further details.
15168
15169 .option acl_smtp_predata main string&!! unset
15170 This option defines the ACL that is run when an SMTP DATA command is
15171 received, before the message itself is received. See chapter &<<CHAPACL>>& for
15172 further details.
15173
15174 .option acl_smtp_quit main string&!! unset
15175 .cindex "QUIT, ACL for"
15176 This option defines the ACL that is run when an SMTP QUIT command is
15177 received. See chapter &<<CHAPACL>>& for further details.
15178
15179 .option acl_smtp_rcpt main string&!! unset
15180 .cindex "RCPT" "ACL for"
15181 This option defines the ACL that is run when an SMTP RCPT command is
15182 received. See chapter &<<CHAPACL>>& for further details.
15183
15184 .option acl_smtp_starttls main string&!! unset
15185 .cindex "STARTTLS, ACL for"
15186 This option defines the ACL that is run when an SMTP STARTTLS command is
15187 received. See chapter &<<CHAPACL>>& for further details.
15188
15189 .option acl_smtp_vrfy main string&!! unset
15190 .cindex "VRFY" "ACL for"
15191 This option defines the ACL that is run when an SMTP VRFY command is
15192 received. See chapter &<<CHAPACL>>& for further details.
15193
15194 .option add_environment main "string list" empty
15195 .cindex "environment" "set values"
15196 This option adds individual environment variables that the
15197 currently linked libraries and programs in child processes may use.
15198 Each list element should be of the form &"name=value"&.
15199
15200 See &<<SECTpipeenv>>& for the environment of &(pipe)& transports.
15201
15202 .option admin_groups main "string list&!!" unset
15203 .cindex "admin user"
15204 This option is expanded just once, at the start of Exim's processing. If the
15205 current group or any of the supplementary groups of an Exim caller is in this
15206 colon-separated list, the caller has admin privileges. If all your system
15207 programmers are in a specific group, for example, you can give them all Exim
15208 admin privileges by putting that group in &%admin_groups%&. However, this does
15209 not permit them to read Exim's spool files (whose group owner is the Exim gid).
15210 To permit this, you have to add individuals to the Exim group.
15211
15212 .option allow_domain_literals main boolean false
15213 .cindex "domain literal"
15214 If this option is set, the RFC 2822 domain literal format is permitted in
15215 email addresses. The option is not set by default, because the domain literal
15216 format is not normally required these days, and few people know about it. It
15217 has, however, been exploited by mail abusers.
15218
15219 Unfortunately, it seems that some DNS black list maintainers are using this
15220 format to report black listing to postmasters. If you want to accept messages
15221 addressed to your hosts by IP address, you need to set
15222 &%allow_domain_literals%& true, and also to add &`@[]`& to the list of local
15223 domains (defined in the named domain list &%local_domains%& in the default
15224 configuration). This &"magic string"& matches the domain literal form of all
15225 the local host's IP addresses.
15226
15227 .new
15228 .option allow_insecure_tainted_data main boolean false
15229 .cindex "de-tainting"
15230 .oindex "allow_insecure_tainted_data"
15231 The handling of tainted data may break older (pre 4.94) configurations.
15232 Setting this option to "true" turns taint errors (which result in a temporary
15233 message rejection) into warnings. This option is meant as mitigation only
15234 and deprecated already today. Future releases of Exim may ignore it.
15235 The &%taint%& log selector can be used to suppress even the warnings.
15236 .wen
15237
15238
15239
15240 .option allow_mx_to_ip main boolean false
15241 .cindex "MX record" "pointing to IP address"
15242 It appears that more and more DNS zone administrators are breaking the rules
15243 and putting domain names that look like IP addresses on the right hand side of
15244 MX records. Exim follows the rules and rejects this, giving an error message
15245 that explains the misconfiguration. However, some other MTAs support this
15246 practice, so to avoid &"Why can't Exim do this?"& complaints,
15247 &%allow_mx_to_ip%& exists, in order to enable this heinous activity. It is not
15248 recommended, except when you have no other choice.
15249
15250 .option allow_utf8_domains main boolean false
15251 .cindex "domain" "UTF-8 characters in"
15252 .cindex "UTF-8" "in domain name"
15253 Lots of discussion is going on about internationalized domain names. One
15254 camp is strongly in favour of just using UTF-8 characters, and it seems
15255 that at least two other MTAs permit this.
15256 This option allows Exim users to experiment if they wish.
15257
15258 If it is set true, Exim's domain parsing function allows valid
15259 UTF-8 multicharacters to appear in domain name components, in addition to
15260 letters, digits, and hyphens.
15261
15262 If Exim is built with internationalization support
15263 and the SMTPUTF8 ESMTP option is in use (see chapter &<<CHAPi18n>>&)
15264 this option can be left as default.
15265 Without that,
15266 if you want to look up such domain names in the DNS, you must also
15267 adjust the value of &%dns_check_names_pattern%& to match the extended form. A
15268 suitable setting is:
15269 .code
15270 dns_check_names_pattern = (?i)^(?>(?(1)\.|())[a-z0-9\xc0-\xff]\
15271   (?>[-a-z0-9\x80-\xff]*[a-z0-9\x80-\xbf])?)+$
15272 .endd
15273 Alternatively, you can just disable this feature by setting
15274 .code
15275 dns_check_names_pattern =
15276 .endd
15277 That is, set the option to an empty string so that no check is done.
15278
15279
15280 .option auth_advertise_hosts main "host list&!!" *
15281 .cindex "authentication" "advertising"
15282 .cindex "AUTH" "advertising"
15283 .cindex "ESMTP extensions" AUTH
15284 If any server authentication mechanisms are configured, Exim advertises them in
15285 response to an EHLO command only if the calling host matches this list.
15286 Otherwise, Exim does not advertise AUTH.
15287 Exim does not accept AUTH commands from clients to which it has not
15288 advertised the availability of AUTH. The advertising of individual
15289 authentication mechanisms can be controlled by the use of the
15290 &%server_advertise_condition%& generic authenticator option on the individual
15291 authenticators. See chapter &<<CHAPSMTPAUTH>>& for further details.
15292
15293 Certain mail clients (for example, Netscape) require the user to provide a name
15294 and password for authentication if AUTH is advertised, even though it may
15295 not be needed (the host may accept messages from hosts on its local LAN without
15296 authentication, for example). The &%auth_advertise_hosts%& option can be used
15297 to make these clients more friendly by excluding them from the set of hosts to
15298 which Exim advertises AUTH.
15299
15300 .cindex "AUTH" "advertising when encrypted"
15301 If you want to advertise the availability of AUTH only when the connection
15302 is encrypted using TLS, you can make use of the fact that the value of this
15303 option is expanded, with a setting like this:
15304 .code
15305 auth_advertise_hosts = ${if eq{$tls_in_cipher}{}{}{*}}
15306 .endd
15307 .vindex "&$tls_in_cipher$&"
15308 If &$tls_in_cipher$& is empty, the session is not encrypted, and the result of
15309 the expansion is empty, thus matching no hosts. Otherwise, the result of the
15310 expansion is *, which matches all hosts.
15311
15312
15313 .option auto_thaw main time 0s
15314 .cindex "thawing messages"
15315 .cindex "unfreezing messages"
15316 If this option is set to a time greater than zero, a queue runner will try a
15317 new delivery attempt on any frozen message, other than a bounce message, if
15318 this much time has passed since it was frozen. This may result in the message
15319 being re-frozen if nothing has changed since the last attempt. It is a way of
15320 saying &"keep on trying, even though there are big problems"&.
15321
15322 &*Note*&: This is an old option, which predates &%timeout_frozen_after%& and
15323 &%ignore_bounce_errors_after%&. It is retained for compatibility, but it is not
15324 thought to be very useful any more, and its use should probably be avoided.
15325
15326
15327 .option av_scanner main string "see below"
15328 This option is available if Exim is built with the content-scanning extension.
15329 It specifies which anti-virus scanner to use. The default value is:
15330 .code
15331 sophie:/var/run/sophie
15332 .endd
15333 If the value of &%av_scanner%& starts with a dollar character, it is expanded
15334 before use. See section &<<SECTscanvirus>>& for further details.
15335
15336
15337 .option bi_command main string unset
15338 .oindex "&%-bi%&"
15339 This option supplies the name of a command that is run when Exim is called with
15340 the &%-bi%& option (see chapter &<<CHAPcommandline>>&). The string value is
15341 just the command name, it is not a complete command line. If an argument is
15342 required, it must come from the &%-oA%& command line option.
15343
15344
15345 .option bounce_message_file main string&!! unset
15346 .cindex "bounce message" "customizing"
15347 .cindex "customizing" "bounce message"
15348 This option defines a template file containing paragraphs of text to be used
15349 for constructing bounce messages.  Details of the file's contents are given in
15350 chapter &<<CHAPemsgcust>>&.
15351 .cindex bounce_message_file "tainted data"
15352 The option is expanded to give the file path, which must be
15353 absolute and untainted.
15354 See also &%warn_message_file%&.
15355
15356
15357 .option bounce_message_text main string unset
15358 When this option is set, its contents are included in the default bounce
15359 message immediately after &"This message was created automatically by mail
15360 delivery software."& It is not used if &%bounce_message_file%& is set.
15361
15362 .option bounce_return_body main boolean true
15363 .cindex "bounce message" "including body"
15364 This option controls whether the body of an incoming message is included in a
15365 bounce message when &%bounce_return_message%& is true. The default setting
15366 causes the entire message, both header and body, to be returned (subject to the
15367 value of &%bounce_return_size_limit%&). If this option is false, only the
15368 message header is included. In the case of a non-SMTP message containing an
15369 error that is detected during reception, only those header lines preceding the
15370 point at which the error was detected are returned.
15371 .cindex "bounce message" "including original"
15372
15373 .option bounce_return_linesize_limit main integer 998
15374 .cindex "size" "of bounce lines, limit"
15375 .cindex "bounce message" "line length limit"
15376 .cindex "limit" "bounce message line length"
15377 This option sets a limit in bytes on the line length of messages
15378 that are returned to senders due to delivery problems,
15379 when &%bounce_return_message%& is true.
15380 The default value corresponds to RFC limits.
15381 If the message being returned has lines longer than this value it is
15382 treated as if the &%bounce_return_size_limit%& (below) restriction was exceeded.
15383
15384 The option also applies to bounces returned when an error is detected
15385 during reception of a message.
15386 In this case lines from the original are truncated.
15387
15388 The option does not apply to messages generated by an &(autoreply)& transport.
15389
15390
15391 .option bounce_return_message main boolean true
15392 If this option is set false, none of the original message is included in
15393 bounce messages generated by Exim. See also &%bounce_return_size_limit%& and
15394 &%bounce_return_body%&.
15395
15396
15397 .option bounce_return_size_limit main integer 100K
15398 .cindex "size" "of bounce, limit"
15399 .cindex "bounce message" "size limit"
15400 .cindex "limit" "bounce message size"
15401 This option sets a limit in bytes on the size of messages that are returned to
15402 senders as part of bounce messages when &%bounce_return_message%& is true. The
15403 limit should be less than the value of the global &%message_size_limit%& and of
15404 any &%message_size_limit%& settings on transports, to allow for the bounce text
15405 that Exim generates. If this option is set to zero there is no limit.
15406
15407 When the body of any message that is to be included in a bounce message is
15408 greater than the limit, it is truncated, and a comment pointing this out is
15409 added at the top. The actual cutoff may be greater than the value given, owing
15410 to the use of buffering for transferring the message in chunks (typically 8K in
15411 size). The idea is to save bandwidth on those undeliverable 15-megabyte
15412 messages.
15413
15414 .option bounce_sender_authentication main string unset
15415 .cindex "bounce message" "sender authentication"
15416 .cindex "authentication" "bounce message"
15417 .cindex "AUTH" "on bounce message"
15418 This option provides an authenticated sender address that is sent with any
15419 bounce messages generated by Exim that are sent over an authenticated SMTP
15420 connection. A typical setting might be:
15421 .code
15422 bounce_sender_authentication = mailer-daemon@my.domain.example
15423 .endd
15424 which would cause bounce messages to be sent using the SMTP command:
15425 .code
15426 MAIL FROM:<> AUTH=mailer-daemon@my.domain.example
15427 .endd
15428 The value of &%bounce_sender_authentication%& must always be a complete email
15429 address.
15430
15431 .option callout_domain_negative_expire main time 3h
15432 .cindex "caching" "callout timeouts"
15433 .cindex "callout" "caching timeouts"
15434 This option specifies the expiry time for negative callout cache data for a
15435 domain. See section &<<SECTcallver>>& for details of callout verification, and
15436 section &<<SECTcallvercache>>& for details of the caching.
15437
15438
15439 .option callout_domain_positive_expire main time 7d
15440 This option specifies the expiry time for positive callout cache data for a
15441 domain. See section &<<SECTcallver>>& for details of callout verification, and
15442 section &<<SECTcallvercache>>& for details of the caching.
15443
15444
15445 .option callout_negative_expire main time 2h
15446 This option specifies the expiry time for negative callout cache data for an
15447 address. See section &<<SECTcallver>>& for details of callout verification, and
15448 section &<<SECTcallvercache>>& for details of the caching.
15449
15450
15451 .option callout_positive_expire main time 24h
15452 This option specifies the expiry time for positive callout cache data for an
15453 address. See section &<<SECTcallver>>& for details of callout verification, and
15454 section &<<SECTcallvercache>>& for details of the caching.
15455
15456
15457 .option callout_random_local_part main string&!! "see below"
15458 This option defines the &"random"& local part that can be used as part of
15459 callout verification. The default value is
15460 .code
15461 $primary_hostname-$tod_epoch-testing
15462 .endd
15463 See section &<<CALLaddparcall>>& for details of how this value is used.
15464
15465
15466 .option check_log_inodes main integer 100
15467 See &%check_spool_space%& below.
15468
15469
15470 .option check_log_space main integer 10M
15471 See &%check_spool_space%& below.
15472
15473 .oindex "&%check_rfc2047_length%&"
15474 .cindex "RFC 2047" "disabling length check"
15475 .option check_rfc2047_length main boolean true
15476 RFC 2047 defines a way of encoding non-ASCII characters in headers using a
15477 system of &"encoded words"&. The RFC specifies a maximum length for an encoded
15478 word; strings to be encoded that exceed this length are supposed to use
15479 multiple encoded words. By default, Exim does not recognize encoded words that
15480 exceed the maximum length. However, it seems that some software, in violation
15481 of the RFC, generates overlong encoded words. If &%check_rfc2047_length%& is
15482 set false, Exim recognizes encoded words of any length.
15483
15484
15485 .option check_spool_inodes main integer 100
15486 See &%check_spool_space%& below.
15487
15488
15489 .option check_spool_space main integer 10M
15490 .cindex "checking disk space"
15491 .cindex "disk space, checking"
15492 .cindex "spool directory" "checking space"
15493 The four &%check_...%& options allow for checking of disk resources before a
15494 message is accepted.
15495
15496 .vindex "&$log_inodes$&"
15497 .vindex "&$log_space$&"
15498 .vindex "&$spool_inodes$&"
15499 .vindex "&$spool_space$&"
15500 When any of these options are nonzero, they apply to all incoming messages. If you
15501 want to apply different checks to different kinds of message, you can do so by
15502 testing the variables &$log_inodes$&, &$log_space$&, &$spool_inodes$&, and
15503 &$spool_space$& in an ACL with appropriate additional conditions.
15504
15505
15506 &%check_spool_space%& and &%check_spool_inodes%& check the spool partition if
15507 either value is greater than zero, for example:
15508 .code
15509 check_spool_space = 100M
15510 check_spool_inodes = 100
15511 .endd
15512 The spool partition is the one that contains the directory defined by
15513 SPOOL_DIRECTORY in &_Local/Makefile_&. It is used for holding messages in
15514 transit.
15515
15516 &%check_log_space%& and &%check_log_inodes%&  check the partition in which log
15517 files are written if either is greater than zero. These should be set only if
15518 &%log_file_path%& and &%spool_directory%& refer to different partitions.
15519
15520 If there is less space or fewer inodes than requested, Exim refuses to accept
15521 incoming mail. In the case of SMTP input this is done by giving a 452 temporary
15522 error response to the MAIL command. If ESMTP is in use and there was a
15523 SIZE parameter on the MAIL command, its value is added to the
15524 &%check_spool_space%& value, and the check is performed even if
15525 &%check_spool_space%& is zero, unless &%no_smtp_check_spool_space%& is set.
15526
15527 The values for &%check_spool_space%& and &%check_log_space%& are held as a
15528 number of kilobytes (though specified in bytes).
15529 If a non-multiple of 1024 is specified, it is rounded up.
15530
15531 For non-SMTP input and for batched SMTP input, the test is done at start-up; on
15532 failure a message is written to stderr and Exim exits with a non-zero code, as
15533 it obviously cannot send an error message of any kind.
15534
15535 There is a slight performance penalty for these checks.
15536 Versions of Exim preceding 4.88 had these disabled by default;
15537 high-rate installations confident they will never run out of resources
15538 may wish to deliberately disable them.
15539
15540 .option chunking_advertise_hosts main "host list&!!" *
15541 .cindex CHUNKING advertisement
15542 .cindex "RFC 3030" "CHUNKING"
15543 .cindex "ESMTP extensions" CHUNKING
15544 The CHUNKING extension (RFC3030) will be advertised in the EHLO message to
15545 these hosts.
15546 Hosts may use the BDAT command as an alternate to DATA.
15547
15548 .option commandline_checks_require_admin main boolean &`false`&
15549 .cindex "restricting access to features"
15550 This option restricts various basic checking features to require an
15551 administrative user.
15552 This affects most of the &%-b*%& options, such as &%-be%&.
15553
15554 .option debug_store main boolean &`false`&
15555 .cindex debugging "memory corruption"
15556 .cindex memory debugging
15557 This option, when true, enables extra checking in Exim's internal memory
15558 management.  For use when a memory corruption issue is being investigated,
15559 it should normally be left as default.
15560
15561 .option daemon_smtp_ports main string &`smtp`&
15562 .cindex "port" "for daemon"
15563 .cindex "TCP/IP" "setting listening ports"
15564 This option specifies one or more default SMTP ports on which the Exim daemon
15565 listens. See chapter &<<CHAPinterfaces>>& for details of how it is used. For
15566 backward compatibility, &%daemon_smtp_port%& (singular) is a synonym.
15567
15568 .option daemon_startup_retries main integer 9
15569 .cindex "daemon startup, retrying"
15570 This option, along with &%daemon_startup_sleep%&, controls the retrying done by
15571 the daemon at startup when it cannot immediately bind a listening socket
15572 (typically because the socket is already in use): &%daemon_startup_retries%&
15573 defines the number of retries after the first failure, and
15574 &%daemon_startup_sleep%& defines the length of time to wait between retries.
15575
15576 .option daemon_startup_sleep main time 30s
15577 See &%daemon_startup_retries%&.
15578
15579 .option delay_warning main "time list" 24h
15580 .cindex "warning of delay"
15581 .cindex "delay warning, specifying"
15582 .cindex "queue" "delay warning"
15583 When a message is delayed, Exim sends a warning message to the sender at
15584 intervals specified by this option. The data is a colon-separated list of times
15585 after which to send warning messages. If the value of the option is an empty
15586 string or a zero time, no warnings are sent. Up to 10 times may be given. If a
15587 message has been in the queue for longer than the last time, the last interval
15588 between the times is used to compute subsequent warning times. For example,
15589 with
15590 .code
15591 delay_warning = 4h:8h:24h
15592 .endd
15593 the first message is sent after 4 hours, the second after 8 hours, and
15594 the third one after 24 hours. After that, messages are sent every 16 hours,
15595 because that is the interval between the last two times on the list. If you set
15596 just one time, it specifies the repeat interval. For example, with:
15597 .code
15598 delay_warning = 6h
15599 .endd
15600 messages are repeated every six hours. To stop warnings after a given time, set
15601 a very large time at the end of the list. For example:
15602 .code
15603 delay_warning = 2h:12h:99d
15604 .endd
15605 Note that the option is only evaluated at the time a delivery attempt fails,
15606 which depends on retry and queue-runner configuration.
15607 Typically retries will be configured more frequently than warning messages.
15608
15609 .option delay_warning_condition main string&!! "see below"
15610 .vindex "&$domain$&"
15611 The string is expanded at the time a warning message might be sent. If all the
15612 deferred addresses have the same domain, it is set in &$domain$& during the
15613 expansion. Otherwise &$domain$& is empty. If the result of the expansion is a
15614 forced failure, an empty string, or a string matching any of &"0"&, &"no"& or
15615 &"false"& (the comparison being done caselessly) then the warning message is
15616 not sent. The default is:
15617 .code
15618 delay_warning_condition = ${if or {\
15619   { !eq{$h_list-id:$h_list-post:$h_list-subscribe:}{} }\
15620   { match{$h_precedence:}{(?i)bulk|list|junk} }\
15621   { match{$h_auto-submitted:}{(?i)auto-generated|auto-replied} }\
15622   } {no}{yes}}
15623 .endd
15624 This suppresses the sending of warnings for messages that contain &'List-ID:'&,
15625 &'List-Post:'&, or &'List-Subscribe:'& headers, or have &"bulk"&, &"list"& or
15626 &"junk"& in a &'Precedence:'& header, or have &"auto-generated"& or
15627 &"auto-replied"& in an &'Auto-Submitted:'& header.
15628
15629 .option deliver_drop_privilege main boolean false
15630 .cindex "unprivileged delivery"
15631 .cindex "delivery" "unprivileged"
15632 If this option is set true, Exim drops its root privilege at the start of a
15633 delivery process, and runs as the Exim user throughout. This severely restricts
15634 the kinds of local delivery that are possible, but is viable in certain types
15635 of configuration. There is a discussion about the use of root privilege in
15636 chapter &<<CHAPsecurity>>&.
15637
15638 .option deliver_queue_load_max main fixed-point unset
15639 .cindex "load average"
15640 .cindex "queue runner" "abandoning"
15641 When this option is set, a queue run is abandoned if the system load average
15642 becomes greater than the value of the option. The option has no effect on
15643 ancient operating systems on which Exim cannot determine the load average.
15644 See also &%queue_only_load%& and &%smtp_load_reserve%&.
15645
15646
15647 .option delivery_date_remove main boolean true
15648 .cindex "&'Delivery-date:'& header line"
15649 Exim's transports have an option for adding a &'Delivery-date:'& header to a
15650 message when it is delivered, in exactly the same way as &'Return-path:'& is
15651 handled. &'Delivery-date:'& records the actual time of delivery. Such headers
15652 should not be present in incoming messages, and this option causes them to be
15653 removed at the time the message is received, to avoid any problems that might
15654 occur when a delivered message is subsequently sent on to some other recipient.
15655
15656 .option disable_fsync main boolean false
15657 .cindex "&[fsync()]&, disabling"
15658 This option is available only if Exim was built with the compile-time option
15659 ENABLE_DISABLE_FSYNC. When this is not set, a reference to &%disable_fsync%& in
15660 a runtime configuration generates an &"unknown option"& error. You should not
15661 build Exim with ENABLE_DISABLE_FSYNC or set &%disable_fsync%& unless you
15662 really, really, really understand what you are doing. &'No pre-compiled
15663 distributions of Exim should ever make this option available.'&
15664
15665 When &%disable_fsync%& is set true, Exim no longer calls &[fsync()]& to force
15666 updated files' data to be written to disc before continuing. Unexpected events
15667 such as crashes and power outages may cause data to be lost or scrambled.
15668 Here be Dragons. &*Beware.*&
15669
15670
15671 .option disable_ipv6 main boolean false
15672 .cindex "IPv6" "disabling"
15673 If this option is set true, even if the Exim binary has IPv6 support, no IPv6
15674 activities take place. AAAA records are never looked up, and any IPv6 addresses
15675 that are listed in &%local_interfaces%&, data for the &%manualroute%& router,
15676 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
15677 to handle IPv6 literal addresses.
15678
15679
15680 .option dkim_verify_hashes main "string list" "sha256 : sha512"
15681 .cindex DKIM "selecting signature algorithms"
15682 This option gives a list of hash types which are acceptable in signatures,
15683 and an order of processing.
15684 Signatures with algorithms not in the list will be ignored.
15685
15686 Acceptable values include:
15687 .code
15688 sha1
15689 sha256
15690 sha512
15691 .endd
15692
15693 Note that the acceptance of sha1 violates RFC 8301.
15694
15695 .option dkim_verify_keytypes main "string list" "ed25519 : rsa"
15696 This option gives a list of key types which are acceptable in signatures,
15697 and an order of processing.
15698 Signatures with algorithms not in the list will be ignored.
15699
15700
15701 .option dkim_verify_min_keysizes main "string list" "rsa=1024 ed25519=250"
15702 This option gives a list of key sizes which are acceptable in signatures.
15703 The list is keyed by the algorithm type for the key; the values are in bits.
15704 Signatures with keys smaller than given by this option will fail verification.
15705
15706 The default enforces the RFC 8301 minimum key size for RSA signatures.
15707
15708 .option dkim_verify_minimal main boolean false
15709 If set to true, verification of signatures will terminate after the
15710 first success.
15711
15712 .option dkim_verify_signers main "domain list&!!" $dkim_signers
15713 .cindex DKIM "controlling calls to the ACL"
15714 This option gives a list of DKIM domains for which the DKIM ACL is run.
15715 It is expanded after the message is received; by default it runs
15716 the ACL once for each signature in the message.
15717 See section &<<SECDKIMVFY>>&.
15718
15719
15720 .option dmarc_forensic_sender main string&!! unset
15721 .option dmarc_history_file main string unset
15722 .option dmarc_tld_file main string unset
15723 .cindex DMARC "main section options"
15724 These options control DMARC processing.
15725 See section &<<SECDMARC>>& for details.
15726
15727
15728 .option dns_again_means_nonexist main "domain list&!!" unset
15729 .cindex "DNS" "&""try again""& response; overriding"
15730 DNS lookups give a &"try again"& response for the DNS errors
15731 &"non-authoritative host not found"& and &"SERVERFAIL"&. This can cause Exim to
15732 keep trying to deliver a message, or to give repeated temporary errors to
15733 incoming mail. Sometimes the effect is caused by a badly set up name server and
15734 may persist for a long time. If a domain which exhibits this problem matches
15735 anything in &%dns_again_means_nonexist%&, it is treated as if it did not exist.
15736 This option should be used with care. You can make it apply to reverse lookups
15737 by a setting such as this:
15738 .code
15739 dns_again_means_nonexist = *.in-addr.arpa
15740 .endd
15741 This option applies to all DNS lookups that Exim does. It also applies when the
15742 &[gethostbyname()]& or &[getipnodebyname()]& functions give temporary errors,
15743 since these are most likely to be caused by DNS lookup problems. The
15744 &(dnslookup)& router has some options of its own for controlling what happens
15745 when lookups for MX or SRV records give temporary errors. These more specific
15746 options are applied after this global option.
15747
15748 .option dns_check_names_pattern main string "see below"
15749 .cindex "DNS" "pre-check of name syntax"
15750 When this option is set to a non-empty string, it causes Exim to check domain
15751 names for characters that are not allowed in host names before handing them to
15752 the DNS resolver, because some resolvers give temporary errors for names that
15753 contain unusual characters. If a domain name contains any unwanted characters,
15754 a &"not found"& result is forced, and the resolver is not called. The check is
15755 done by matching the domain name against a regular expression, which is the
15756 value of this option. The default pattern is
15757 .code
15758 dns_check_names_pattern = \
15759   (?i)^(?>(?(1)\.|())[^\W_](?>[a-z0-9/-]*[^\W_])?)+$
15760 .endd
15761 which permits only letters, digits, slashes, and hyphens in components, but
15762 they must start and end with a letter or digit. Slashes are not, in fact,
15763 permitted in host names, but they are found in certain NS records (which can be
15764 accessed in Exim by using a &%dnsdb%& lookup). If you set
15765 &%allow_utf8_domains%&, you must modify this pattern, or set the option to an
15766 empty string.
15767
15768 .option dns_csa_search_limit main integer 5
15769 This option controls the depth of parental searching for CSA SRV records in the
15770 DNS, as described in more detail in section &<<SECTverifyCSA>>&.
15771
15772 .option dns_csa_use_reverse main boolean true
15773 This option controls whether or not an IP address, given as a CSA domain, is
15774 reversed and looked up in the reverse DNS, as described in more detail in
15775 section &<<SECTverifyCSA>>&.
15776
15777 .option dns_cname_loops main integer 1
15778 .cindex DNS "CNAME following"
15779 This option controls the following of CNAME chains, needed if the resolver does
15780 not do it internally.
15781 As of 2018 most should, and the default can be left.
15782 If you have an ancient one, a value of 10 is likely needed.
15783
15784 The default value of one CNAME-follow is needed
15785 thanks to the observed return for an MX request,
15786 given no MX presence but a CNAME to an A, of the CNAME.
15787
15788
15789 .option dns_dnssec_ok main integer -1
15790 .cindex "DNS" "resolver options"
15791 .cindex "DNS" "DNSSEC"
15792 If this option is set to a non-negative number then Exim will initialise the
15793 DNS resolver library to either use or not use DNSSEC, overriding the system
15794 default. A value of 0 coerces DNSSEC off, a value of 1 coerces DNSSEC on.
15795
15796 If the resolver library does not support DNSSEC then this option has no effect.
15797
15798 On Linux with glibc 2.31 or newer this is insufficient, the resolver library
15799 will default to stripping out a successful validation status.
15800 This will break a previously working Exim installation.
15801 Provided that you do trust the resolver (ie, is on localhost) you can tell
15802 glibc to pass through any successful validation with a new option in
15803 &_/etc/resolv.conf_&:
15804 .code
15805 options trust-ad
15806 .endd
15807
15808
15809 .option dns_ipv4_lookup main "domain list&!!" unset
15810 .cindex "IPv6" "DNS lookup for AAAA records"
15811 .cindex "DNS" "IPv6 lookup for AAAA records"
15812 .cindex DNS "IPv6 disabling"
15813 When Exim is compiled with IPv6 support and &%disable_ipv6%& is not set, it
15814 looks for IPv6 address records (AAAA records) as well as IPv4 address records
15815 (A records) when trying to find IP addresses for hosts, unless the host's
15816 domain matches this list.
15817
15818 This is a fudge to help with name servers that give big delays or otherwise do
15819 not work for the AAAA record type. In due course, when the world's name
15820 servers have all been upgraded, there should be no need for this option.
15821 Note that all lookups, including those done for verification, are affected;
15822 this will result in verify failure for IPv6 connections or ones using names
15823 only valid for IPv6 addresses.
15824
15825
15826 .option dns_retrans main time 0s
15827 .cindex "DNS" "resolver options"
15828 .cindex timeout "dns lookup"
15829 .cindex "DNS" timeout
15830 The options &%dns_retrans%& and &%dns_retry%& can be used to set the
15831 retransmission and retry parameters for DNS lookups. Values of zero (the
15832 defaults) leave the system default settings unchanged. The first value is the
15833 time between retries, and the second is the number of retries. It isn't
15834 totally clear exactly how these settings affect the total time a DNS lookup may
15835 take. I haven't found any documentation about timeouts on DNS lookups; these
15836 parameter values are available in the external resolver interface structure,
15837 but nowhere does it seem to describe how they are used or what you might want
15838 to set in them.
15839 See also the &%slow_lookup_log%& option.
15840
15841
15842 .option dns_retry main integer 0
15843 See &%dns_retrans%& above.
15844
15845
15846 .option dns_trust_aa main "domain list&!!" unset
15847 .cindex "DNS" "resolver options"
15848 .cindex "DNS" "DNSSEC"
15849 If this option is set then lookup results marked with the AA bit
15850 (Authoritative Answer) are trusted the same way as if they were
15851 DNSSEC-verified. The authority section's name of the answer must
15852 match with this expanded domain list.
15853
15854 Use this option only if you talk directly to a resolver that is
15855 authoritative for some zones and does not set the AD (Authentic Data)
15856 bit in the answer. Some DNS servers may have an configuration option to
15857 mark the answers from their own zones as verified (they set the AD bit).
15858 Others do not have this option. It is considered as poor practice using
15859 a resolver that is an authoritative server for some zones.
15860
15861 Use this option only if you really have to (e.g. if you want
15862 to use DANE for remote delivery to a server that is listed in the DNS
15863 zones that your resolver is authoritative for).
15864
15865 If the DNS answer packet has the AA bit set and contains resource record
15866 in the answer section, the name of the first NS record appearing in the
15867 authority section is compared against the list. If the answer packet is
15868 authoritative but the answer section is empty, the name of the first SOA
15869 record in the authoritative section is used instead.
15870
15871 .cindex "DNS" "resolver options"
15872 .option dns_use_edns0 main integer -1
15873 .cindex "DNS" "resolver options"
15874 .cindex "DNS" "EDNS0"
15875 .cindex "DNS" "OpenBSD
15876 If this option is set to a non-negative number then Exim will initialise the
15877 DNS resolver library to either use or not use EDNS0 extensions, overriding
15878 the system default. A value of 0 coerces EDNS0 off, a value of 1 coerces EDNS0
15879 on.
15880
15881 If the resolver library does not support EDNS0 then this option has no effect.
15882
15883 OpenBSD's asr resolver routines are known to ignore the EDNS0 option; this
15884 means that DNSSEC will not work with Exim on that platform either, unless Exim
15885 is linked against an alternative DNS client library.
15886
15887
15888 .option drop_cr main boolean false
15889 This is an obsolete option that is now a no-op. It used to affect the way Exim
15890 handled CR and LF characters in incoming messages. What happens now is
15891 described in section &<<SECTlineendings>>&.
15892
15893 .option dsn_advertise_hosts main "host list&!!" unset
15894 .cindex "bounce messages" "success"
15895 .cindex "DSN" "success"
15896 .cindex "Delivery Status Notification" "success"
15897 .cindex "ESMTP extensions" DSN
15898 DSN extensions (RFC3461) will be advertised in the EHLO message to,
15899 and accepted from, these hosts.
15900 Hosts may use the NOTIFY and ENVID options on RCPT TO commands,
15901 and RET and ORCPT options on MAIL FROM commands.
15902 A NOTIFY=SUCCESS option requests success-DSN messages.
15903 A NOTIFY= option with no argument requests that no delay or failure DSNs
15904 are sent.
15905 &*Note*&: Supplying success-DSN messages has been criticised
15906 on privacy grounds; it can leak details of internal forwarding.
15907
15908 .option dsn_from main "string&!!" "see below"
15909 .cindex "&'From:'& header line" "in bounces"
15910 .cindex "bounce messages" "&'From:'& line, specifying"
15911 This option can be used to vary the contents of &'From:'& header lines in
15912 bounces and other automatically generated messages (&"Delivery Status
15913 Notifications"& &-- hence the name of the option). The default setting is:
15914 .code
15915 dsn_from = Mail Delivery System <Mailer-Daemon@$qualify_domain>
15916 .endd
15917 The value is expanded every time it is needed. If the expansion fails, a
15918 panic is logged, and the default value is used.
15919
15920 .option envelope_to_remove main boolean true
15921 .cindex "&'Envelope-to:'& header line"
15922 Exim's transports have an option for adding an &'Envelope-to:'& header to a
15923 message when it is delivered, in exactly the same way as &'Return-path:'& is
15924 handled. &'Envelope-to:'& records the original recipient address from the
15925 message's envelope that caused the delivery to happen. Such headers should not
15926 be present in incoming messages, and this option causes them to be removed at
15927 the time the message is received, to avoid any problems that might occur when a
15928 delivered message is subsequently sent on to some other recipient.
15929
15930
15931 .option errors_copy main "string list&!!" unset
15932 .cindex "bounce message" "copy to other address"
15933 .cindex "copy of bounce message"
15934 Setting this option causes Exim to send bcc copies of bounce messages that it
15935 generates to other addresses. &*Note*&: This does not apply to bounce messages
15936 coming from elsewhere. The value of the option is a colon-separated list of
15937 items. Each item consists of a pattern, terminated by white space, followed by
15938 a comma-separated list of email addresses. If a pattern contains spaces, it
15939 must be enclosed in double quotes.
15940
15941 Each pattern is processed in the same way as a single item in an address list
15942 (see section &<<SECTaddresslist>>&). When a pattern matches the recipient of
15943 the bounce message, the message is copied to the addresses on the list. The
15944 items are scanned in order, and once a matching one is found, no further items
15945 are examined. For example:
15946 .code
15947 errors_copy = spqr@mydomain   postmaster@mydomain.example :\
15948               rqps@mydomain   hostmaster@mydomain.example,\
15949                               postmaster@mydomain.example
15950 .endd
15951 .vindex "&$domain$&"
15952 .vindex "&$local_part$&"
15953 The address list is expanded before use. The expansion variables &$local_part$&
15954 and &$domain$& are set from the original recipient of the error message, and if
15955 there was any wildcard matching in the pattern, the expansion
15956 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%errors_copy%&"
15957 variables &$0$&, &$1$&, etc. are set in the normal way.
15958
15959
15960 .option errors_reply_to main string unset
15961 .cindex "bounce message" "&'Reply-to:'& in"
15962 By default, Exim's bounce and delivery warning messages contain the header line
15963 .display
15964 &`From: Mail Delivery System <Mailer-Daemon@`&&'qualify-domain'&&`>`&
15965 .endd
15966 .oindex &%quota_warn_message%&
15967 where &'qualify-domain'& is the value of the &%qualify_domain%& option.
15968 A warning message that is generated by the &%quota_warn_message%& option in an
15969 &(appendfile)& transport may contain its own &'From:'& header line that
15970 overrides the default.
15971
15972 Experience shows that people reply to bounce messages. If the
15973 &%errors_reply_to%& option is set, a &'Reply-To:'& header is added to bounce
15974 and warning messages. For example:
15975 .code
15976 errors_reply_to = postmaster@my.domain.example
15977 .endd
15978 The value of the option is not expanded. It must specify a valid RFC 2822
15979 address. However, if a warning message that is generated by the
15980 &%quota_warn_message%& option in an &(appendfile)& transport contain its
15981 own &'Reply-To:'& header line, the value of the &%errors_reply_to%& option is
15982 not used.
15983
15984
15985 .option event_action main string&!! unset
15986 .cindex events
15987 This option declares a string to be expanded for Exim's events mechanism.
15988 For details see chapter &<<CHAPevents>>&.
15989
15990
15991 .option exim_group main string "compile-time configured"
15992 .cindex "gid (group id)" "Exim's own"
15993 .cindex "Exim group"
15994 This option changes the gid under which Exim runs when it gives up root
15995 privilege. The default value is compiled into the binary. The value of this
15996 option is used only when &%exim_user%& is also set. Unless it consists entirely
15997 of digits, the string is looked up using &[getgrnam()]&, and failure causes a
15998 configuration error. See chapter &<<CHAPsecurity>>& for a discussion of
15999 security issues.
16000
16001
16002 .option exim_path main string "see below"
16003 .cindex "Exim binary, path name"
16004 This option specifies the path name of the Exim binary, which is used when Exim
16005 needs to re-exec itself. The default is set up to point to the file &'exim'& in
16006 the directory configured at compile time by the BIN_DIRECTORY setting. It
16007 is necessary to change &%exim_path%& if, exceptionally, Exim is run from some
16008 other place.
16009 &*Warning*&: Do not use a macro to define the value of this option, because
16010 you will break those Exim utilities that scan the configuration file to find
16011 where the binary is. (They then use the &%-bP%& option to extract option
16012 settings such as the value of &%spool_directory%&.)
16013
16014
16015 .option exim_user main string "compile-time configured"
16016 .cindex "uid (user id)" "Exim's own"
16017 .cindex "Exim user"
16018 This option changes the uid under which Exim runs when it gives up root
16019 privilege. The default value is compiled into the binary. Ownership of the run
16020 time configuration file and the use of the &%-C%& and &%-D%& command line
16021 options is checked against the values in the binary, not what is set here.
16022
16023 Unless it consists entirely of digits, the string is looked up using
16024 &[getpwnam()]&, and failure causes a configuration error. If &%exim_group%& is
16025 not also supplied, the gid is taken from the result of &[getpwnam()]& if it is
16026 used. See chapter &<<CHAPsecurity>>& for a discussion of security issues.
16027
16028
16029 .option exim_version main string "current version"
16030 .cindex "Exim version"
16031 .cindex customizing "version number"
16032 .cindex "version number of Exim" override
16033 This option overrides the &$version_number$&/&$exim_version$& that Exim reports in
16034 various places.  Use with care; this may fool stupid security scanners.
16035
16036
16037 .option extra_local_interfaces main "string list" unset
16038 This option defines network interfaces that are to be considered local when
16039 routing, but which are not used for listening by the daemon. See section
16040 &<<SECTreclocipadd>>& for details.
16041
16042
16043 . Allow this long option name to split; give it unsplit as a fifth argument
16044 . for the automatic .oindex that is generated by .option.
16045
16046 .option "extract_addresses_remove_arguments" main boolean true &&&
16047          extract_addresses_remove_arguments
16048 .oindex "&%-t%&"
16049 .cindex "command line" "addresses with &%-t%&"
16050 .cindex "Sendmail compatibility" "&%-t%& option"
16051 According to some Sendmail documentation (Sun, IRIX, HP-UX), if any addresses
16052 are present on the command line when the &%-t%& option is used to build an
16053 envelope from a message's &'To:'&, &'Cc:'& and &'Bcc:'& headers, the command
16054 line addresses are removed from the recipients list. This is also how Smail
16055 behaves. However, other Sendmail documentation (the O'Reilly book) states that
16056 command line addresses are added to those obtained from the header lines. When
16057 &%extract_addresses_remove_arguments%& is true (the default), Exim subtracts
16058 argument headers. If it is set false, Exim adds rather than removes argument
16059 addresses.
16060
16061
16062 .option finduser_retries main integer 0
16063 .cindex "NIS, retrying user lookups"
16064 On systems running NIS or other schemes in which user and group information is
16065 distributed from a remote system, there can be times when &[getpwnam()]& and
16066 related functions fail, even when given valid data, because things time out.
16067 Unfortunately these failures cannot be distinguished from genuine &"not found"&
16068 errors. If &%finduser_retries%& is set greater than zero, Exim will try that
16069 many extra times to find a user or a group, waiting for one second between
16070 retries.
16071
16072 .cindex "&_/etc/passwd_&" "multiple reading of"
16073 You should not set this option greater than zero if your user information is in
16074 a traditional &_/etc/passwd_& file, because it will cause Exim needlessly to
16075 search the file multiple times for non-existent users, and also cause delay.
16076
16077
16078
16079 .option freeze_tell main "string list, comma separated" unset
16080 .cindex "freezing messages" "sending a message when freezing"
16081 On encountering certain errors, or when configured to do so in a system filter,
16082 ACL, or special router, Exim freezes a message. This means that no further
16083 delivery attempts take place until an administrator thaws the message, or the
16084 &%auto_thaw%&, &%ignore_bounce_errors_after%&, or &%timeout_frozen_after%&
16085 feature cause it to be processed. If &%freeze_tell%& is set, Exim generates a
16086 warning message whenever it freezes something, unless the message it is
16087 freezing is a locally-generated bounce message. (Without this exception there
16088 is the possibility of looping.) The warning message is sent to the addresses
16089 supplied as the comma-separated value of this option. If several of the
16090 message's addresses cause freezing, only a single message is sent. If the
16091 freezing was automatic, the reason(s) for freezing can be found in the message
16092 log. If you configure freezing in a filter or ACL, you must arrange for any
16093 logging that you require.
16094
16095
16096 .option gecos_name main string&!! unset
16097 .cindex "HP-UX"
16098 .cindex "&""gecos""& field, parsing"
16099 Some operating systems, notably HP-UX, use the &"gecos"& field in the system
16100 password file to hold other information in addition to users' real names. Exim
16101 looks up this field for use when it is creating &'Sender:'& or &'From:'&
16102 headers. If either &%gecos_pattern%& or &%gecos_name%& are unset, the contents
16103 of the field are used unchanged, except that, if an ampersand is encountered,
16104 it is replaced by the user's login name with the first character forced to
16105 upper case, since this is a convention that is observed on many systems.
16106
16107 When these options are set, &%gecos_pattern%& is treated as a regular
16108 expression that is to be applied to the field (again with && replaced by the
16109 login name), and if it matches, &%gecos_name%& is expanded and used as the
16110 user's name.
16111
16112 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%gecos_name%&"
16113 Numeric variables such as &$1$&, &$2$&, etc. can be used in the expansion to
16114 pick up sub-fields that were matched by the pattern. In HP-UX, where the user's
16115 name terminates at the first comma, the following can be used:
16116 .code
16117 gecos_pattern = ([^,]*)
16118 gecos_name = $1
16119 .endd
16120
16121 .option gecos_pattern main string unset
16122 See &%gecos_name%& above.
16123
16124
16125 .option gnutls_compat_mode main boolean unset
16126 This option controls whether GnuTLS is used in compatibility mode in an Exim
16127 server. This reduces security slightly, but improves interworking with older
16128 implementations of TLS.
16129
16130
16131 .option gnutls_allow_auto_pkcs11 main boolean unset
16132 This option will let GnuTLS (2.12.0 or later) autoload PKCS11 modules with
16133 the p11-kit configuration files in &_/etc/pkcs11/modules/_&.
16134
16135 See
16136 &url(https://www.gnutls.org/manual/gnutls.html#Smart-cards-and-HSMs)
16137 for documentation.
16138
16139
16140
16141 .option headers_charset main string "see below"
16142 This option sets a default character set for translating from encoded MIME
16143 &"words"& in header lines, when referenced by an &$h_xxx$& expansion item. The
16144 default is the value of HEADERS_CHARSET in &_Local/Makefile_&. The
16145 ultimate default is ISO-8859-1. For more details see the description of header
16146 insertions in section &<<SECTexpansionitems>>&.
16147
16148
16149
16150 .option header_maxsize main integer "see below"
16151 .cindex "header section" "maximum size of"
16152 .cindex "limit" "size of message header section"
16153 This option controls the overall maximum size of a message's header
16154 section. The default is the value of HEADER_MAXSIZE in
16155 &_Local/Makefile_&; the default for that is 1M. Messages with larger header
16156 sections are rejected.
16157
16158
16159 .option header_line_maxsize main integer 0
16160 .cindex "header lines" "maximum size of"
16161 .cindex "limit" "size of one header line"
16162 This option limits the length of any individual header line in a message, after
16163 all the continuations have been joined together. Messages with individual
16164 header lines that are longer than the limit are rejected. The default value of
16165 zero means &"no limit"&.
16166
16167
16168
16169
16170 .option helo_accept_junk_hosts main "host list&!!" unset
16171 .cindex "HELO" "accepting junk data"
16172 .cindex "EHLO" "accepting junk data"
16173 Exim checks the syntax of HELO and EHLO commands for incoming SMTP
16174 mail, and gives an error response for invalid data. Unfortunately, there are
16175 some SMTP clients that send syntactic junk. They can be accommodated by setting
16176 this option. Note that this is a syntax check only. See &%helo_verify_hosts%&
16177 if you want to do semantic checking.
16178 See also &%helo_allow_chars%& for a way of extending the permitted character
16179 set.
16180
16181
16182 .option helo_allow_chars main string unset
16183 .cindex "HELO" "underscores in"
16184 .cindex "EHLO" "underscores in"
16185 .cindex "underscore in EHLO/HELO"
16186 This option can be set to a string of rogue characters that are permitted in
16187 all EHLO and HELO names in addition to the standard letters, digits,
16188 hyphens, and dots. If you really must allow underscores, you can set
16189 .code
16190 helo_allow_chars = _
16191 .endd
16192 Note that the value is one string, not a list.
16193
16194
16195 .option helo_lookup_domains main "domain list&!!" &`@:@[]`&
16196 .cindex "HELO" "forcing reverse lookup"
16197 .cindex "EHLO" "forcing reverse lookup"
16198 If the domain given by a client in a HELO or EHLO command matches this
16199 list, a reverse lookup is done in order to establish the host's true name. The
16200 default forces a lookup if the client host gives the server's name or any of
16201 its IP addresses (in brackets), something that broken clients have been seen to
16202 do.
16203
16204
16205 .option helo_try_verify_hosts main "host list&!!" unset
16206 .cindex "HELO verifying" "optional"
16207 .cindex "EHLO" "verifying, optional"
16208 By default, Exim just checks the syntax of HELO and EHLO commands (see
16209 &%helo_accept_junk_hosts%& and &%helo_allow_chars%&). However, some sites like
16210 to do more extensive checking of the data supplied by these commands. The ACL
16211 condition &`verify = helo`& is provided to make this possible.
16212 Formerly, it was necessary also to set this option (&%helo_try_verify_hosts%&)
16213 to force the check to occur. From release 4.53 onwards, this is no longer
16214 necessary. If the check has not been done before &`verify = helo`& is
16215 encountered, it is done at that time. Consequently, this option is obsolete.
16216 Its specification is retained here for backwards compatibility.
16217
16218 When an EHLO or HELO command is received, if the calling host matches
16219 &%helo_try_verify_hosts%&, Exim checks that the host name given in the HELO or
16220 EHLO command either:
16221
16222 .ilist
16223 is an IP literal matching the calling address of the host, or
16224 .next
16225 .cindex "DNS" "reverse lookup"
16226 .cindex "reverse DNS lookup"
16227 matches the host name that Exim obtains by doing a reverse lookup of the
16228 calling host address, or
16229 .next
16230 when looked up in DNS yields the calling host address.
16231 .endlist
16232
16233 However, the EHLO or HELO command is not rejected if any of the checks
16234 fail. Processing continues, but the result of the check is remembered, and can
16235 be detected later in an ACL by the &`verify = helo`& condition.
16236
16237 If DNS was used for successful verification, the variable
16238 .cindex "DNS" "DNSSEC"
16239 &$helo_verify_dnssec$& records the DNSSEC status of the lookups.
16240
16241 .option helo_verify_hosts main "host list&!!" unset
16242 .cindex "HELO verifying" "mandatory"
16243 .cindex "EHLO" "verifying, mandatory"
16244 Like &%helo_try_verify_hosts%&, this option is obsolete, and retained only for
16245 backwards compatibility. For hosts that match this option, Exim checks the host
16246 name given in the HELO or EHLO in the same way as for
16247 &%helo_try_verify_hosts%&. If the check fails, the HELO or EHLO command is
16248 rejected with a 550 error, and entries are written to the main and reject logs.
16249 If a MAIL command is received before EHLO or HELO, it is rejected with a 503
16250 error.
16251
16252 .option hold_domains main "domain list&!!" unset
16253 .cindex "domain" "delaying delivery"
16254 .cindex "delivery" "delaying certain domains"
16255 This option allows mail for particular domains to be held in the queue
16256 manually. The option is overridden if a message delivery is forced with the
16257 &%-M%&, &%-qf%&, &%-Rf%& or &%-Sf%& options, and also while testing or
16258 verifying addresses using &%-bt%& or &%-bv%&. Otherwise, if a domain matches an
16259 item in &%hold_domains%&, no routing or delivery for that address is done, and
16260 it is deferred every time the message is looked at.
16261
16262 This option is intended as a temporary operational measure for delaying the
16263 delivery of mail while some problem is being sorted out, or some new
16264 configuration tested. If you just want to delay the processing of some
16265 domains until a queue run occurs, you should use &%queue_domains%& or
16266 &%queue_smtp_domains%&, not &%hold_domains%&.
16267
16268 A setting of &%hold_domains%& does not override Exim's code for removing
16269 messages from the queue if they have been there longer than the longest retry
16270 time in any retry rule. If you want to hold messages for longer than the normal
16271 retry times, insert a dummy retry rule with a long retry time.
16272
16273
16274 .option host_lookup main "host list&!!" unset
16275 .cindex "host name" "lookup, forcing"
16276 Exim does not look up the name of a calling host from its IP address unless it
16277 is required to compare against some host list, or the host matches
16278 &%helo_try_verify_hosts%& or &%helo_verify_hosts%&, or the host matches this
16279 option (which normally contains IP addresses rather than host names). The
16280 default configuration file contains
16281 .code
16282 host_lookup = *
16283 .endd
16284 which causes a lookup to happen for all hosts. If the expense of these lookups
16285 is felt to be too great, the setting can be changed or removed.
16286
16287 After a successful reverse lookup, Exim does a forward lookup on the name it
16288 has obtained, to verify that it yields the IP address that it started with. If
16289 this check fails, Exim behaves as if the name lookup failed.
16290
16291 .vindex "&$host_lookup_failed$&"
16292 .vindex "&$sender_host_name$&"
16293 After any kind of failure, the host name (in &$sender_host_name$&) remains
16294 unset, and &$host_lookup_failed$& is set to the string &"1"&. See also
16295 &%dns_again_means_nonexist%&, &%helo_lookup_domains%&, and
16296 &`verify = reverse_host_lookup`& in ACLs.
16297
16298
16299 .option host_lookup_order main "string list" &`bydns:byaddr`&
16300 This option specifies the order of different lookup methods when Exim is trying
16301 to find a host name from an IP address. The default is to do a DNS lookup
16302 first, and then to try a local lookup (using &[gethostbyaddr()]& or equivalent)
16303 if that fails. You can change the order of these lookups, or omit one entirely,
16304 if you want.
16305
16306 &*Warning*&: The &"byaddr"& method does not always yield aliases when there are
16307 multiple PTR records in the DNS and the IP address is not listed in
16308 &_/etc/hosts_&. Different operating systems give different results in this
16309 case. That is why the default tries a DNS lookup first.
16310
16311
16312
16313 .option host_reject_connection main "host list&!!" unset
16314 .cindex "host" "rejecting connections from"
16315 If this option is set, incoming SMTP calls from the hosts listed are rejected
16316 as soon as the connection is made.
16317 This option is obsolete, and retained only for backward compatibility, because
16318 nowadays the ACL specified by &%acl_smtp_connect%& can also reject incoming
16319 connections immediately.
16320
16321 The ability to give an immediate rejection (either by this option or using an
16322 ACL) is provided for use in unusual cases. Many hosts will just try again,
16323 sometimes without much delay. Normally, it is better to use an ACL to reject
16324 incoming messages at a later stage, such as after RCPT commands. See
16325 chapter &<<CHAPACL>>&.
16326
16327
16328 .option hosts_connection_nolog main "host list&!!" unset
16329 .cindex "host" "not logging connections from"
16330 This option defines a list of hosts for which connection logging does not
16331 happen, even though the &%smtp_connection%& log selector is set. For example,
16332 you might want not to log SMTP connections from local processes, or from
16333 127.0.0.1, or from your local LAN. This option is consulted in the main loop of
16334 the daemon; you should therefore strive to restrict its value to a short inline
16335 list of IP addresses and networks. To disable logging SMTP connections from
16336 local processes, you must create a host list with an empty item. For example:
16337 .code
16338 hosts_connection_nolog = :
16339 .endd
16340 If the &%smtp_connection%& log selector is not set, this option has no effect.
16341
16342
16343 .new
16344 .option hosts_require_alpn main "host list&!!" unset
16345 .cindex ALPN "require negotiation in server"
16346 .cindex TLS ALPN
16347 .cindex TLS "Application Layer Protocol Names"
16348 If the TLS library supports ALPN
16349 then a successful negotiation of ALPN will be required for any client
16350 matching the list, for TLS to be used.
16351 See also the &%tls_alpn%& option.
16352
16353 &*Note*&: prevention of fallback to in-clear connection is not
16354 managed by this option, and should be done separately.
16355 .wen
16356
16357
16358 .option hosts_proxy main "host list&!!" unset
16359 .cindex proxy "proxy protocol"
16360 This option enables use of Proxy Protocol proxies for incoming
16361 connections.  For details see section &<<SECTproxyInbound>>&.
16362
16363
16364 .option hosts_treat_as_local main "domain list&!!" unset
16365 .cindex "local host" "domains treated as"
16366 .cindex "host" "treated as local"
16367 If this option is set, any host names that match the domain list are treated as
16368 if they were the local host when Exim is scanning host lists obtained from MX
16369 records
16370 or other sources. Note that the value of this option is a domain list, not a
16371 host list, because it is always used to check host names, not IP addresses.
16372
16373 This option also applies when Exim is matching the special items
16374 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`& in a domain list (see
16375 section &<<SECTdomainlist>>&), and when checking the &%hosts%& option in the
16376 &(smtp)& transport for the local host (see the &%allow_localhost%& option in
16377 that transport). See also &%local_interfaces%&, &%extra_local_interfaces%&, and
16378 chapter &<<CHAPinterfaces>>&, which contains a discussion about local network
16379 interfaces and recognizing the local host.
16380
16381
16382 .option ibase_servers main "string list" unset
16383 .cindex "InterBase" "server list"
16384 This option provides a list of InterBase servers and associated connection data,
16385 to be used in conjunction with &(ibase)& lookups (see section &<<SECID72>>&).
16386 The option is available only if Exim has been built with InterBase support.
16387
16388
16389
16390 .option ignore_bounce_errors_after main time 10w
16391 .cindex "bounce message" "discarding"
16392 .cindex "discarding bounce message"
16393 This option affects the processing of bounce messages that cannot be delivered,
16394 that is, those that suffer a permanent delivery failure. (Bounce messages that
16395 suffer temporary delivery failures are of course retried in the usual way.)
16396
16397 After a permanent delivery failure, bounce messages are frozen,
16398 because there is no sender to whom they can be returned. When a frozen bounce
16399 message has been in the queue for more than the given time, it is unfrozen at
16400 the next queue run, and a further delivery is attempted. If delivery fails
16401 again, the bounce message is discarded. This makes it possible to keep failed
16402 bounce messages around for a shorter time than the normal maximum retry time
16403 for frozen messages. For example,
16404 .code
16405 ignore_bounce_errors_after = 12h
16406 .endd
16407 retries failed bounce message deliveries after 12 hours, discarding any further
16408 failures. If the value of this option is set to a zero time period, bounce
16409 failures are discarded immediately. Setting a very long time (as in the default
16410 value) has the effect of disabling this option. For ways of automatically
16411 dealing with other kinds of frozen message, see &%auto_thaw%& and
16412 &%timeout_frozen_after%&.
16413
16414
16415 .option ignore_fromline_hosts main "host list&!!" unset
16416 .cindex "&""From""& line"
16417 .cindex "UUCP" "&""From""& line"
16418 Some broken SMTP clients insist on sending a UUCP-like &"From&~"& line before
16419 the headers of a message. By default this is treated as the start of the
16420 message's body, which means that any following headers are not recognized as
16421 such. Exim can be made to ignore it by setting &%ignore_fromline_hosts%& to
16422 match those hosts that insist on sending it. If the sender is actually a local
16423 process rather than a remote host, and is using &%-bs%& to inject the messages,
16424 &%ignore_fromline_local%& must be set to achieve this effect.
16425
16426
16427 .option ignore_fromline_local main boolean false
16428 See &%ignore_fromline_hosts%& above.
16429
16430 .option keep_environment main "string list" unset
16431 .cindex "environment" "values from"
16432 This option contains a string list of environment variables to keep.
16433 You have to trust these variables or you have to be sure that
16434 these variables do not impose any security risk. Keep in mind that
16435 during the startup phase Exim is running with an effective UID 0 in most
16436 installations. As the default value is an empty list, the default
16437 environment for using libraries, running embedded Perl code, or running
16438 external binaries is empty, and does not not even contain PATH or HOME.
16439
16440 Actually the list is interpreted as a list of patterns
16441 (&<<SECTlistexpand>>&), except that it is not expanded first.
16442
16443 WARNING: Macro substitution is still done first, so having a macro
16444 FOO and having FOO_HOME in your &%keep_environment%& option may have
16445 unexpected results. You may work around this using a regular expression
16446 that does not match the macro name: ^[F]OO_HOME$.
16447
16448 Current versions of Exim issue a warning during startup if you do not mention
16449 &%keep_environment%& in your runtime configuration file and if your
16450 current environment is not empty. Future versions may not issue that warning
16451 anymore.
16452
16453 See the &%add_environment%& main config option for a way to set
16454 environment variables to a fixed value.  The environment for &(pipe)&
16455 transports is handled separately, see section &<<SECTpipeenv>>& for
16456 details.
16457
16458
16459 .option keep_malformed main time 4d
16460 This option specifies the length of time to keep messages whose spool files
16461 have been corrupted in some way. This should, of course, never happen. At the
16462 next attempt to deliver such a message, it gets removed. The incident is
16463 logged.
16464
16465
16466 .option ldap_ca_cert_dir main string unset
16467 .cindex "LDAP", "TLS CA certificate directory"
16468 .cindex certificate "directory for LDAP"
16469 This option indicates which directory contains CA certificates for verifying
16470 a TLS certificate presented by an LDAP server.
16471 While Exim does not provide a default value, your SSL library may.
16472 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
16473 and constrained to be a directory.
16474
16475
16476 .option ldap_ca_cert_file main string unset
16477 .cindex "LDAP", "TLS CA certificate file"
16478 .cindex certificate "file for LDAP"
16479 This option indicates which file contains CA certificates for verifying
16480 a TLS certificate presented by an LDAP server.
16481 While Exim does not provide a default value, your SSL library may.
16482 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
16483 and constrained to be a file.
16484
16485
16486 .option ldap_cert_file main string unset
16487 .cindex "LDAP" "TLS client certificate file"
16488 .cindex certificate "file for LDAP"
16489 This option indicates which file contains an TLS client certificate which
16490 Exim should present to the LDAP server during TLS negotiation.
16491 Should be used together with &%ldap_cert_key%&.
16492
16493
16494 .option ldap_cert_key main string unset
16495 .cindex "LDAP" "TLS client key file"
16496 .cindex certificate "key for LDAP"
16497 This option indicates which file contains the secret/private key to use
16498 to prove identity to the LDAP server during TLS negotiation.
16499 Should be used together with &%ldap_cert_file%&, which contains the
16500 identity to be proven.
16501
16502
16503 .option ldap_cipher_suite main string unset
16504 .cindex "LDAP" "TLS cipher suite"
16505 This controls the TLS cipher-suite negotiation during TLS negotiation with
16506 the LDAP server.  See &<<SECTreqciphssl>>& for more details of the format of
16507 cipher-suite options with OpenSSL (as used by LDAP client libraries).
16508
16509
16510 .option ldap_default_servers main "string list" unset
16511 .cindex "LDAP" "default servers"
16512 This option provides a list of LDAP servers which are tried in turn when an
16513 LDAP query does not contain a server. See section &<<SECTforldaque>>& for
16514 details of LDAP queries. This option is available only when Exim has been built
16515 with LDAP support.
16516
16517
16518 .option ldap_require_cert main string unset.
16519 .cindex "LDAP" "policy for LDAP server TLS cert presentation"
16520 This should be one of the values "hard", "demand", "allow", "try" or "never".
16521 A value other than one of these is interpreted as "never".
16522 See the entry "TLS_REQCERT" in your system man page for ldap.conf(5).
16523 Although Exim does not set a default, the LDAP library probably defaults
16524 to hard/demand.
16525
16526
16527 .option ldap_start_tls main boolean false
16528 .cindex "LDAP" "whether or not to negotiate TLS"
16529 If set, Exim will attempt to negotiate TLS with the LDAP server when
16530 connecting on a regular LDAP port.  This is the LDAP equivalent of SMTP's
16531 "STARTTLS".  This is distinct from using "ldaps", which is the LDAP form
16532 of SSL-on-connect.
16533 In the event of failure to negotiate TLS, the action taken is controlled
16534 by &%ldap_require_cert%&.
16535 This option is ignored for &`ldapi`& connections.
16536
16537
16538 .option ldap_version main integer unset
16539 .cindex "LDAP" "protocol version, forcing"
16540 This option can be used to force Exim to set a specific protocol version for
16541 LDAP. If it option is unset, it is shown by the &%-bP%& command line option as
16542 -1. When this is the case, the default is 3 if LDAP_VERSION3 is defined in
16543 the LDAP headers; otherwise it is 2. This option is available only when Exim
16544 has been built with LDAP support.
16545
16546
16547
16548 .option local_from_check main boolean true
16549 .cindex "&'Sender:'& header line" "disabling addition of"
16550 .cindex "&'From:'& header line" "disabling checking of"
16551 When a message is submitted locally (that is, not over a TCP/IP connection) by
16552 an untrusted user, Exim removes any existing &'Sender:'& header line, and
16553 checks that the &'From:'& header line matches the login of the calling user and
16554 the domain specified by &%qualify_domain%&.
16555
16556 &*Note*&: An unqualified address (no domain) in the &'From:'& header in a
16557 locally submitted message is automatically qualified by Exim, unless the
16558 &%-bnq%& command line option is used.
16559
16560 You can use &%local_from_prefix%& and &%local_from_suffix%& to permit affixes
16561 on the local part. If the &'From:'& header line does not match, Exim adds a
16562 &'Sender:'& header with an address constructed from the calling user's login
16563 and the default qualify domain.
16564
16565 If &%local_from_check%& is set false, the &'From:'& header check is disabled,
16566 and no &'Sender:'& header is ever added. If, in addition, you want to retain
16567 &'Sender:'& header lines supplied by untrusted users, you must also set
16568 &%local_sender_retain%& to be true.
16569
16570 .cindex "envelope from"
16571 .cindex "envelope sender"
16572 These options affect only the header lines in the message. The envelope sender
16573 is still forced to be the login id at the qualify domain unless
16574 &%untrusted_set_sender%& permits the user to supply an envelope sender.
16575
16576 For messages received over TCP/IP, an ACL can specify &"submission mode"& to
16577 request similar header line checking. See section &<<SECTthesenhea>>&, which
16578 has more details about &'Sender:'& processing.
16579
16580
16581
16582
16583 .option local_from_prefix main string unset
16584 When Exim checks the &'From:'& header line of locally submitted messages for
16585 matching the login id (see &%local_from_check%& above), it can be configured to
16586 ignore certain prefixes and suffixes in the local part of the address. This is
16587 done by setting &%local_from_prefix%& and/or &%local_from_suffix%& to
16588 appropriate lists, in the same form as the &%local_part_prefix%& and
16589 &%local_part_suffix%& router options (see chapter &<<CHAProutergeneric>>&). For
16590 example, if
16591 .code
16592 local_from_prefix = *-
16593 .endd
16594 is set, a &'From:'& line containing
16595 .code
16596 From: anything-user@your.domain.example
16597 .endd
16598 will not cause a &'Sender:'& header to be added if &'user@your.domain.example'&
16599 matches the actual sender address that is constructed from the login name and
16600 qualify domain.
16601
16602
16603 .option local_from_suffix main string unset
16604 See &%local_from_prefix%& above.
16605
16606
16607 .option local_interfaces main "string list" "see below"
16608 This option controls which network interfaces are used by the daemon for
16609 listening; they are also used to identify the local host when routing. Chapter
16610 &<<CHAPinterfaces>>& contains a full description of this option and the related
16611 options &%daemon_smtp_ports%&, &%extra_local_interfaces%&,
16612 &%hosts_treat_as_local%&, and &%tls_on_connect_ports%&. The default value for
16613 &%local_interfaces%& is
16614 .code
16615 local_interfaces = 0.0.0.0
16616 .endd
16617 when Exim is built without IPv6 support; otherwise it is
16618 .code
16619 local_interfaces = <; ::0 ; 0.0.0.0
16620 .endd
16621
16622 .option local_scan_timeout main time 5m
16623 .cindex "timeout" "for &[local_scan()]& function"
16624 .cindex "&[local_scan()]& function" "timeout"
16625 This timeout applies to the &[local_scan()]& function (see chapter
16626 &<<CHAPlocalscan>>&). Zero means &"no timeout"&. If the timeout is exceeded,
16627 the incoming message is rejected with a temporary error if it is an SMTP
16628 message. For a non-SMTP message, the message is dropped and Exim ends with a
16629 non-zero code. The incident is logged on the main and reject logs.
16630
16631
16632
16633 .option local_sender_retain main boolean false
16634 .cindex "&'Sender:'& header line" "retaining from local submission"
16635 When a message is submitted locally (that is, not over a TCP/IP connection) by
16636 an untrusted user, Exim removes any existing &'Sender:'& header line. If you
16637 do not want this to happen, you must set &%local_sender_retain%&, and you must
16638 also set &%local_from_check%& to be false (Exim will complain if you do not).
16639 See also the ACL modifier &`control = suppress_local_fixups`&. Section
16640 &<<SECTthesenhea>>& has more details about &'Sender:'& processing.
16641
16642
16643
16644
16645 .option localhost_number main string&!! unset
16646 .cindex "host" "locally unique number for"
16647 .cindex "message ids" "with multiple hosts"
16648 .vindex "&$localhost_number$&"
16649 Exim's message ids are normally unique only within the local host. If
16650 uniqueness among a set of hosts is required, each host must set a different
16651 value for the &%localhost_number%& option. The string is expanded immediately
16652 after reading the configuration file (so that a number can be computed from the
16653 host name, for example) and the result of the expansion must be a number in the
16654 range 0&--16 (or 0&--10 on operating systems with case-insensitive file
16655 systems). This is available in subsequent string expansions via the variable
16656 &$localhost_number$&. When &%localhost_number is set%&, the final two
16657 characters of the message id, instead of just being a fractional part of the
16658 time, are computed from the time and the local host number as described in
16659 section &<<SECTmessiden>>&.
16660
16661
16662
16663 .option log_file_path main "string list&!!" "set at compile time"
16664 .cindex "log" "file path for"
16665 This option sets the path which is used to determine the names of Exim's log
16666 files, or indicates that logging is to be to syslog, or both. It is expanded
16667 when Exim is entered, so it can, for example, contain a reference to the host
16668 name. If no specific path is set for the log files at compile or runtime,
16669 or if the option is unset at runtime (i.e.  &`log_file_path = `&)
16670 they are written in a sub-directory called &_log_& in Exim's spool directory.
16671 A path must start with a slash.
16672 To send to syslog, use the word &"syslog"&.
16673 Chapter &<<CHAPlog>>& contains further details about Exim's logging, and
16674 section &<<SECTwhelogwri>>& describes how the contents of &%log_file_path%& are
16675 used. If this string is fixed at your installation (contains no expansion
16676 variables) it is recommended that you do not set this option in the
16677 configuration file, but instead supply the path using LOG_FILE_PATH in
16678 &_Local/Makefile_& so that it is available to Exim for logging errors detected
16679 early on &-- in particular, failure to read the configuration file.
16680
16681
16682 .option log_selector main string unset
16683 .cindex "log" "selectors"
16684 This option can be used to reduce or increase the number of things that Exim
16685 writes to its log files. Its argument is made up of names preceded by plus or
16686 minus characters. For example:
16687 .code
16688 log_selector = +arguments -retry_defer
16689 .endd
16690 A list of possible names and what they control is given in the chapter on
16691 logging, in section &<<SECTlogselector>>&.
16692
16693
16694 .option log_timezone main boolean false
16695 .cindex "log" "timezone for entries"
16696 .vindex "&$tod_log$&"
16697 .vindex "&$tod_zone$&"
16698 By default, the timestamps on log lines are in local time without the
16699 timezone. This means that if your timezone changes twice a year, the timestamps
16700 in log lines are ambiguous for an hour when the clocks go back. One way of
16701 avoiding this problem is to set the timezone to UTC. An alternative is to set
16702 &%log_timezone%& true. This turns on the addition of the timezone offset to
16703 timestamps in log lines. Turning on this option can add quite a lot to the size
16704 of log files because each line is extended by 6 characters. Note that the
16705 &$tod_log$& variable contains the log timestamp without the zone, but there is
16706 another variable called &$tod_zone$& that contains just the timezone offset.
16707
16708
16709 .option lookup_open_max main integer 25
16710 .cindex "too many open files"
16711 .cindex "open files, too many"
16712 .cindex "file" "too many open"
16713 .cindex "lookup" "maximum open files"
16714 .cindex "limit" "open files for lookups"
16715 This option limits the number of simultaneously open files for single-key
16716 lookups that use regular files (that is, &(lsearch)&, &(dbm)&, and &(cdb)&).
16717 Exim normally keeps these files open during routing, because often the same
16718 file is required several times. If the limit is reached, Exim closes the least
16719 recently used file. Note that if you are using the &'ndbm'& library, it
16720 actually opens two files for each logical DBM database, though it still counts
16721 as one for the purposes of &%lookup_open_max%&. If you are getting &"too many
16722 open files"& errors with NDBM, you need to reduce the value of
16723 &%lookup_open_max%&.
16724
16725
16726 .option max_username_length main integer 0
16727 .cindex "length of login name"
16728 .cindex "user name" "maximum length"
16729 .cindex "limit" "user name length"
16730 Some operating systems are broken in that they truncate long arguments to
16731 &[getpwnam()]& to eight characters, instead of returning &"no such user"&. If
16732 this option is set greater than zero, any attempt to call &[getpwnam()]& with
16733 an argument that is longer behaves as if &[getpwnam()]& failed.
16734
16735
16736 .option message_body_newlines main bool false
16737 .cindex "message body" "newlines in variables"
16738 .cindex "newline" "in message body variables"
16739 .vindex "&$message_body$&"
16740 .vindex "&$message_body_end$&"
16741 By default, newlines in the message body are replaced by spaces when setting
16742 the &$message_body$& and &$message_body_end$& expansion variables. If this
16743 option is set true, this no longer happens.
16744
16745
16746 .option message_body_visible main integer 500
16747 .cindex "body of message" "visible size"
16748 .cindex "message body" "visible size"
16749 .vindex "&$message_body$&"
16750 .vindex "&$message_body_end$&"
16751 This option specifies how much of a message's body is to be included in the
16752 &$message_body$& and &$message_body_end$& expansion variables.
16753
16754
16755 .option message_id_header_domain main string&!! unset
16756 .cindex "&'Message-ID:'& header line"
16757 If this option is set, the string is expanded and used as the right hand side
16758 (domain) of the &'Message-ID:'& header that Exim creates if a
16759 locally-originated incoming message does not have one. &"Locally-originated"&
16760 means &"not received over TCP/IP."&
16761 Otherwise, the primary host name is used.
16762 Only letters, digits, dot and hyphen are accepted; any other characters are
16763 replaced by hyphens. If the expansion is forced to fail, or if the result is an
16764 empty string, the option is ignored.
16765
16766
16767 .option message_id_header_text main string&!! unset
16768 If this variable is set, the string is expanded and used to augment the text of
16769 the &'Message-id:'& header that Exim creates if a locally-originated incoming
16770 message does not have one. The text of this header is required by RFC 2822 to
16771 take the form of an address. By default, Exim uses its internal message id as
16772 the local part, and the primary host name as the domain. If this option is set,
16773 it is expanded, and provided the expansion is not forced to fail, and does not
16774 yield an empty string, the result is inserted into the header immediately
16775 before the @, separated from the internal message id by a dot. Any characters
16776 that are illegal in an address are automatically converted into hyphens. This
16777 means that variables such as &$tod_log$& can be used, because the spaces and
16778 colons will become hyphens.
16779
16780
16781 .option message_logs main boolean true
16782 .cindex "message logs" "disabling"
16783 .cindex "log" "message log; disabling"
16784 If this option is turned off, per-message log files are not created in the
16785 &_msglog_& spool sub-directory. This reduces the amount of disk I/O required by
16786 Exim, by reducing the number of files involved in handling a message from a
16787 minimum of four (header spool file, body spool file, delivery journal, and
16788 per-message log) to three. The other major I/O activity is Exim's main log,
16789 which is not affected by this option.
16790
16791
16792 .option message_size_limit main string&!! 50M
16793 .cindex "message" "size limit"
16794 .cindex "limit" "message size"
16795 .cindex "size" "of message, limit"
16796 This option limits the maximum size of message that Exim will process. The
16797 value is expanded for each incoming connection so, for example, it can be made
16798 to depend on the IP address of the remote host for messages arriving via
16799 TCP/IP. After expansion, the value must be a sequence of decimal digits,
16800 optionally followed by K or M.
16801
16802 .cindex "SIZE" "ESMTP extension, advertising"
16803 .cindex "ESMTP extensions" SIZE
16804 If nonzero the value will be advertised as a parameter to the ESMTP SIZE
16805 service extension keyword.
16806
16807 &*Note*&: This limit cannot be made to depend on a message's sender or any
16808 other properties of an individual message, because it has to be advertised in
16809 the server's response to EHLO. String expansion failure causes a temporary
16810 error. A value of zero means no limit, but its use is not recommended. See also
16811 &%bounce_return_size_limit%&.
16812
16813 Incoming SMTP messages are failed with a 552 error if the limit is
16814 exceeded; locally-generated messages either get a stderr message or a delivery
16815 failure message to the sender, depending on the &%-oe%& setting. Rejection of
16816 an oversized message is logged in both the main and the reject logs. See also
16817 the generic transport option &%message_size_limit%&, which limits the size of
16818 message that an individual transport can process.
16819
16820 If you use a virus-scanner and set this option to to a value larger than the
16821 maximum size that your virus-scanner is configured to support, you may get
16822 failures triggered by large mails.  The right size to configure for the
16823 virus-scanner depends upon what data is passed and the options in use but it's
16824 probably safest to just set it to a little larger than this value.  E.g., with a
16825 default Exim message size of 50M and a default ClamAV StreamMaxLength of 10M,
16826 some problems may result.
16827
16828 A value of 0 will disable size limit checking; Exim will still advertise the
16829 SIZE extension in an EHLO response, but without a limit, so as to permit
16830 SMTP clients to still indicate the message size along with the MAIL verb.
16831
16832
16833 .option move_frozen_messages main boolean false
16834 .cindex "frozen messages" "moving"
16835 This option, which is available only if Exim has been built with the setting
16836 .code
16837 SUPPORT_MOVE_FROZEN_MESSAGES=yes
16838 .endd
16839 in &_Local/Makefile_&, causes frozen messages and their message logs to be
16840 moved from the &_input_& and &_msglog_& directories on the spool to &_Finput_&
16841 and &_Fmsglog_&, respectively. There is currently no support in Exim or the
16842 standard utilities for handling such moved messages, and they do not show up in
16843 lists generated by &%-bp%& or by the Exim monitor.
16844
16845
16846 .option mua_wrapper main boolean false
16847 Setting this option true causes Exim to run in a very restrictive mode in which
16848 it passes messages synchronously to a smart host. Chapter &<<CHAPnonqueueing>>&
16849 contains a full description of this facility.
16850
16851
16852
16853 .option mysql_servers main "string list" unset
16854 .cindex "MySQL" "server list"
16855 This option provides a list of MySQL servers and associated connection data, to
16856 be used in conjunction with &(mysql)& lookups (see section &<<SECID72>>&). The
16857 option is available only if Exim has been built with MySQL support.
16858
16859
16860 .option never_users main "string list&!!" unset
16861 This option is expanded just once, at the start of Exim's processing. Local
16862 message deliveries are normally run in processes that are setuid to the
16863 recipient, and remote deliveries are normally run under Exim's own uid and gid.
16864 It is usually desirable to prevent any deliveries from running as root, as a
16865 safety precaution.
16866
16867 When Exim is built, an option called FIXED_NEVER_USERS can be set to a
16868 list of users that must not be used for local deliveries. This list is fixed in
16869 the binary and cannot be overridden by the configuration file. By default, it
16870 contains just the single user name &"root"&. The &%never_users%& runtime option
16871 can be used to add more users to the fixed list.
16872
16873 If a message is to be delivered as one of the users on the fixed list or the
16874 &%never_users%& list, an error occurs, and delivery is deferred. A common
16875 example is
16876 .code
16877 never_users = root:daemon:bin
16878 .endd
16879 Including root is redundant if it is also on the fixed list, but it does no
16880 harm. This option overrides the &%pipe_as_creator%& option of the &(pipe)&
16881 transport driver.
16882
16883
16884 .option notifier_socket main string "$spool_directory/exim_daemon_notify"
16885 This option gives the name for a unix-domain socket on which the daemon
16886 listens for work and information-requests.
16887 Only installations running multiple daemons sharing a spool directory
16888 should need to modify the default.
16889
16890 The option is expanded before use.
16891 If the platform supports Linux-style abstract socket names, the result
16892 is used with a nul byte prefixed.
16893 Otherwise,
16894 .new "if nonempty,"
16895 it should be a full path name and use a directory accessible
16896 to Exim.
16897
16898 .new
16899 If this option is set as empty,
16900 or the command line &%-oY%& option is used, or
16901 .wen
16902 the command line uses a &%-oX%& option and does not use &%-oP%&,
16903 then a notifier socket is not created.
16904
16905
16906 .option openssl_options main "string list" "+no_sslv2 +no_sslv3 +single_dh_use +no_ticket +no_renegotiation"
16907 .cindex "OpenSSL "compatibility options"
16908 This option allows an administrator to adjust the SSL options applied
16909 by OpenSSL to connections.  It is given as a space-separated list of items,
16910 each one to be +added or -subtracted from the current value.
16911
16912 This option is only available if Exim is built against OpenSSL.  The values
16913 available for this option vary according to the age of your OpenSSL install.
16914 The &"all"& value controls a subset of flags which are available, typically
16915 the bug workaround options.  The &'SSL_CTX_set_options'& man page will
16916 list the values known on your system and Exim should support all the
16917 &"bug workaround"& options and many of the &"modifying"& options.  The Exim
16918 names lose the leading &"SSL_OP_"& and are lower-cased.
16919
16920 Note that adjusting the options can have severe impact upon the security of
16921 SSL as used by Exim.  It is possible to disable safety checks and shoot
16922 yourself in the foot in various unpleasant ways.  This option should not be
16923 adjusted lightly.  An unrecognised item will be detected at startup, by
16924 invoking Exim with the &%-bV%& flag.
16925
16926 The option affects Exim operating both as a server and as a client.
16927
16928 Historical note: prior to release 4.80, Exim defaulted this value to
16929 "+dont_insert_empty_fragments", which may still be needed for compatibility
16930 with some clients, but which lowers security by increasing exposure to
16931 some now infamous attacks.
16932
16933 Examples:
16934 .code
16935 # Make both old MS and old Eudora happy:
16936 openssl_options = -all +microsoft_big_sslv3_buffer \
16937                        +dont_insert_empty_fragments
16938
16939 # Disable older protocol versions:
16940 openssl_options = +no_sslv2 +no_sslv3
16941 .endd
16942
16943 Possible options may include:
16944 .ilist
16945 &`all`&
16946 .next
16947 &`allow_unsafe_legacy_renegotiation`&
16948 .next
16949 &`cipher_server_preference`&
16950 .next
16951 &`dont_insert_empty_fragments`&
16952 .next
16953 &`ephemeral_rsa`&
16954 .next
16955 &`legacy_server_connect`&
16956 .next
16957 &`microsoft_big_sslv3_buffer`&
16958 .next
16959 &`microsoft_sess_id_bug`&
16960 .next
16961 &`msie_sslv2_rsa_padding`&
16962 .next
16963 &`netscape_challenge_bug`&
16964 .next
16965 &`netscape_reuse_cipher_change_bug`&
16966 .next
16967 &`no_compression`&
16968 .next
16969 &`no_session_resumption_on_renegotiation`&
16970 .next
16971 &`no_sslv2`&
16972 .next
16973 &`no_sslv3`&
16974 .next
16975 &`no_ticket`&
16976 .next
16977 &`no_tlsv1`&
16978 .next
16979 &`no_tlsv1_1`&
16980 .next
16981 &`no_tlsv1_2`&
16982 .next
16983 &`safari_ecdhe_ecdsa_bug`&
16984 .next
16985 &`single_dh_use`&
16986 .next
16987 &`single_ecdh_use`&
16988 .next
16989 &`ssleay_080_client_dh_bug`&
16990 .next
16991 &`sslref2_reuse_cert_type_bug`&
16992 .next
16993 &`tls_block_padding_bug`&
16994 .next
16995 &`tls_d5_bug`&
16996 .next
16997 &`tls_rollback_bug`&
16998 .endlist
16999
17000 As an aside, the &`safari_ecdhe_ecdsa_bug`& item is a misnomer and affects
17001 all clients connecting using the MacOS SecureTransport TLS facility prior
17002 to MacOS 10.8.4, including email clients.  If you see old MacOS clients failing
17003 to negotiate TLS then this option value might help, provided that your OpenSSL
17004 release is new enough to contain this work-around.  This may be a situation
17005 where you have to upgrade OpenSSL to get buggy clients working.
17006
17007
17008 .option oracle_servers main "string list" unset
17009 .cindex "Oracle" "server list"
17010 This option provides a list of Oracle servers and associated connection data,
17011 to be used in conjunction with &(oracle)& lookups (see section &<<SECID72>>&).
17012 The option is available only if Exim has been built with Oracle support.
17013
17014
17015 .option percent_hack_domains main "domain list&!!" unset
17016 .cindex "&""percent hack""&"
17017 .cindex "source routing" "in email address"
17018 .cindex "address" "source-routed"
17019 The &"percent hack"& is the convention whereby a local part containing a
17020 percent sign is re-interpreted as a new email address, with the percent
17021 replaced by @. This is sometimes called &"source routing"&, though that term is
17022 also applied to RFC 2822 addresses that begin with an @ character. If this
17023 option is set, Exim implements the percent facility for those domains listed,
17024 but no others. This happens before an incoming SMTP address is tested against
17025 an ACL.
17026
17027 &*Warning*&: The &"percent hack"& has often been abused by people who are
17028 trying to get round relaying restrictions. For this reason, it is best avoided
17029 if at all possible. Unfortunately, a number of less security-conscious MTAs
17030 implement it unconditionally. If you are running Exim on a gateway host, and
17031 routing mail through to internal MTAs without processing the local parts, it is
17032 a good idea to reject recipient addresses with percent characters in their
17033 local parts. Exim's default configuration does this.
17034
17035
17036 .option perl_at_start main boolean false
17037 .cindex "Perl"
17038 This option is available only when Exim is built with an embedded Perl
17039 interpreter. See chapter &<<CHAPperl>>& for details of its use.
17040
17041
17042 .option perl_startup main string unset
17043 .cindex "Perl"
17044 This option is available only when Exim is built with an embedded Perl
17045 interpreter. See chapter &<<CHAPperl>>& for details of its use.
17046
17047 .option perl_taintmode main boolean false
17048 .cindex "Perl"
17049 This option enables the taint mode of the embedded Perl interpreter.
17050
17051
17052 .option pgsql_servers main "string list" unset
17053 .cindex "PostgreSQL lookup type" "server list"
17054 This option provides a list of PostgreSQL servers and associated connection
17055 data, to be used in conjunction with &(pgsql)& lookups (see section
17056 &<<SECID72>>&). The option is available only if Exim has been built with
17057 PostgreSQL support.
17058
17059
17060 .option pid_file_path main string&!! "set at compile time"
17061 .cindex "daemon" "pid file path"
17062 .cindex "pid file, path for"
17063 This option sets the name of the file to which the Exim daemon writes its
17064 process id. The string is expanded, so it can contain, for example, references
17065 to the host name:
17066 .code
17067 pid_file_path = /var/log/$primary_hostname/exim.pid
17068 .endd
17069 If no path is set, the pid is written to the file &_exim-daemon.pid_& in Exim's
17070 spool directory.
17071 The value set by the option can be overridden by the &%-oP%& command line
17072 option. A pid file is not written if a &"non-standard"& daemon is run by means
17073 of the &%-oX%& option, unless a path is explicitly supplied by &%-oP%&.
17074
17075
17076 .option pipelining_advertise_hosts main "host list&!!" *
17077 .cindex "PIPELINING" "suppressing advertising"
17078 .cindex "ESMTP extensions" PIPELINING
17079 This option can be used to suppress the advertisement of the SMTP
17080 PIPELINING extension to specific hosts. See also the &*no_pipelining*&
17081 control in section &<<SECTcontrols>>&. When PIPELINING is not advertised and
17082 &%smtp_enforce_sync%& is true, an Exim server enforces strict synchronization
17083 for each SMTP command and response. When PIPELINING is advertised, Exim assumes
17084 that clients will use it; &"out of order"& commands that are &"expected"& do
17085 not count as protocol errors (see &%smtp_max_synprot_errors%&).
17086
17087 .option pipelining_connect_advertise_hosts main "host list&!!" *
17088 .cindex "pipelining" "early connection"
17089 .cindex "pipelining" PIPE_CONNECT
17090 .cindex "ESMTP extensions" PIPE_CONNECT
17091 If Exim is built with the SUPPORT_PIPE_CONNECT build option
17092 this option controls which hosts the facility is advertised to
17093 and from which pipeline early-connection (before MAIL) SMTP
17094 commands are acceptable.
17095 When used, the pipelining saves on roundtrip times.
17096
17097 See also the &%hosts_pipe_connect%& smtp transport option.
17098
17099 .new
17100 The SMTP service extension keyword advertised is &"PIPE_CONNECT"&.
17101 .wen
17102
17103
17104 .option prdr_enable main boolean false
17105 .cindex "PRDR" "enabling on server"
17106 .cindex "ESMTP extensions" PRDR
17107 This option can be used to enable the Per-Recipient Data Response extension
17108 to SMTP, defined by Eric Hall.
17109 If the option is set, PRDR is advertised by Exim when operating as a server.
17110 If the client requests PRDR, and more than one recipient, for a message
17111 an additional ACL is called for each recipient after the message content
17112 is received.  See section &<<SECTPRDRACL>>&.
17113
17114 .option preserve_message_logs main boolean false
17115 .cindex "message logs" "preserving"
17116 If this option is set, message log files are not deleted when messages are
17117 completed. Instead, they are moved to a sub-directory of the spool directory
17118 called &_msglog.OLD_&, where they remain available for statistical or debugging
17119 purposes. This is a dangerous option to set on systems with any appreciable
17120 volume of mail. Use with care!
17121
17122
17123 .option primary_hostname main string "see below"
17124 .cindex "name" "of local host"
17125 .cindex "host" "name of local"
17126 .cindex "local host" "name of"
17127 .vindex "&$primary_hostname$&"
17128 This specifies the name of the current host. It is used in the default EHLO or
17129 HELO command for outgoing SMTP messages (changeable via the &%helo_data%&
17130 option in the &(smtp)& transport), and as the default for &%qualify_domain%&.
17131 The value is also used by default in some SMTP response messages from an Exim
17132 server. This can be changed dynamically by setting &%smtp_active_hostname%&.
17133
17134 If &%primary_hostname%& is not set, Exim calls &[uname()]& to find the host
17135 name. If this fails, Exim panics and dies. If the name returned by &[uname()]&
17136 contains only one component, Exim passes it to &[gethostbyname()]& (or
17137 &[getipnodebyname()]& when available) in order to obtain the fully qualified
17138 version. The variable &$primary_hostname$& contains the host name, whether set
17139 explicitly by this option, or defaulted.
17140
17141
17142 .option print_topbitchars main boolean false
17143 .cindex "printing characters"
17144 .cindex "8-bit characters"
17145 By default, Exim considers only those characters whose codes lie in the range
17146 32&--126 to be printing characters. In a number of circumstances (for example,
17147 when writing log entries) non-printing characters are converted into escape
17148 sequences, primarily to avoid messing up the layout. If &%print_topbitchars%&
17149 is set, code values of 128 and above are also considered to be printing
17150 characters.
17151
17152 This option also affects the header syntax checks performed by the
17153 &(autoreply)& transport, and whether Exim uses RFC 2047 encoding of
17154 the user's full name when constructing From: and Sender: addresses (as
17155 described in section &<<SECTconstr>>&). Setting this option can cause
17156 Exim to generate eight bit message headers that do not conform to the
17157 standards.
17158
17159
17160 .option process_log_path main string unset
17161 .cindex "process log path"
17162 .cindex "log" "process log"
17163 .cindex "&'exiwhat'&"
17164 This option sets the name of the file to which an Exim process writes its
17165 &"process log"& when sent a USR1 signal. This is used by the &'exiwhat'&
17166 utility script. If this option is unset, the file called &_exim-process.info_&
17167 in Exim's spool directory is used. The ability to specify the name explicitly
17168 can be useful in environments where two different Exims are running, using
17169 different spool directories.
17170
17171
17172 .option prod_requires_admin main boolean true
17173 .cindex "restricting access to features"
17174 .oindex "&%-M%&"
17175 .oindex "&%-R%&"
17176 .oindex "&%-q%&"
17177 The &%-M%&, &%-R%&, and &%-q%& command-line options require the caller to be an
17178 admin user unless &%prod_requires_admin%& is set false. See also
17179 &%queue_list_requires_admin%& and &%commandline_checks_require_admin%&.
17180
17181
17182 .new
17183 .option proxy_protocol_timeout main time 3s
17184 .cindex proxy "proxy protocol"
17185 This option sets the timeout for proxy protocol negotiation.
17186 For details see section &<<SECTproxyInbound>>&.
17187 .wen
17188
17189
17190 .option qualify_domain main string "see below"
17191 .cindex "domain" "for qualifying addresses"
17192 .cindex "address" "qualification"
17193 This option specifies the domain name that is added to any envelope sender
17194 addresses that do not have a domain qualification. It also applies to
17195 recipient addresses if &%qualify_recipient%& is not set. Unqualified addresses
17196 are accepted by default only for locally-generated messages. Qualification is
17197 also applied to addresses in header lines such as &'From:'& and &'To:'& for
17198 locally-generated messages, unless the &%-bnq%& command line option is used.
17199
17200 Messages from external sources must always contain fully qualified addresses,
17201 unless the sending host matches &%sender_unqualified_hosts%& or
17202 &%recipient_unqualified_hosts%& (as appropriate), in which case incoming
17203 addresses are qualified with &%qualify_domain%& or &%qualify_recipient%& as
17204 necessary. Internally, Exim always works with fully qualified envelope
17205 addresses. If &%qualify_domain%& is not set, it defaults to the
17206 &%primary_hostname%& value.
17207
17208
17209 .option qualify_recipient main string "see below"
17210 This option allows you to specify a different domain for qualifying recipient
17211 addresses to the one that is used for senders. See &%qualify_domain%& above.
17212
17213
17214
17215 .option queue_domains main "domain list&!!" unset
17216 .cindex "domain" "specifying non-immediate delivery"
17217 .cindex "queueing incoming messages"
17218 .cindex "message" "queueing certain domains"
17219 This option lists domains for which immediate delivery is not required.
17220 A delivery process is started whenever a message is received, but only those
17221 domains that do not match are processed. All other deliveries wait until the
17222 next queue run. See also &%hold_domains%& and &%queue_smtp_domains%&.
17223
17224
17225 .new
17226 .option queue_fast_ramp main boolean false
17227 .cindex "queue runner" "two phase"
17228 .cindex "queue" "double scanning"
17229 If set to true, two-phase queue runs, initiated using &%-qq%& on the
17230 command line, may start parallel delivery processes during their first
17231 phase.  This will be done when a threshold number of messages have been
17232 routed for a single host.
17233 .wen
17234
17235
17236 .option queue_list_requires_admin main boolean true
17237 .cindex "restricting access to features"
17238 .oindex "&%-bp%&"
17239 The &%-bp%& command-line option, which lists the messages that are on the
17240 queue, requires the caller to be an admin user unless
17241 &%queue_list_requires_admin%& is set false.
17242 See also &%prod_requires_admin%& and &%commandline_checks_require_admin%&.
17243
17244
17245 .option queue_only main boolean false
17246 .cindex "queueing incoming messages"
17247 .cindex "message" "queueing unconditionally"
17248 If &%queue_only%& is set, a delivery process is not automatically started
17249 whenever a message is received. Instead, the message waits in the queue for the
17250 next queue run. Even if &%queue_only%& is false, incoming messages may not get
17251 delivered immediately when certain conditions (such as heavy load) occur.
17252
17253 The &%-odq%& command line has the same effect as &%queue_only%&. The &%-odb%&
17254 and &%-odi%& command line options override &%queue_only%& unless
17255 &%queue_only_override%& is set false. See also &%queue_only_file%&,
17256 &%queue_only_load%&, and &%smtp_accept_queue%&.
17257
17258
17259 .option queue_only_file main string unset
17260 .cindex "queueing incoming messages"
17261 .cindex "message" "queueing by file existence"
17262 This option can be set to a colon-separated list of absolute path names, each
17263 one optionally preceded by &"smtp"&. When Exim is receiving a message,
17264 it tests for the existence of each listed path using a call to &[stat()]&. For
17265 each path that exists, the corresponding queueing option is set.
17266 For paths with no prefix, &%queue_only%& is set; for paths prefixed by
17267 &"smtp"&, &%queue_smtp_domains%& is set to match all domains. So, for example,
17268 .code
17269 queue_only_file = smtp/some/file
17270 .endd
17271 causes Exim to behave as if &%queue_smtp_domains%& were set to &"*"& whenever
17272 &_/some/file_& exists.
17273
17274
17275 .option queue_only_load main fixed-point unset
17276 .cindex "load average"
17277 .cindex "queueing incoming messages"
17278 .cindex "message" "queueing by load"
17279 If the system load average is higher than this value, incoming messages from
17280 all sources are queued, and no automatic deliveries are started. If this
17281 happens during local or remote SMTP input, all subsequent messages received on
17282 the same SMTP connection are queued by default, whatever happens to the load in
17283 the meantime, but this can be changed by setting &%queue_only_load_latch%&
17284 false.
17285
17286 Deliveries will subsequently be performed by queue runner processes. This
17287 option has no effect on ancient operating systems on which Exim cannot
17288 determine the load average. See also &%deliver_queue_load_max%& and
17289 &%smtp_load_reserve%&.
17290
17291
17292 .option queue_only_load_latch main boolean true
17293 .cindex "load average" "re-evaluating per message"
17294 When this option is true (the default), once one message has been queued
17295 because the load average is higher than the value set by &%queue_only_load%&,
17296 all subsequent messages received on the same SMTP connection are also queued.
17297 This is a deliberate choice; even though the load average may fall below the
17298 threshold, it doesn't seem right to deliver later messages on the same
17299 connection when not delivering earlier ones. However, there are special
17300 circumstances such as very long-lived connections from scanning appliances
17301 where this is not the best strategy. In such cases, &%queue_only_load_latch%&
17302 should be set false. This causes the value of the load average to be
17303 re-evaluated for each message.
17304
17305
17306 .option queue_only_override main boolean true
17307 .cindex "queueing incoming messages"
17308 When this option is true, the &%-od%&&'x'& command line options override the
17309 setting of &%queue_only%& or &%queue_only_file%& in the configuration file. If
17310 &%queue_only_override%& is set false, the &%-od%&&'x'& options cannot be used
17311 to override; they are accepted, but ignored.
17312
17313
17314 .option queue_run_in_order main boolean false
17315 .cindex "queue runner" "processing messages in order"
17316 If this option is set, queue runs happen in order of message arrival instead of
17317 in an arbitrary order. For this to happen, a complete list of the entire queue
17318 must be set up before the deliveries start. When the queue is all held in a
17319 single directory (the default), a single list is created for both the ordered
17320 and the non-ordered cases. However, if &%split_spool_directory%& is set, a
17321 single list is not created when &%queue_run_in_order%& is false. In this case,
17322 the sub-directories are processed one at a time (in a random order), and this
17323 avoids setting up one huge list for the whole queue. Thus, setting
17324 &%queue_run_in_order%& with &%split_spool_directory%& may degrade performance
17325 when the queue is large, because of the extra work in setting up the single,
17326 large list. In most situations, &%queue_run_in_order%& should not be set.
17327
17328
17329
17330 .option queue_run_max main integer&!! 5
17331 .cindex "queue runner" "maximum number of"
17332 This controls the maximum number of queue runner processes that an Exim daemon
17333 can run simultaneously. This does not mean that it starts them all at once,
17334 but rather that if the maximum number are still running when the time comes to
17335 start another one, it refrains from starting another one. This can happen with
17336 very large queues and/or very sluggish deliveries. This option does not,
17337 however, interlock with other processes, so additional queue runners can be
17338 started by other means, or by killing and restarting the daemon.
17339
17340 Setting this option to zero does not suppress queue runs; rather, it disables
17341 the limit, allowing any number of simultaneous queue runner processes to be
17342 run. If you do not want queue runs to occur, omit the &%-q%&&'xx'& setting on
17343 the daemon's command line.
17344
17345 .cindex queues named
17346 .cindex "named queues" "resource limit"
17347 To set limits for different named queues use
17348 an expansion depending on the &$queue_name$& variable.
17349
17350 .option queue_smtp_domains main "domain list&!!" unset
17351 .cindex "queueing incoming messages"
17352 .cindex "message" "queueing remote deliveries"
17353 .cindex "first pass routing"
17354 When this option is set, a delivery process is started whenever a message is
17355 received, routing is performed, and local deliveries take place.
17356 However, if any SMTP deliveries are required for domains that match
17357 &%queue_smtp_domains%&, they are not immediately delivered, but instead the
17358 message waits in the queue for the next queue run. Since routing of the message
17359 has taken place, Exim knows to which remote hosts it must be delivered, and so
17360 when the queue run happens, multiple messages for the same host are delivered
17361 over a single SMTP connection. The &%-odqs%& command line option causes all
17362 SMTP deliveries to be queued in this way, and is equivalent to setting
17363 &%queue_smtp_domains%& to &"*"&. See also &%hold_domains%& and
17364 &%queue_domains%&.
17365
17366
17367 .option receive_timeout main time 0s
17368 .cindex "timeout" "for non-SMTP input"
17369 This option sets the timeout for accepting a non-SMTP message, that is, the
17370 maximum time that Exim waits when reading a message on the standard input. If
17371 the value is zero, it will wait forever. This setting is overridden by the
17372 &%-or%& command line option. The timeout for incoming SMTP messages is
17373 controlled by &%smtp_receive_timeout%&.
17374
17375 .option received_header_text main string&!! "see below"
17376 .cindex "customizing" "&'Received:'& header"
17377 .cindex "&'Received:'& header line" "customizing"
17378 This string defines the contents of the &'Received:'& message header that is
17379 added to each message, except for the timestamp, which is automatically added
17380 on at the end (preceded by a semicolon). The string is expanded each time it is
17381 used. If the expansion yields an empty string, no &'Received:'& header line is
17382 added to the message. Otherwise, the string should start with the text
17383 &"Received:"& and conform to the RFC 2822 specification for &'Received:'&
17384 header lines.
17385 The default setting is:
17386
17387 .code
17388 received_header_text = Received: \
17389   ${if def:sender_rcvhost {from $sender_rcvhost\n\t}\
17390     {${if def:sender_ident \
17391       {from ${quote_local_part:$sender_ident} }}\
17392         ${if def:sender_helo_name {(helo=$sender_helo_name)\n\t}}}}\
17393   by $primary_hostname \
17394   ${if def:received_protocol {with $received_protocol }}\
17395   ${if def:tls_in_ver        { ($tls_in_ver)}}\
17396   ${if def:tls_in_cipher_std { tls $tls_in_cipher_std\n\t}}\
17397   (Exim $version_number)\n\t\
17398   ${if def:sender_address \
17399   {(envelope-from <$sender_address>)\n\t}}\
17400   id $message_exim_id\
17401   ${if def:received_for {\n\tfor $received_for}}
17402 .endd
17403
17404 The references to the TLS version and cipher are
17405 omitted when Exim is built without TLS
17406 support. The use of conditional expansions ensures that this works for both
17407 locally generated messages and messages received from remote hosts, giving
17408 header lines such as the following:
17409 .code
17410 Received: from scrooge.carol.example ([192.168.12.25] ident=root)
17411 by marley.carol.example with esmtp (Exim 4.00)
17412 (envelope-from <bob@carol.example>)
17413 id 16IOWa-00019l-00
17414 for chas@dickens.example; Tue, 25 Dec 2001 14:43:44 +0000
17415 Received: by scrooge.carol.example with local (Exim 4.00)
17416 id 16IOWW-000083-00; Tue, 25 Dec 2001 14:43:41 +0000
17417 .endd
17418 Until the body of the message has been received, the timestamp is the time when
17419 the message started to be received. Once the body has arrived, and all policy
17420 checks have taken place, the timestamp is updated to the time at which the
17421 message was accepted.
17422
17423
17424 .option received_headers_max main integer 30
17425 .cindex "loop" "prevention"
17426 .cindex "mail loop prevention"
17427 .cindex "&'Received:'& header line" "counting"
17428 When a message is to be delivered, the number of &'Received:'& headers is
17429 counted, and if it is greater than this parameter, a mail loop is assumed to
17430 have occurred, the delivery is abandoned, and an error message is generated.
17431 This applies to both local and remote deliveries.
17432
17433
17434 .option recipient_unqualified_hosts main "host list&!!" unset
17435 .cindex "unqualified addresses"
17436 .cindex "host" "unqualified addresses from"
17437 This option lists those hosts from which Exim is prepared to accept unqualified
17438 recipient addresses in message envelopes. The addresses are made fully
17439 qualified by the addition of the &%qualify_recipient%& value. This option also
17440 affects message header lines. Exim does not reject unqualified recipient
17441 addresses in headers, but it qualifies them only if the message came from a
17442 host that matches &%recipient_unqualified_hosts%&,
17443 or if the message was submitted locally (not using TCP/IP), and the &%-bnq%&
17444 option was not set.
17445
17446
17447 .option recipients_max main integer 50000
17448 .cindex "limit" "number of recipients"
17449 .cindex "recipient" "maximum number"
17450 If this option is set greater than zero, it specifies the maximum number of
17451 original recipients for any message. Additional recipients that are generated
17452 by aliasing or forwarding do not count. SMTP messages get a 452 response for
17453 all recipients over the limit; earlier recipients are delivered as normal.
17454 Non-SMTP messages with too many recipients are failed, and no deliveries are
17455 done.
17456
17457 .cindex "RCPT" "maximum number of incoming"
17458 &*Note*&: The RFCs specify that an SMTP server should accept at least 100
17459 RCPT commands in a single message.
17460
17461
17462 .option recipients_max_reject main boolean false
17463 If this option is set true, Exim rejects SMTP messages containing too many
17464 recipients by giving 552 errors to the surplus RCPT commands, and a 554
17465 error to the eventual DATA command. Otherwise (the default) it gives a 452
17466 error to the surplus RCPT commands and accepts the message on behalf of the
17467 initial set of recipients. The remote server should then re-send the message
17468 for the remaining recipients at a later time.
17469
17470
17471 .option remote_max_parallel main integer 2
17472 .cindex "delivery" "parallelism for remote"
17473 This option controls parallel delivery of one message to a number of remote
17474 hosts. If the value is less than 2, parallel delivery is disabled, and Exim
17475 does all the remote deliveries for a message one by one. Otherwise, if a single
17476 message has to be delivered to more than one remote host, or if several copies
17477 have to be sent to the same remote host, up to &%remote_max_parallel%&
17478 deliveries are done simultaneously. If more than &%remote_max_parallel%&
17479 deliveries are required, the maximum number of processes are started, and as
17480 each one finishes, another is begun. The order of starting processes is the
17481 same as if sequential delivery were being done, and can be controlled by the
17482 &%remote_sort_domains%& option. If parallel delivery takes place while running
17483 with debugging turned on, the debugging output from each delivery process is
17484 tagged with its process id.
17485
17486 This option controls only the maximum number of parallel deliveries for one
17487 message in one Exim delivery process. Because Exim has no central queue
17488 manager, there is no way of controlling the total number of simultaneous
17489 deliveries if the configuration allows a delivery attempt as soon as a message
17490 is received.
17491
17492 See also the &%max_parallel%& generic transport option,
17493 and the &%serialize_hosts%& smtp transport option.
17494
17495 .cindex "number of deliveries"
17496 .cindex "delivery" "maximum number of"
17497 If you want to control the total number of deliveries on the system, you
17498 need to set the &%queue_only%& option. This ensures that all incoming messages
17499 are added to the queue without starting a delivery process. Then set up an Exim
17500 daemon to start queue runner processes at appropriate intervals (probably
17501 fairly often, for example, every minute), and limit the total number of queue
17502 runners by setting the &%queue_run_max%& parameter. Because each queue runner
17503 delivers only one message at a time, the maximum number of deliveries that can
17504 then take place at once is &%queue_run_max%& multiplied by
17505 &%remote_max_parallel%&.
17506
17507 If it is purely remote deliveries you want to control, use
17508 &%queue_smtp_domains%& instead of &%queue_only%&. This has the added benefit of
17509 doing the SMTP routing before queueing, so that several messages for the same
17510 host will eventually get delivered down the same connection.
17511
17512
17513 .option remote_sort_domains main "domain list&!!" unset
17514 .cindex "sorting remote deliveries"
17515 .cindex "delivery" "sorting remote"
17516 When there are a number of remote deliveries for a message, they are sorted by
17517 domain into the order given by this list. For example,
17518 .code
17519 remote_sort_domains = *.cam.ac.uk:*.uk
17520 .endd
17521 would attempt to deliver to all addresses in the &'cam.ac.uk'& domain first,
17522 then to those in the &%uk%& domain, then to any others.
17523
17524
17525 .option retry_data_expire main time 7d
17526 .cindex "hints database" "data expiry"
17527 This option sets a &"use before"& time on retry information in Exim's hints
17528 database. Any older retry data is ignored. This means that, for example, once a
17529 host has not been tried for 7 days, Exim behaves as if it has no knowledge of
17530 past failures.
17531
17532
17533 .option retry_interval_max main time 24h
17534 .cindex "retry" "limit on interval"
17535 .cindex "limit" "on retry interval"
17536 Chapter &<<CHAPretry>>& describes Exim's mechanisms for controlling the
17537 intervals between delivery attempts for messages that cannot be delivered
17538 straight away. This option sets an overall limit to the length of time between
17539 retries. It cannot be set greater than 24 hours; any attempt to do so forces
17540 the default value.
17541
17542
17543 .option return_path_remove main boolean true
17544 .cindex "&'Return-path:'& header line" "removing"
17545 RFC 2821, section 4.4, states that an SMTP server must insert a
17546 &'Return-path:'& header line into a message when it makes a &"final delivery"&.
17547 The &'Return-path:'& header preserves the sender address as received in the
17548 MAIL command. This description implies that this header should not be present
17549 in an incoming message. If &%return_path_remove%& is true, any existing
17550 &'Return-path:'& headers are removed from messages at the time they are
17551 received. Exim's transports have options for adding &'Return-path:'& headers at
17552 the time of delivery. They are normally used only for final local deliveries.
17553
17554
17555 .option return_size_limit main integer 100K
17556 This option is an obsolete synonym for &%bounce_return_size_limit%&.
17557
17558
17559 .option rfc1413_hosts main "host list&!!" @[]
17560 .cindex "RFC 1413"
17561 .cindex "host" "for RFC 1413 calls"
17562 RFC 1413 identification calls are made to any client host which matches
17563 an item in the list.
17564 The default value specifies just this host, being any local interface
17565 for the system.
17566
17567 .option rfc1413_query_timeout main time 0s
17568 .cindex "RFC 1413" "query timeout"
17569 .cindex "timeout" "for RFC 1413 call"
17570 This sets the timeout on RFC 1413 identification calls. If it is set to zero,
17571 no RFC 1413 calls are ever made.
17572
17573
17574 .option sender_unqualified_hosts main "host list&!!" unset
17575 .cindex "unqualified addresses"
17576 .cindex "host" "unqualified addresses from"
17577 This option lists those hosts from which Exim is prepared to accept unqualified
17578 sender addresses. The addresses are made fully qualified by the addition of
17579 &%qualify_domain%&. This option also affects message header lines. Exim does
17580 not reject unqualified addresses in headers that contain sender addresses, but
17581 it qualifies them only if the message came from a host that matches
17582 &%sender_unqualified_hosts%&, or if the message was submitted locally (not
17583 using TCP/IP), and the &%-bnq%& option was not set.
17584
17585
17586 .option slow_lookup_log main integer 0
17587 .cindex "logging" "slow lookups"
17588 .cindex "dns" "logging slow lookups"
17589 This option controls logging of slow lookups.
17590 If the value is nonzero it is taken as a number of milliseconds
17591 and lookups taking longer than this are logged.
17592 Currently this applies only to DNS lookups.
17593
17594
17595
17596 .option smtp_accept_keepalive main boolean true
17597 .cindex "keepalive" "on incoming connection"
17598 This option controls the setting of the SO_KEEPALIVE option on incoming
17599 TCP/IP socket connections. When set, it causes the kernel to probe idle
17600 connections periodically, by sending packets with &"old"& sequence numbers. The
17601 other end of the connection should send an acknowledgment if the connection is
17602 still okay or a reset if the connection has been aborted. The reason for doing
17603 this is that it has the beneficial effect of freeing up certain types of
17604 connection that can get stuck when the remote host is disconnected without
17605 tidying up the TCP/IP call properly. The keepalive mechanism takes several
17606 hours to detect unreachable hosts.
17607
17608
17609
17610 .option smtp_accept_max main integer 20
17611 .cindex "limit" "incoming SMTP connections"
17612 .cindex "SMTP" "incoming connection count"
17613 .cindex "inetd"
17614 This option specifies the maximum number of simultaneous incoming SMTP calls
17615 that Exim will accept. It applies only to the listening daemon; there is no
17616 control (in Exim) when incoming SMTP is being handled by &'inetd'&. If the
17617 value is set to zero, no limit is applied. However, it is required to be
17618 non-zero if either &%smtp_accept_max_per_host%& or &%smtp_accept_queue%& is
17619 set. See also &%smtp_accept_reserve%& and &%smtp_load_reserve%&.
17620
17621 A new SMTP connection is immediately rejected if the &%smtp_accept_max%& limit
17622 has been reached. If not, Exim first checks &%smtp_accept_max_per_host%&. If
17623 that limit has not been reached for the client host, &%smtp_accept_reserve%&
17624 and &%smtp_load_reserve%& are then checked before accepting the connection.
17625
17626
17627 .option smtp_accept_max_nonmail main integer 10
17628 .cindex "limit" "non-mail SMTP commands"
17629 .cindex "SMTP" "limiting non-mail commands"
17630 Exim counts the number of &"non-mail"& commands in an SMTP session, and drops
17631 the connection if there are too many. This option defines &"too many"&. The
17632 check catches some denial-of-service attacks, repeated failing AUTHs, or a mad
17633 client looping sending EHLO, for example. The check is applied only if the
17634 client host matches &%smtp_accept_max_nonmail_hosts%&.
17635
17636 When a new message is expected, one occurrence of RSET is not counted. This
17637 allows a client to send one RSET between messages (this is not necessary,
17638 but some clients do it). Exim also allows one uncounted occurrence of HELO
17639 or EHLO, and one occurrence of STARTTLS between messages. After
17640 starting up a TLS session, another EHLO is expected, and so it too is not
17641 counted. The first occurrence of AUTH in a connection, or immediately
17642 following STARTTLS is not counted. Otherwise, all commands other than
17643 MAIL, RCPT, DATA, and QUIT are counted.
17644
17645
17646 .option smtp_accept_max_nonmail_hosts main "host list&!!" *
17647 You can control which hosts are subject to the &%smtp_accept_max_nonmail%&
17648 check by setting this option. The default value makes it apply to all hosts. By
17649 changing the value, you can exclude any badly-behaved hosts that you have to
17650 live with.
17651
17652
17653 . Allow this long option name to split; give it unsplit as a fifth argument
17654 . for the automatic .oindex that is generated by .option.
17655 . We insert " &~&~" which is both pretty nasty visually and results in
17656 . non-searchable text.  HowItWorks.txt mentions an option for inserting
17657 . zero-width-space, which would be nicer visually and results in (at least)
17658 . html that Firefox will split on when it's forced to reflow (rather than
17659 . inserting a horizontal scrollbar).  However, the text is still not
17660 . searchable.  NM changed this occurrence for bug 1197 to no longer allow
17661 . the option name to split.
17662
17663 .option "smtp_accept_max_per_connection" main integer&!! 1000 &&&
17664          smtp_accept_max_per_connection
17665 .cindex "SMTP" "limiting incoming message count"
17666 .cindex "limit" "messages per SMTP connection"
17667 The value of this option limits the number of MAIL commands that Exim is
17668 prepared to accept over a single SMTP connection, whether or not each command
17669 results in the transfer of a message. After the limit is reached, a 421
17670 response is given to subsequent MAIL commands. This limit is a safety
17671 precaution against a client that goes mad (incidents of this type have been
17672 seen).
17673 .new
17674 The option is expanded after the HELO or EHLO is received
17675 and may depend on values available at that time.
17676 An empty or zero value after expansion removes the limit.
17677 .wen
17678
17679
17680 .option smtp_accept_max_per_host main string&!! unset
17681 .cindex "limit" "SMTP connections from one host"
17682 .cindex "host" "limiting SMTP connections from"
17683 This option restricts the number of simultaneous IP connections from a single
17684 host (strictly, from a single IP address) to the Exim daemon. The option is
17685 expanded, to enable different limits to be applied to different hosts by
17686 reference to &$sender_host_address$&. Once the limit is reached, additional
17687 connection attempts from the same host are rejected with error code 421. This
17688 is entirely independent of &%smtp_accept_reserve%&. The option's default value
17689 of zero imposes no limit. If this option is set greater than zero, it is
17690 required that &%smtp_accept_max%& be non-zero.
17691
17692 &*Warning*&: When setting this option you should not use any expansion
17693 constructions that take an appreciable amount of time. The expansion and test
17694 happen in the main daemon loop, in order to reject additional connections
17695 without forking additional processes (otherwise a denial-of-service attack
17696 could cause a vast number or processes to be created). While the daemon is
17697 doing this processing, it cannot accept any other incoming connections.
17698
17699
17700
17701 .option smtp_accept_queue main integer 0
17702 .cindex "SMTP" "incoming connection count"
17703 .cindex "queueing incoming messages"
17704 .cindex "message" "queueing by SMTP connection count"
17705 If the number of simultaneous incoming SMTP connections being handled via the
17706 listening daemon exceeds this value, messages received by SMTP are just placed
17707 in the queue; no delivery processes are started automatically. The count is
17708 fixed at the start of an SMTP connection. It cannot be updated in the
17709 subprocess that receives messages, and so the queueing or not queueing applies
17710 to all messages received in the same connection.
17711
17712 A value of zero implies no limit, and clearly any non-zero value is useful only
17713 if it is less than the &%smtp_accept_max%& value (unless that is zero). See
17714 also &%queue_only%&, &%queue_only_load%&, &%queue_smtp_domains%&, and the
17715 various &%-od%&&'x'& command line options.
17716
17717
17718 . See the comment on smtp_accept_max_per_connection
17719
17720 .option "smtp_accept_queue_per_connection" main integer 10 &&&
17721          smtp_accept_queue_per_connection
17722 .cindex "queueing incoming messages"
17723 .cindex "message" "queueing by message count"
17724 This option limits the number of delivery processes that Exim starts
17725 automatically when receiving messages via SMTP, whether via the daemon or by
17726 the use of &%-bs%& or &%-bS%&. If the value of the option is greater than zero,
17727 and the number of messages received in a single SMTP session exceeds this
17728 number, subsequent messages are placed in the queue, but no delivery processes
17729 are started. This helps to limit the number of Exim processes when a server
17730 restarts after downtime and there is a lot of mail waiting for it on other
17731 systems. On large systems, the default should probably be increased, and on
17732 dial-in client systems it should probably be set to zero (that is, disabled).
17733
17734
17735 .option smtp_accept_reserve main integer 0
17736 .cindex "SMTP" "incoming call count"
17737 .cindex "host" "reserved"
17738 When &%smtp_accept_max%& is set greater than zero, this option specifies a
17739 number of SMTP connections that are reserved for connections from the hosts
17740 that are specified in &%smtp_reserve_hosts%&. The value set in
17741 &%smtp_accept_max%& includes this reserve pool. The specified hosts are not
17742 restricted to this number of connections; the option specifies a minimum number
17743 of connection slots for them, not a maximum. It is a guarantee that this group
17744 of hosts can always get at least &%smtp_accept_reserve%& connections. However,
17745 the limit specified by &%smtp_accept_max_per_host%& is still applied to each
17746 individual host.
17747
17748 For example, if &%smtp_accept_max%& is set to 50 and &%smtp_accept_reserve%& is
17749 set to 5, once there are 45 active connections (from any hosts), new
17750 connections are accepted only from hosts listed in &%smtp_reserve_hosts%&,
17751 provided the other criteria for acceptance are met.
17752
17753
17754 .option smtp_active_hostname main string&!! unset
17755 .cindex "host" "name in SMTP responses"
17756 .cindex "SMTP" "host name in responses"
17757 .vindex "&$primary_hostname$&"
17758 This option is provided for multi-homed servers that want to masquerade as
17759 several different hosts. At the start of an incoming SMTP connection, its value
17760 is expanded and used instead of the value of &$primary_hostname$& in SMTP
17761 responses. For example, it is used as domain name in the response to an
17762 incoming HELO or EHLO command.
17763
17764 .vindex "&$smtp_active_hostname$&"
17765 The active hostname is placed in the &$smtp_active_hostname$& variable, which
17766 is saved with any messages that are received. It is therefore available for use
17767 in routers and transports when the message is later delivered.
17768
17769 If this option is unset, or if its expansion is forced to fail, or if the
17770 expansion results in an empty string, the value of &$primary_hostname$& is
17771 used. Other expansion failures cause a message to be written to the main and
17772 panic logs, and the SMTP command receives a temporary error. Typically, the
17773 value of &%smtp_active_hostname%& depends on the incoming interface address.
17774 For example:
17775 .code
17776 smtp_active_hostname = ${if eq{$received_ip_address}{10.0.0.1}\
17777   {cox.mydomain}{box.mydomain}}
17778 .endd
17779
17780 Although &$smtp_active_hostname$& is primarily concerned with incoming
17781 messages, it is also used as the default for HELO commands in callout
17782 verification if there is no remote transport from which to obtain a
17783 &%helo_data%& value.
17784
17785 .option smtp_backlog_monitor main integer 0
17786 .cindex "connection backlog" monitoring
17787 If this option is set to greater than zero, and the backlog of available
17788 TCP connections on a socket listening for SMTP is larger than it, a line
17789 is logged giving the value and the socket address and port.
17790 The value is retrived jsut before an accept call.
17791 This facility is only available on Linux.
17792
17793 .option smtp_banner main string&!! "see below"
17794 .cindex "SMTP" "welcome banner"
17795 .cindex "banner for SMTP"
17796 .cindex "welcome banner for SMTP"
17797 .cindex "customizing" "SMTP banner"
17798 This string, which is expanded every time it is used, is output as the initial
17799 positive response to an SMTP connection. The default setting is:
17800 .code
17801 smtp_banner = $smtp_active_hostname ESMTP Exim \
17802   $version_number $tod_full
17803 .endd
17804 Failure to expand the string causes a panic error. If you want to create a
17805 multiline response to the initial SMTP connection, use &"\n"& in the string at
17806 appropriate points, but not at the end. Note that the 220 code is not included
17807 in this string. Exim adds it automatically (several times in the case of a
17808 multiline response).
17809
17810
17811 .option smtp_check_spool_space main boolean true
17812 .cindex "checking disk space"
17813 .cindex "disk space, checking"
17814 .cindex "spool directory" "checking space"
17815 When this option is set, if an incoming SMTP session encounters the SIZE
17816 option on a MAIL command, it checks that there is enough space in the
17817 spool directory's partition to accept a message of that size, while still
17818 leaving free the amount specified by &%check_spool_space%& (even if that value
17819 is zero). If there isn't enough space, a temporary error code is returned.
17820
17821
17822 .option smtp_connect_backlog main integer 20
17823 .cindex "connection backlog" "set maximum"
17824 .cindex "SMTP" "connection backlog"
17825 .cindex "backlog of connections"
17826 This option specifies a maximum number of waiting SMTP connections. Exim passes
17827 this value to the TCP/IP system when it sets up its listener. Once this number
17828 of connections are waiting for the daemon's attention, subsequent connection
17829 attempts are refused at the TCP/IP level. At least, that is what the manuals
17830 say; in some circumstances such connection attempts have been observed to time
17831 out instead. For large systems it is probably a good idea to increase the
17832 value (to 50, say). It also gives some protection against denial-of-service
17833 attacks by SYN flooding.
17834
17835
17836 .option smtp_enforce_sync main boolean true
17837 .cindex "SMTP" "synchronization checking"
17838 .cindex "synchronization checking in SMTP"
17839 The SMTP protocol specification requires the client to wait for a response from
17840 the server at certain points in the dialogue. Without PIPELINING these
17841 synchronization points are after every command; with PIPELINING they are
17842 fewer, but they still exist.
17843
17844 Some spamming sites send out a complete set of SMTP commands without waiting
17845 for any response. Exim protects against this by rejecting a message if the
17846 client has sent further input when it should not have. The error response &"554
17847 SMTP synchronization error"& is sent, and the connection is dropped. Testing
17848 for this error cannot be perfect because of transmission delays (unexpected
17849 input may be on its way but not yet received when Exim checks). However, it
17850 does detect many instances.
17851
17852 The check can be globally disabled by setting &%smtp_enforce_sync%& false.
17853 If you want to disable the check selectively (for example, only for certain
17854 hosts), you can do so by an appropriate use of a &%control%& modifier in an ACL
17855 (see section &<<SECTcontrols>>&). See also &%pipelining_advertise_hosts%&.
17856
17857
17858
17859 .option smtp_etrn_command main string&!! unset
17860 .cindex "ETRN" "command to be run"
17861 .cindex "ESMTP extensions" ETRN
17862 .vindex "&$domain$&"
17863 If this option is set, the given command is run whenever an SMTP ETRN
17864 command is received from a host that is permitted to issue such commands (see
17865 chapter &<<CHAPACL>>&). The string is split up into separate arguments which
17866 are independently expanded. The expansion variable &$domain$& is set to the
17867 argument of the ETRN command, and no syntax checking is done on it. For
17868 example:
17869 .code
17870 smtp_etrn_command = /etc/etrn_command $domain \
17871                     $sender_host_address
17872 .endd
17873 If the option is not set, the argument for the ETRN command must
17874 be a &'#'& followed by an address string.
17875 In this case an &'exim -R <string>'& command is used;
17876 if the ETRN ACL has set up a named-queue then &'-MCG <queue>'& is appended.
17877
17878 A new process is created to run the command, but Exim does not wait for it to
17879 complete. Consequently, its status cannot be checked. If the command cannot be
17880 run, a line is written to the panic log, but the ETRN caller still receives
17881 a 250 success response. Exim is normally running under its own uid when
17882 receiving SMTP, so it is not possible for it to change the uid before running
17883 the command.
17884
17885
17886 .option smtp_etrn_serialize main boolean true
17887 .cindex "ETRN" "serializing"
17888 When this option is set, it prevents the simultaneous execution of more than
17889 one identical command as a result of ETRN in an SMTP connection. See
17890 section &<<SECTETRN>>& for details.
17891
17892
17893 .option smtp_load_reserve main fixed-point unset
17894 .cindex "load average"
17895 If the system load average ever gets higher than this, incoming SMTP calls are
17896 accepted only from those hosts that match an entry in &%smtp_reserve_hosts%&.
17897 If &%smtp_reserve_hosts%& is not set, no incoming SMTP calls are accepted when
17898 the load is over the limit. The option has no effect on ancient operating
17899 systems on which Exim cannot determine the load average. See also
17900 &%deliver_queue_load_max%& and &%queue_only_load%&.
17901
17902
17903
17904 .option smtp_max_synprot_errors main integer 3
17905 .cindex "SMTP" "limiting syntax and protocol errors"
17906 .cindex "limit" "SMTP syntax and protocol errors"
17907 Exim rejects SMTP commands that contain syntax or protocol errors. In
17908 particular, a syntactically invalid email address, as in this command:
17909 .code
17910 RCPT TO:<abc xyz@a.b.c>
17911 .endd
17912 causes immediate rejection of the command, before any other tests are done.
17913 (The ACL cannot be run if there is no valid address to set up for it.) An
17914 example of a protocol error is receiving RCPT before MAIL. If there are
17915 too many syntax or protocol errors in one SMTP session, the connection is
17916 dropped. The limit is set by this option.
17917
17918 .cindex "PIPELINING" "expected errors"
17919 When the PIPELINING extension to SMTP is in use, some protocol errors are
17920 &"expected"&, for instance, a RCPT command after a rejected MAIL command.
17921 Exim assumes that PIPELINING will be used if it advertises it (see
17922 &%pipelining_advertise_hosts%&), and in this situation, &"expected"& errors do
17923 not count towards the limit.
17924
17925
17926
17927 .option smtp_max_unknown_commands main integer 3
17928 .cindex "SMTP" "limiting unknown commands"
17929 .cindex "limit" "unknown SMTP commands"
17930 If there are too many unrecognized commands in an incoming SMTP session, an
17931 Exim server drops the connection. This is a defence against some kinds of abuse
17932 that subvert web
17933 clients
17934 into making connections to SMTP ports; in these circumstances, a number of
17935 non-SMTP command lines are sent first.
17936
17937
17938
17939 .option smtp_ratelimit_hosts main "host list&!!" unset
17940 .cindex "SMTP" "rate limiting"
17941 .cindex "limit" "rate of message arrival"
17942 .cindex "RCPT" "rate limiting"
17943 Some sites find it helpful to be able to limit the rate at which certain hosts
17944 can send them messages, and the rate at which an individual message can specify
17945 recipients.
17946
17947 Exim has two rate-limiting facilities. This section describes the older
17948 facility, which can limit rates within a single connection. The newer
17949 &%ratelimit%& ACL condition can limit rates across all connections. See section
17950 &<<SECTratelimiting>>& for details of the newer facility.
17951
17952 When a host matches &%smtp_ratelimit_hosts%&, the values of
17953 &%smtp_ratelimit_mail%& and &%smtp_ratelimit_rcpt%& are used to control the
17954 rate of acceptance of MAIL and RCPT commands in a single SMTP session,
17955 respectively. Each option, if set, must contain a set of four comma-separated
17956 values:
17957
17958 .ilist
17959 A threshold, before which there is no rate limiting.
17960 .next
17961 An initial time delay. Unlike other times in Exim, numbers with decimal
17962 fractional parts are allowed here.
17963 .next
17964 A factor by which to increase the delay each time.
17965 .next
17966 A maximum value for the delay. This should normally be less than 5 minutes,
17967 because after that time, the client is liable to timeout the SMTP command.
17968 .endlist
17969
17970 For example, these settings have been used successfully at the site which
17971 first suggested this feature, for controlling mail from their customers:
17972 .code
17973 smtp_ratelimit_mail = 2,0.5s,1.05,4m
17974 smtp_ratelimit_rcpt = 4,0.25s,1.015,4m
17975 .endd
17976 The first setting specifies delays that are applied to MAIL commands after
17977 two have been received over a single connection. The initial delay is 0.5
17978 seconds, increasing by a factor of 1.05 each time. The second setting applies
17979 delays to RCPT commands when more than four occur in a single message.
17980
17981
17982 .option smtp_ratelimit_mail main string unset
17983 See &%smtp_ratelimit_hosts%& above.
17984
17985
17986 .option smtp_ratelimit_rcpt main string unset
17987 See &%smtp_ratelimit_hosts%& above.
17988
17989
17990 .option smtp_receive_timeout main time&!! 5m
17991 .cindex "timeout" "for SMTP input"
17992 .cindex "SMTP" "input timeout"
17993 This sets a timeout value for SMTP reception. It applies to all forms of SMTP
17994 input, including batch SMTP. If a line of input (either an SMTP command or a
17995 data line) is not received within this time, the SMTP connection is dropped and
17996 the message is abandoned.
17997 A line is written to the log containing one of the following messages:
17998 .code
17999 SMTP command timeout on connection from...
18000 SMTP data timeout on connection from...
18001 .endd
18002 The former means that Exim was expecting to read an SMTP command; the latter
18003 means that it was in the DATA phase, reading the contents of a message.
18004
18005 If the first character of the option is a &"$"& the option is
18006 expanded before use and may depend on
18007 &$sender_host_name$&, &$sender_host_address$& and &$sender_host_port$&.
18008
18009
18010 .oindex "&%-os%&"
18011 The value set by this option can be overridden by the
18012 &%-os%& command-line option. A setting of zero time disables the timeout, but
18013 this should never be used for SMTP over TCP/IP. (It can be useful in some cases
18014 of local input using &%-bs%& or &%-bS%&.) For non-SMTP input, the reception
18015 timeout is controlled by &%receive_timeout%& and &%-or%&.
18016
18017
18018 .option smtp_reserve_hosts main "host list&!!" unset
18019 This option defines hosts for which SMTP connections are reserved; see
18020 &%smtp_accept_reserve%& and &%smtp_load_reserve%& above.
18021
18022
18023 .option smtp_return_error_details main boolean false
18024 .cindex "SMTP" "details policy failures"
18025 .cindex "policy control" "rejection, returning details"
18026 In the default state, Exim uses bland messages such as
18027 &"Administrative prohibition"& when it rejects SMTP commands for policy
18028 reasons. Many sysadmins like this because it gives away little information
18029 to spammers. However, some other sysadmins who are applying strict checking
18030 policies want to give out much fuller information about failures. Setting
18031 &%smtp_return_error_details%& true causes Exim to be more forthcoming. For
18032 example, instead of &"Administrative prohibition"&, it might give:
18033 .code
18034 550-Rejected after DATA: '>' missing at end of address:
18035 550 failing address in "From" header is: <user@dom.ain
18036 .endd
18037
18038
18039 .option smtputf8_advertise_hosts main "host list&!!" *
18040 .cindex "SMTPUTF8" "ESMTP extension, advertising"
18041 .cindex "ESMTP extensions" SMTPUTF8
18042 When Exim is built with support for internationalised mail names,
18043 the availability thereof is advertised in
18044 response to EHLO only to those client hosts that match this option. See
18045 chapter &<<CHAPi18n>>& for details of Exim's support for internationalisation.
18046
18047
18048 .option spamd_address main string "127.0.0.1 783"
18049 This option is available when Exim is compiled with the content-scanning
18050 extension. It specifies how Exim connects to SpamAssassin's &%spamd%& daemon.
18051 See section &<<SECTscanspamass>>& for more details.
18052
18053
18054
18055 .option spf_guess main string "v=spf1 a/24 mx/24 ptr ?all"
18056 This option is available when Exim is compiled with SPF support.
18057 See section &<<SECSPF>>& for more details.
18058
18059 .option spf_smtp_comment_template main string&!! "Please%_see%_http://www.open-spf.org/Why"
18060 This option is available when Exim is compiled with SPF support.  It
18061 allows the customisation of the SMTP comment that the SPF library
18062 generates.  You are strongly encouraged to link to your own explanative
18063 site. The template must not contain spaces. If you need spaces in the
18064 output, use the proper placeholder. If libspf2 can not parse the
18065 template, it uses a built-in default broken link. The following placeholders
18066 (along with Exim variables (but see below)) are allowed in the template:
18067 .ilist
18068 &*%_*&: A space.
18069 .next
18070 &*%{L}*&: Envelope sender's local part.
18071 .next
18072 &*%{S}*&: Envelope sender.
18073 .next
18074 &*%{O}*&: Envelope sender's domain.
18075 .next
18076 &*%{D}*&: Current(?) domain.
18077 .next
18078 &*%{I}*&: SMTP client Ip.
18079 .next
18080 &*%{C}*&: SMTP client pretty IP.
18081 .next
18082 &*%{T}*&: Epoch time (UTC).
18083 .next
18084 &*%{P}*&: SMTP client domain name.
18085 .next
18086 &*%{V}*&: IP version.
18087 .next
18088 &*%{H}*&: EHLO/HELO domain.
18089 .next
18090 &*%{R}*&: Receiving domain.
18091 .endlist
18092 The capitalized placeholders do proper URL encoding, if you use them
18093 lowercased, no encoding takes place.  This list was compiled from the
18094 libspf2 sources.
18095
18096 A note on using Exim variables: As
18097 currently the SPF library is initialized before the SMTP EHLO phase,
18098 the variables useful for expansion are quite limited.
18099
18100
18101 .option split_spool_directory main boolean false
18102 .cindex "multiple spool directories"
18103 .cindex "spool directory" "split"
18104 .cindex "directories, multiple"
18105 If this option is set, it causes Exim to split its input directory into 62
18106 subdirectories, each with a single alphanumeric character as its name. The
18107 sixth character of the message id is used to allocate messages to
18108 subdirectories; this is the least significant base-62 digit of the time of
18109 arrival of the message.
18110
18111 Splitting up the spool in this way may provide better performance on systems
18112 where there are long mail queues, by reducing the number of files in any one
18113 directory. The msglog directory is also split up in a similar way to the input
18114 directory; however, if &%preserve_message_logs%& is set, all old msglog files
18115 are still placed in the single directory &_msglog.OLD_&.
18116
18117 It is not necessary to take any special action for existing messages when
18118 changing &%split_spool_directory%&. Exim notices messages that are in the
18119 &"wrong"& place, and continues to process them. If the option is turned off
18120 after a period of being on, the subdirectories will eventually empty and be
18121 automatically deleted.
18122
18123 When &%split_spool_directory%& is set, the behaviour of queue runner processes
18124 changes. Instead of creating a list of all messages in the queue, and then
18125 trying to deliver each one, in turn, it constructs a list of those in one
18126 sub-directory and tries to deliver them, before moving on to the next
18127 sub-directory. The sub-directories are processed in a random order. This
18128 spreads out the scanning of the input directories, and uses less memory. It is
18129 particularly beneficial when there are lots of messages in the queue. However,
18130 if &%queue_run_in_order%& is set, none of this new processing happens. The
18131 entire queue has to be scanned and sorted before any deliveries can start.
18132
18133
18134 .option spool_directory main string&!! "set at compile time"
18135 .cindex "spool directory" "path to"
18136 This defines the directory in which Exim keeps its spool, that is, the messages
18137 it is waiting to deliver. The default value is taken from the compile-time
18138 configuration setting, if there is one. If not, this option must be set. The
18139 string is expanded, so it can contain, for example, a reference to
18140 &$primary_hostname$&.
18141
18142 If the spool directory name is fixed on your installation, it is recommended
18143 that you set it at build time rather than from this option, particularly if the
18144 log files are being written to the spool directory (see &%log_file_path%&).
18145 Otherwise log files cannot be used for errors that are detected early on, such
18146 as failures in the configuration file.
18147
18148 By using this option to override the compiled-in path, it is possible to run
18149 tests of Exim without using the standard spool.
18150
18151 .option spool_wireformat main boolean false
18152 .cindex "spool directory" "file formats"
18153 If this option is set, Exim may for some messages use an alternative format
18154 for data-files in the spool which matches the wire format.
18155 Doing this permits more efficient message reception and transmission.
18156 Currently it is only done for messages received using the ESMTP CHUNKING
18157 option.
18158
18159 The following variables will not have useful values:
18160 .code
18161 $max_received_linelength
18162 $body_linecount
18163 $body_zerocount
18164 .endd
18165
18166 Users of the local_scan() API (see &<<CHAPlocalscan>>&),
18167 and any external programs which are passed a reference to a message data file
18168 (except via the &"regex"&, &"malware"& or &"spam"&) ACL conditions)
18169 will need to be aware of the different formats potentially available.
18170
18171 Using any of the ACL conditions noted will negate the reception benefit
18172 (as a Unix-mbox-format file is constructed for them).
18173 The transmission benefit is maintained.
18174
18175 .option sqlite_lock_timeout main time 5s
18176 .cindex "sqlite lookup type" "lock timeout"
18177 This option controls the timeout that the &(sqlite)& lookup uses when trying to
18178 access an SQLite database. See section &<<SECTsqlite>>& for more details.
18179
18180 .option strict_acl_vars main boolean false
18181 .cindex "&ACL;" "variables, handling unset"
18182 This option controls what happens if a syntactically valid but undefined ACL
18183 variable is referenced. If it is false (the default), an empty string
18184 is substituted; if it is true, an error is generated. See section
18185 &<<SECTaclvariables>>& for details of ACL variables.
18186
18187 .option strip_excess_angle_brackets main boolean false
18188 .cindex "angle brackets, excess"
18189 If this option is set, redundant pairs of angle brackets round &"route-addr"&
18190 items in addresses are stripped. For example, &'<<xxx@a.b.c.d>>'& is
18191 treated as &'<xxx@a.b.c.d>'&. If this is in the envelope and the message is
18192 passed on to another MTA, the excess angle brackets are not passed on. If this
18193 option is not set, multiple pairs of angle brackets cause a syntax error.
18194
18195
18196 .option strip_trailing_dot main boolean false
18197 .cindex "trailing dot on domain"
18198 .cindex "dot" "trailing on domain"
18199 If this option is set, a trailing dot at the end of a domain in an address is
18200 ignored. If this is in the envelope and the message is passed on to another
18201 MTA, the dot is not passed on. If this option is not set, a dot at the end of a
18202 domain causes a syntax error.
18203 However, addresses in header lines are checked only when an ACL requests header
18204 syntax checking.
18205
18206
18207 .option syslog_duplication main boolean true
18208 .cindex "syslog" "duplicate log lines; suppressing"
18209 When Exim is logging to syslog, it writes the log lines for its three
18210 separate logs at different syslog priorities so that they can in principle
18211 be separated on the logging hosts. Some installations do not require this
18212 separation, and in those cases, the duplication of certain log lines is a
18213 nuisance. If &%syslog_duplication%& is set false, only one copy of any
18214 particular log line is written to syslog. For lines that normally go to
18215 both the main log and the reject log, the reject log version (possibly
18216 containing message header lines) is written, at LOG_NOTICE priority.
18217 Lines that normally go to both the main and the panic log are written at
18218 the LOG_ALERT priority.
18219
18220
18221 .option syslog_facility main string unset
18222 .cindex "syslog" "facility; setting"
18223 This option sets the syslog &"facility"& name, used when Exim is logging to
18224 syslog. The value must be one of the strings &"mail"&, &"user"&, &"news"&,
18225 &"uucp"&, &"daemon"&, or &"local&'x'&"& where &'x'& is a digit between 0 and 7.
18226 If this option is unset, &"mail"& is used. See chapter &<<CHAPlog>>& for
18227 details of Exim's logging.
18228
18229
18230 .option syslog_pid main boolean true
18231 .cindex "syslog" "pid"
18232 If &%syslog_pid%& is set false, the PID on Exim's log lines are
18233 omitted when these lines are sent to syslog. (Syslog normally prefixes
18234 the log lines with the PID of the logging process automatically.) You need
18235 to enable the &`+pid`& log selector item, if you want Exim to write it's PID
18236 into the logs.) See chapter &<<CHAPlog>>& for details of Exim's logging.
18237
18238
18239
18240 .option syslog_processname main string &`exim`&
18241 .cindex "syslog" "process name; setting"
18242 This option sets the syslog &"ident"& name, used when Exim is logging to
18243 syslog. The value must be no longer than 32 characters. See chapter
18244 &<<CHAPlog>>& for details of Exim's logging.
18245
18246
18247
18248 .option syslog_timestamp main boolean true
18249 .cindex "syslog" "timestamps"
18250 .cindex timestamps syslog
18251 If &%syslog_timestamp%& is set false, the timestamps on Exim's log lines are
18252 omitted when these lines are sent to syslog. See chapter &<<CHAPlog>>& for
18253 details of Exim's logging.
18254
18255
18256 .option system_filter main string&!! unset
18257 .cindex "filter" "system filter"
18258 .cindex "system filter" "specifying"
18259 .cindex "Sieve filter" "not available for system filter"
18260 This option specifies an Exim filter file that is applied to all messages at
18261 the start of each delivery attempt, before any routing is done. System filters
18262 must be Exim filters; they cannot be Sieve filters. If the system filter
18263 generates any deliveries to files or pipes, or any new mail messages, the
18264 appropriate &%system_filter_..._transport%& option(s) must be set, to define
18265 which transports are to be used. Details of this facility are given in chapter
18266 &<<CHAPsystemfilter>>&.
18267 A forced expansion failure results in no filter operation.
18268
18269
18270 .option system_filter_directory_transport main string&!! unset
18271 .vindex "&$address_file$&"
18272 This sets the name of the transport driver that is to be used when the
18273 &%save%& command in a system message filter specifies a path ending in &"/"&,
18274 implying delivery of each message into a separate file in some directory.
18275 During the delivery, the variable &$address_file$& contains the path name.
18276
18277
18278 .option system_filter_file_transport main string&!! unset
18279 .cindex "file" "transport for system filter"
18280 This sets the name of the transport driver that is to be used when the &%save%&
18281 command in a system message filter specifies a path not ending in &"/"&. During
18282 the delivery, the variable &$address_file$& contains the path name.
18283
18284 .option system_filter_group main string unset
18285 .cindex "gid (group id)" "system filter"
18286 This option is used only when &%system_filter_user%& is also set. It sets the
18287 gid under which the system filter is run, overriding any gid that is associated
18288 with the user. The value may be numerical or symbolic.
18289
18290 .option system_filter_pipe_transport main string&!! unset
18291 .cindex "&(pipe)& transport" "for system filter"
18292 .vindex "&$address_pipe$&"
18293 This specifies the transport driver that is to be used when a &%pipe%& command
18294 is used in a system filter. During the delivery, the variable &$address_pipe$&
18295 contains the pipe command.
18296
18297
18298 .option system_filter_reply_transport main string&!! unset
18299 .cindex "&(autoreply)& transport" "for system filter"
18300 This specifies the transport driver that is to be used when a &%mail%& command
18301 is used in a system filter.
18302
18303
18304 .option system_filter_user main string unset
18305 .cindex "uid (user id)" "system filter"
18306 If this option is set to root, the system filter is run in the main Exim
18307 delivery process, as root.  Otherwise, the system filter runs in a separate
18308 process, as the given user, defaulting to the Exim run-time user.
18309 Unless the string consists entirely of digits, it
18310 is looked up in the password data. Failure to find the named user causes a
18311 configuration error. The gid is either taken from the password data, or
18312 specified by &%system_filter_group%&. When the uid is specified numerically,
18313 &%system_filter_group%& is required to be set.
18314
18315 If the system filter generates any pipe, file, or reply deliveries, the uid
18316 under which the filter is run is used when transporting them, unless a
18317 transport option overrides.
18318
18319
18320 .option tcp_nodelay main boolean true
18321 .cindex "daemon" "TCP_NODELAY on sockets"
18322 .cindex "Nagle algorithm"
18323 .cindex "TCP_NODELAY on listening sockets"
18324 If this option is set false, it stops the Exim daemon setting the
18325 TCP_NODELAY option on its listening sockets. Setting TCP_NODELAY
18326 turns off the &"Nagle algorithm"&, which is a way of improving network
18327 performance in interactive (character-by-character) situations. Turning it off
18328 should improve Exim's performance a bit, so that is what happens by default.
18329 However, it appears that some broken clients cannot cope, and time out. Hence
18330 this option. It affects only those sockets that are set up for listening by the
18331 daemon. Sockets created by the smtp transport for delivering mail always set
18332 TCP_NODELAY.
18333
18334
18335 .option timeout_frozen_after main time 0s
18336 .cindex "frozen messages" "timing out"
18337 .cindex "timeout" "frozen messages"
18338 If &%timeout_frozen_after%& is set to a time greater than zero, a frozen
18339 message of any kind that has been in the queue for longer than the given time
18340 is automatically cancelled at the next queue run. If the frozen message is a
18341 bounce message, it is just discarded; otherwise, a bounce is sent to the
18342 sender, in a similar manner to cancellation by the &%-Mg%& command line option.
18343 If you want to timeout frozen bounce messages earlier than other kinds of
18344 frozen message, see &%ignore_bounce_errors_after%&.
18345
18346 &*Note:*& the default value of zero means no timeouts; with this setting,
18347 frozen messages remain in the queue forever (except for any frozen bounce
18348 messages that are released by &%ignore_bounce_errors_after%&).
18349
18350
18351 .option timezone main string unset
18352 .cindex "timezone, setting"
18353 .cindex "environment" "values from"
18354 The value of &%timezone%& is used to set the environment variable TZ while
18355 running Exim (if it is different on entry). This ensures that all timestamps
18356 created by Exim are in the required timezone. If you want all your timestamps
18357 to be in UTC (aka GMT) you should set
18358 .code
18359 timezone = UTC
18360 .endd
18361 The default value is taken from TIMEZONE_DEFAULT in &_Local/Makefile_&,
18362 or, if that is not set, from the value of the TZ environment variable when Exim
18363 is built. If &%timezone%& is set to the empty string, either at build or run
18364 time, any existing TZ variable is removed from the environment when Exim
18365 runs. This is appropriate behaviour for obtaining wall-clock time on some, but
18366 unfortunately not all, operating systems.
18367
18368
18369 .option tls_advertise_hosts main "host list&!!" *
18370 .cindex "TLS" "advertising"
18371 .cindex "encryption" "on SMTP connection"
18372 .cindex "SMTP" "encrypted connection"
18373 .cindex "ESMTP extensions" STARTTLS
18374 When Exim is built with support for TLS encrypted connections, the availability
18375 of the STARTTLS command to set up an encrypted session is advertised in
18376 response to EHLO only to those client hosts that match this option. See
18377 chapter &<<CHAPTLS>>& for details of Exim's support for TLS.
18378 Note that the default value requires that a certificate be supplied
18379 using the &%tls_certificate%& option.  If TLS support for incoming connections
18380 is not required the &%tls_advertise_hosts%& option should be set empty.
18381
18382
18383 .new
18384 .option tls_alpn main "string list&!!" "smtp : esmtp"
18385 .cindex TLS "Application Layer Protocol Names"
18386 .cindex TLS ALPN
18387 .cindex ALPN "set acceptable names for server"
18388 If this option is set,
18389 the TLS library supports ALPN,
18390 and the client offers either more than
18391 ALPN name or a name which does not match the list,
18392 the TLS connection is declined.
18393 .wen
18394
18395
18396 .option tls_certificate main "string list&!!" unset
18397 .cindex "TLS" "server certificate; location of"
18398 .cindex "certificate" "server, location of"
18399 The value of this option is expanded, and must then be a list of absolute paths to
18400 files which contain the server's certificates (in PEM format).
18401 Commonly only one file is needed.
18402 The server's private key is also
18403 assumed to be in this file if &%tls_privatekey%& is unset. See chapter
18404 &<<CHAPTLS>>& for further details.
18405
18406 &*Note*&: The certificates defined by this option are used only when Exim is
18407 receiving incoming messages as a server. If you want to supply certificates for
18408 use when sending messages as a client, you must set the &%tls_certificate%&
18409 option in the relevant &(smtp)& transport.
18410
18411 &*Note*&: If you use filenames based on IP addresses, change the list
18412 separator in the usual way (&<<SECTlistsepchange>>&) to avoid confusion under IPv6.
18413
18414 &*Note*&: Under versions of OpenSSL preceding 1.1.1,
18415 when a list of more than one
18416 file is used, the &$tls_in_ourcert$& variable is unreliable.
18417 The macro "_TLS_BAD_MULTICERT_IN_OURCERT" will be defined for those versions.
18418
18419 .cindex SNI "selecting server certificate based on"
18420 If the option contains &$tls_out_sni$& and Exim is built against OpenSSL, then
18421 if the OpenSSL build supports TLS extensions and the TLS client sends the
18422 Server Name Indication extension, then this option and others documented in
18423 &<<SECTtlssni>>& will be re-expanded.
18424
18425 If this option is unset or empty a self-signed certificate will be
18426 .new
18427 used.
18428 Under Linux this is generated at daemon startup; on other platforms it will be
18429 generated fresh for every connection.
18430 .wen
18431
18432 .option tls_crl main string&!! unset
18433 .cindex "TLS" "server certificate revocation list"
18434 .cindex "certificate" "revocation list for server"
18435 This option specifies a certificate revocation list. The expanded value must
18436 be the name of a file that contains CRLs in PEM format.
18437
18438 Under OpenSSL the option can specify a directory with CRL files.
18439
18440 &*Note:*& Under OpenSSL the option must, if given, supply a CRL
18441 for each signing element of the certificate chain (i.e. all but the leaf).
18442 For the file variant this can be multiple PEM blocks in the one file.
18443
18444 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
18445
18446
18447 .option tls_dh_max_bits main integer 2236
18448 .cindex "TLS" "D-H bit count"
18449 The number of bits used for Diffie-Hellman key-exchange may be suggested by
18450 the chosen TLS library.  That value might prove to be too high for
18451 interoperability.  This option provides a maximum clamp on the value
18452 suggested, trading off security for interoperability.
18453
18454 The value must be at least 1024.
18455
18456 The value 2236 was chosen because, at time of adding the option, it was the
18457 hard-coded maximum value supported by the NSS cryptographic library, as used
18458 by Thunderbird, while GnuTLS was suggesting 2432 bits as normal.
18459
18460 If you prefer more security and are willing to break some clients, raise this
18461 number.
18462
18463 Note that the value passed to GnuTLS for *generating* a new prime may be a
18464 little less than this figure, because GnuTLS is inexact and may produce a
18465 larger prime than requested.
18466
18467
18468 .option tls_dhparam main string&!! unset
18469 .cindex "TLS" "D-H parameters for server"
18470 The value of this option is expanded and indicates the source of DH parameters
18471 to be used by Exim.
18472
18473 This option is ignored for GnuTLS version 3.6.0 and later.
18474 The library manages parameter negotiation internally.
18475
18476 &*Note: The Exim Maintainers strongly recommend,
18477 for other TLS library versions,
18478 using a filename with site-generated
18479 local DH parameters*&, which has been supported across all versions of Exim.  The
18480 other specific constants available are a fallback so that even when
18481 "unconfigured", Exim can offer Perfect Forward Secrecy in older ciphersuites in TLS.
18482
18483 If &%tls_dhparam%& is a filename starting with a &`/`&,
18484 then it names a file from which DH
18485 parameters should be loaded.  If the file exists, it should hold a PEM-encoded
18486 PKCS#3 representation of the DH prime.  If the file does not exist, for
18487 OpenSSL it is an error.  For GnuTLS, Exim will attempt to create the file and
18488 fill it with a generated DH prime.  For OpenSSL, if the DH bit-count from
18489 loading the file is greater than &%tls_dh_max_bits%& then it will be ignored,
18490 and treated as though the &%tls_dhparam%& were set to "none".
18491
18492 If this option expands to the string "none", then no DH parameters will be
18493 loaded by Exim.
18494
18495 If this option expands to the string "historic" and Exim is using GnuTLS, then
18496 Exim will attempt to load a file from inside the spool directory.  If the file
18497 does not exist, Exim will attempt to create it.
18498 See section &<<SECTgnutlsparam>>& for further details.
18499
18500 If Exim is using OpenSSL and this option is empty or unset, then Exim will load
18501 a default DH prime; the default is Exim-specific but lacks verifiable provenance.
18502
18503 In older versions of Exim the default was the 2048 bit prime described in section
18504 2.2 of RFC 5114, "2048-bit MODP Group with 224-bit Prime Order Subgroup", which
18505 in IKE is assigned number 23.
18506
18507 Otherwise, the option must expand to the name used by Exim for any of a number
18508 of DH primes specified in RFC 2409, RFC 3526, RFC 5114, RFC 7919, or from other
18509 sources.  As names, Exim uses a standard specified name, else "ike" followed by
18510 the number used by IKE, or "default" which corresponds to
18511 &`exim.dev.20160529.3`&.
18512
18513 The available standard primes are:
18514 &`ffdhe2048`&, &`ffdhe3072`&, &`ffdhe4096`&, &`ffdhe6144`&, &`ffdhe8192`&,
18515 &`ike1`&, &`ike2`&, &`ike5`&,
18516 &`ike14`&, &`ike15`&, &`ike16`&, &`ike17`&, &`ike18`&,
18517 &`ike22`&, &`ike23`& and &`ike24`&.
18518
18519 The available additional primes are:
18520 &`exim.dev.20160529.1`&, &`exim.dev.20160529.2`& and &`exim.dev.20160529.3`&.
18521
18522 Some of these will be too small to be accepted by clients.
18523 Some may be too large to be accepted by clients.
18524 The open cryptographic community has suspicions about the integrity of some
18525 of the later IKE values, which led into RFC7919 providing new fixed constants
18526 (the "ffdhe" identifiers).
18527
18528 At this point, all of the "ike" values should be considered obsolete;
18529 they're still in Exim to avoid breaking unusual configurations, but are
18530 candidates for removal the next time we have backwards-incompatible changes.
18531
18532 The TLS protocol does not negotiate an acceptable size for this; clients tend
18533 to hard-drop connections if what is offered by the server is unacceptable,
18534 whether too large or too small, and there's no provision for the client to
18535 tell the server what these constraints are.  Thus, as a server operator, you
18536 need to make an educated guess as to what is most likely to work for your
18537 userbase.
18538
18539 Some known size constraints suggest that a bit-size in the range 2048 to 2236
18540 is most likely to maximise interoperability.  The upper bound comes from
18541 applications using the Mozilla Network Security Services (NSS) library, which
18542 used to set its &`DH_MAX_P_BITS`& upper-bound to 2236.  This affects many
18543 mail user agents (MUAs). The lower bound comes from Debian installs of Exim4
18544 prior to the 4.80 release, as Debian used to patch Exim to raise the minimum
18545 acceptable bound from 1024 to 2048.
18546
18547
18548 .option tls_eccurve main string&!! &`auto`&
18549 .cindex TLS "EC cryptography"
18550 This option selects a EC curve for use by Exim when used with OpenSSL.
18551 It has no effect when Exim is used with GnuTLS.
18552
18553 After expansion it must contain a valid EC curve parameter, such as
18554 &`prime256v1`&, &`secp384r1`&, or &`P-512`&. Consult your OpenSSL manual
18555 for valid selections.
18556
18557 For OpenSSL versions before (and not including) 1.0.2, the string
18558 &`auto`& selects &`prime256v1`&. For more recent OpenSSL versions
18559 &`auto`& tells the library to choose.
18560
18561 If the option expands to an empty string, no EC curves will be enabled.
18562
18563
18564 .option tls_ocsp_file main string&!! unset
18565 .cindex TLS "certificate status"
18566 .cindex TLS "OCSP proof file"
18567 This option
18568 must if set expand to the absolute path to a file which contains a current
18569 status proof for the server's certificate, as obtained from the
18570 Certificate Authority.
18571
18572 Usable for GnuTLS 3.4.4 or 3.3.17 or OpenSSL 1.1.0 (or later).
18573 The macro "_HAVE_TLS_OCSP" will be defined for those versions.
18574
18575 For OpenSSL 1.1.0 or later, and
18576 for GnuTLS 3.5.6 or later the expanded value of this option can be a list
18577 of files, to match a list given for the &%tls_certificate%& option.
18578 The ordering of the two lists must match.
18579 The macro "_HAVE_TLS_OCSP_LIST" will be defined for those versions.
18580
18581 The file(s) should be in DER format,
18582 except for GnuTLS 3.6.3 or later
18583 or for OpenSSL,
18584 when an optional filetype prefix can be used.
18585 The prefix must be one of "DER" or "PEM", followed by
18586 a single space.  If one is used it sets the format for subsequent
18587 files in the list; the initial format is DER.
18588 If multiple proofs are wanted, for multiple chain elements
18589 (this only works under TLS1.3)
18590 they must be coded as a combined OCSP response.
18591
18592 Although GnuTLS will accept PEM files with multiple separate
18593 PEM blobs (ie. separate OCSP responses), it sends them in the
18594 TLS Certificate record interleaved with the certificates of the chain;
18595 although a GnuTLS client is happy with that, an OpenSSL client is not.
18596
18597 .option tls_on_connect_ports main "string list" unset
18598 .cindex SSMTP
18599 .cindex SMTPS
18600 This option specifies a list of incoming SSMTP (aka SMTPS) ports that should
18601 operate the SSMTP (SMTPS) protocol, where a TLS session is immediately
18602 set up without waiting for the client to issue a STARTTLS command. For
18603 further details, see section &<<SECTsupobssmt>>&.
18604
18605
18606
18607 .option tls_privatekey main "string list&!!" unset
18608 .cindex "TLS" "server private key; location of"
18609 The value of this option is expanded, and must then be a list of absolute paths to
18610 files which contains the server's private keys.
18611 If this option is unset, or if
18612 the expansion is forced to fail, or the result is an empty string, the private
18613 key is assumed to be in the same file as the server's certificates. See chapter
18614 &<<CHAPTLS>>& for further details.
18615
18616 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
18617
18618
18619 .option tls_remember_esmtp main boolean false
18620 .cindex "TLS" "esmtp state; remembering"
18621 .cindex "TLS" "broken clients"
18622 If this option is set true, Exim violates the RFCs by remembering that it is in
18623 &"esmtp"& state after successfully negotiating a TLS session. This provides
18624 support for broken clients that fail to send a new EHLO after starting a
18625 TLS session.
18626
18627
18628 .option tls_require_ciphers main string&!! unset
18629 .cindex "TLS" "requiring specific ciphers"
18630 .cindex "cipher" "requiring specific"
18631 This option controls which ciphers can be used for incoming TLS connections.
18632 The &(smtp)& transport has an option of the same name for controlling outgoing
18633 connections. This option is expanded for each connection, so can be varied for
18634 different clients if required. The value of this option must be a list of
18635 permitted cipher suites. The OpenSSL and GnuTLS libraries handle cipher control
18636 in somewhat different ways. If GnuTLS is being used, the client controls the
18637 preference order of the available ciphers. Details are given in sections
18638 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
18639
18640
18641 .new
18642 .option tls_resumption_hosts main "host list&!!" unset
18643 .cindex TLS resumption
18644 This option controls which connections to offer the TLS resumption feature.
18645 See &<<SECTresumption>>& for details.
18646 .wen
18647
18648
18649 .option tls_try_verify_hosts main "host list&!!" unset
18650 .cindex "TLS" "client certificate verification"
18651 .cindex "certificate" "verification of client"
18652 See &%tls_verify_hosts%& below.
18653
18654
18655 .option tls_verify_certificates main string&!! system
18656 .cindex "TLS" "client certificate verification"
18657 .cindex "certificate" "verification of client"
18658 The value of this option is expanded, and must then be either the
18659 word "system"
18660 or the absolute path to
18661 a file or directory containing permitted certificates for clients that
18662 match &%tls_verify_hosts%& or &%tls_try_verify_hosts%&.
18663
18664 The "system" value for the option will use a
18665 system default location compiled into the SSL library.
18666 This is not available for GnuTLS versions preceding 3.0.20,
18667 and will be taken as empty; an explicit location
18668 must be specified.
18669
18670 The use of a directory for the option value is not available for GnuTLS versions
18671 preceding 3.3.6 and a single file must be used.
18672
18673 With OpenSSL the certificates specified
18674 explicitly
18675 either by file or directory
18676 are added to those given by the system default location.
18677
18678 These certificates should be for the certificate authorities trusted, rather
18679 than the public cert of individual clients.  With both OpenSSL and GnuTLS, if
18680 the value is a file then the certificates are sent by Exim as a server to
18681 connecting clients, defining the list of accepted certificate authorities.
18682 Thus the values defined should be considered public data.  To avoid this,
18683 use the explicit directory version. (If your peer is Exim up to 4.85,
18684 using GnuTLS, you may need to send the CAs (thus using the file
18685 variant). Otherwise the peer doesn't send its certificate.)
18686
18687 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
18688
18689 A forced expansion failure or setting to an empty string is equivalent to
18690 being unset.
18691
18692
18693 .option tls_verify_hosts main "host list&!!" unset
18694 .cindex "TLS" "client certificate verification"
18695 .cindex "certificate" "verification of client"
18696 This option, along with &%tls_try_verify_hosts%&, controls the checking of
18697 certificates from clients. The expected certificates are defined by
18698 &%tls_verify_certificates%&, which must be set. A configuration error occurs if
18699 either &%tls_verify_hosts%& or &%tls_try_verify_hosts%& is set and
18700 &%tls_verify_certificates%& is not set.
18701
18702 Any client that matches &%tls_verify_hosts%& is constrained by
18703 &%tls_verify_certificates%&. When the client initiates a TLS session, it must
18704 present one of the listed certificates. If it does not, the connection is
18705 aborted. &*Warning*&: Including a host in &%tls_verify_hosts%& does not require
18706 the host to use TLS. It can still send SMTP commands through unencrypted
18707 connections. Forcing a client to use TLS has to be done separately using an
18708 ACL to reject inappropriate commands when the connection is not encrypted.
18709
18710 A weaker form of checking is provided by &%tls_try_verify_hosts%&. If a client
18711 matches this option (but not &%tls_verify_hosts%&), Exim requests a
18712 certificate and checks it against &%tls_verify_certificates%&, but does not
18713 abort the connection if there is no certificate or if it does not match. This
18714 state can be detected in an ACL, which makes it possible to implement policies
18715 such as &"accept for relay only if a verified certificate has been received,
18716 but accept for local delivery if encrypted, even without a verified
18717 certificate"&.
18718
18719 Client hosts that match neither of these lists are not asked to present
18720 certificates.
18721
18722
18723 .option trusted_groups main "string list&!!" unset
18724 .cindex "trusted groups"
18725 .cindex "groups" "trusted"
18726 This option is expanded just once, at the start of Exim's processing. If this
18727 option is set, any process that is running in one of the listed groups, or
18728 which has one of them as a supplementary group, is trusted. The groups can be
18729 specified numerically or by name. See section &<<SECTtrustedadmin>>& for
18730 details of what trusted callers are permitted to do. If neither
18731 &%trusted_groups%& nor &%trusted_users%& is set, only root and the Exim user
18732 are trusted.
18733
18734 .option trusted_users main "string list&!!" unset
18735 .cindex "trusted users"
18736 .cindex "user" "trusted"
18737 This option is expanded just once, at the start of Exim's processing. If this
18738 option is set, any process that is running as one of the listed users is
18739 trusted. The users can be specified numerically or by name. See section
18740 &<<SECTtrustedadmin>>& for details of what trusted callers are permitted to do.
18741 If neither &%trusted_groups%& nor &%trusted_users%& is set, only root and the
18742 Exim user are trusted.
18743
18744 .option unknown_login main string&!! unset
18745 .cindex "uid (user id)" "unknown caller"
18746 .vindex "&$caller_uid$&"
18747 This is a specialized feature for use in unusual configurations. By default, if
18748 the uid of the caller of Exim cannot be looked up using &[getpwuid()]&, Exim
18749 gives up. The &%unknown_login%& option can be used to set a login name to be
18750 used in this circumstance. It is expanded, so values like &%user$caller_uid%&
18751 can be set. When &%unknown_login%& is used, the value of &%unknown_username%&
18752 is used for the user's real name (gecos field), unless this has been set by the
18753 &%-F%& option.
18754
18755 .option unknown_username main string unset
18756 See &%unknown_login%&.
18757
18758 .option untrusted_set_sender main "address list&!!" unset
18759 .cindex "trusted users"
18760 .cindex "sender" "setting by untrusted user"
18761 .cindex "untrusted user setting sender"
18762 .cindex "user" "untrusted setting sender"
18763 .cindex "envelope from"
18764 .cindex "envelope sender"
18765 When an untrusted user submits a message to Exim using the standard input, Exim
18766 normally creates an envelope sender address from the user's login and the
18767 default qualification domain. Data from the &%-f%& option (for setting envelope
18768 senders on non-SMTP messages) or the SMTP MAIL command (if &%-bs%& or &%-bS%&
18769 is used) is ignored.
18770
18771 However, untrusted users are permitted to set an empty envelope sender address,
18772 to declare that a message should never generate any bounces. For example:
18773 .code
18774 exim -f '<>' user@domain.example
18775 .endd
18776 .vindex "&$sender_ident$&"
18777 The &%untrusted_set_sender%& option allows you to permit untrusted users to set
18778 other envelope sender addresses in a controlled way. When it is set, untrusted
18779 users are allowed to set envelope sender addresses that match any of the
18780 patterns in the list. Like all address lists, the string is expanded. The
18781 identity of the user is in &$sender_ident$&, so you can, for example, restrict
18782 users to setting senders that start with their login ids
18783 followed by a hyphen
18784 by a setting like this:
18785 .code
18786 untrusted_set_sender = ^$sender_ident-
18787 .endd
18788 If you want to allow untrusted users to set envelope sender addresses without
18789 restriction, you can use
18790 .code
18791 untrusted_set_sender = *
18792 .endd
18793 The &%untrusted_set_sender%& option applies to all forms of local input, but
18794 only to the setting of the envelope sender. It does not permit untrusted users
18795 to use the other options which trusted user can use to override message
18796 parameters. Furthermore, it does not stop Exim from removing an existing
18797 &'Sender:'& header in the message, or from adding a &'Sender:'& header if
18798 necessary. See &%local_sender_retain%& and &%local_from_check%& for ways of
18799 overriding these actions. The handling of the &'Sender:'& header is also
18800 described in section &<<SECTthesenhea>>&.
18801
18802 The log line for a message's arrival shows the envelope sender following
18803 &"<="&. For local messages, the user's login always follows, after &"U="&. In
18804 &%-bp%& displays, and in the Exim monitor, if an untrusted user sets an
18805 envelope sender address, the user's login is shown in parentheses after the
18806 sender address.
18807
18808
18809 .option uucp_from_pattern main string "see below"
18810 .cindex "&""From""& line"
18811 .cindex "UUCP" "&""From""& line"
18812 Some applications that pass messages to an MTA via a command line interface use
18813 an initial line starting with &"From&~"& to pass the envelope sender. In
18814 particular, this is used by UUCP software. Exim recognizes such a line by means
18815 of a regular expression that is set in &%uucp_from_pattern%&. When the pattern
18816 matches, the sender address is constructed by expanding the contents of
18817 &%uucp_from_sender%&, provided that the caller of Exim is a trusted user. The
18818 default pattern recognizes lines in the following two forms:
18819 .code
18820 From ph10 Fri Jan  5 12:35 GMT 1996
18821 From ph10 Fri, 7 Jan 97 14:00:00 GMT
18822 .endd
18823 The pattern can be seen by running
18824 .code
18825 exim -bP uucp_from_pattern
18826 .endd
18827 It checks only up to the hours and minutes, and allows for a 2-digit or 4-digit
18828 year in the second case. The first word after &"From&~"& is matched in the
18829 regular expression by a parenthesized subpattern. The default value for
18830 &%uucp_from_sender%& is &"$1"&, which therefore just uses this first word
18831 (&"ph10"& in the example above) as the message's sender. See also
18832 &%ignore_fromline_hosts%&.
18833
18834
18835 .option uucp_from_sender main string&!! &`$1`&
18836 See &%uucp_from_pattern%& above.
18837
18838
18839 .option warn_message_file main string&!! unset
18840 .cindex "warning of delay" "customizing the message"
18841 .cindex "customizing" "warning message"
18842 This option defines a template file containing paragraphs of text to be used
18843 for constructing the warning message which is sent by Exim when a message has
18844 been in the queue for a specified amount of time, as specified by
18845 &%delay_warning%&. Details of the file's contents are given in chapter
18846 &<<CHAPemsgcust>>&.
18847 .cindex warn_message_file "tainted data"
18848 The option is expanded to give the file path, which must be
18849 absolute and untainted.
18850 See also &%bounce_message_file%&.
18851
18852
18853 .option write_rejectlog main boolean true
18854 .cindex "reject log" "disabling"
18855 If this option is set false, Exim no longer writes anything to the reject log.
18856 See chapter &<<CHAPlog>>& for details of what Exim writes to its logs.
18857 .ecindex IIDconfima
18858 .ecindex IIDmaiconf
18859
18860
18861
18862
18863 . ////////////////////////////////////////////////////////////////////////////
18864 . ////////////////////////////////////////////////////////////////////////////
18865
18866 .chapter "Generic options for routers" "CHAProutergeneric"
18867 .scindex IIDgenoprou1 "options" "generic; for routers"
18868 .scindex IIDgenoprou2 "generic options" "router"
18869 This chapter describes the generic options that apply to all routers.
18870 Those that are preconditions are marked with &Dagger; in the &"use"& field.
18871
18872 For a general description of how a router operates, see sections
18873 &<<SECTrunindrou>>& and &<<SECTrouprecon>>&. The latter specifies the order in
18874 which the preconditions are tested. The order of expansion of the options that
18875 provide data for a transport is: &%errors_to%&, &%headers_add%&,
18876 &%headers_remove%&, &%transport%&.
18877
18878 .new
18879 The name of a router is limited to be &drivernamemax; ASCII characters long;
18880 prior to Exim 4.95 names would be silently truncated at this length, but now
18881 it is enforced.
18882 .wen
18883
18884
18885 .option address_data routers string&!! unset
18886 .cindex "router" "data attached to address"
18887 The string is expanded just before the router is run, that is, after all the
18888 precondition tests have succeeded. If the expansion is forced to fail, the
18889 router declines, the value of &%address_data%& remains unchanged, and the
18890 &%more%& option controls what happens next. Other expansion failures cause
18891 delivery of the address to be deferred.
18892
18893 .vindex "&$address_data$&"
18894 When the expansion succeeds, the value is retained with the address, and can be
18895 accessed using the variable &$address_data$& in the current router, subsequent
18896 routers, and the eventual transport.
18897
18898 &*Warning*&: If the current or any subsequent router is a &(redirect)& router
18899 that runs a user's filter file, the contents of &$address_data$& are accessible
18900 in the filter. This is not normally a problem, because such data is usually
18901 either not confidential or it &"belongs"& to the current user, but if you do
18902 put confidential data into &$address_data$& you need to remember this point.
18903
18904 Even if the router declines or passes, the value of &$address_data$& remains
18905 with the address, though it can be changed by another &%address_data%& setting
18906 on a subsequent router. If a router generates child addresses, the value of
18907 &$address_data$& propagates to them. This also applies to the special kind of
18908 &"child"& that is generated by a router with the &%unseen%& option.
18909
18910 The idea of &%address_data%& is that you can use it to look up a lot of data
18911 for the address once, and then pick out parts of the data later. For example,
18912 you could use a single LDAP lookup to return a string of the form
18913 .code
18914 uid=1234 gid=5678 mailbox=/mail/xyz forward=/home/xyz/.forward
18915 .endd
18916 In the transport you could pick out the mailbox by a setting such as
18917 .code
18918 file = ${extract{mailbox}{$address_data}}
18919 .endd
18920 This makes the configuration file less messy, and also reduces the number of
18921 lookups (though Exim does cache lookups).
18922
18923 See also the &%set%& option below.
18924
18925 .vindex "&$sender_address_data$&"
18926 .vindex "&$address_data$&"
18927 The &%address_data%& facility is also useful as a means of passing information
18928 from one router to another, and from a router to a transport. In addition, if
18929 &$address_data$& is set by a router when verifying a recipient address from an
18930 ACL, it remains available for use in the rest of the ACL statement. After
18931 verifying a sender, the value is transferred to &$sender_address_data$&.
18932
18933
18934
18935 .option address_test routers&!? boolean true
18936 .oindex "&%-bt%&"
18937 .cindex "router" "skipping when address testing"
18938 If this option is set false, the router is skipped when routing is being tested
18939 by means of the &%-bt%& command line option. This can be a convenience when
18940 your first router sends messages to an external scanner, because it saves you
18941 having to set the &"already scanned"& indicator when testing real address
18942 routing.
18943
18944
18945
18946 .option cannot_route_message routers string&!! unset
18947 .cindex "router" "customizing &""cannot route""& message"
18948 .cindex "customizing" "&""cannot route""& message"
18949 This option specifies a text message that is used when an address cannot be
18950 routed because Exim has run out of routers. The default message is
18951 &"Unrouteable address"&. This option is useful only on routers that have
18952 &%more%& set false, or on the very last router in a configuration, because the
18953 value that is used is taken from the last router that is considered. This
18954 includes a router that is skipped because its preconditions are not met, as
18955 well as a router that declines. For example, using the default configuration,
18956 you could put:
18957 .code
18958 cannot_route_message = Remote domain not found in DNS
18959 .endd
18960 on the first router, which is a &(dnslookup)& router with &%more%& set false,
18961 and
18962 .code
18963 cannot_route_message = Unknown local user
18964 .endd
18965 on the final router that checks for local users. If string expansion fails for
18966 this option, the default message is used. Unless the expansion failure was
18967 explicitly forced, a message about the failure is written to the main and panic
18968 logs, in addition to the normal message about the routing failure.
18969
18970
18971 .option caseful_local_part routers boolean false
18972 .cindex "case of local parts"
18973 .cindex "router" "case of local parts"
18974 By default, routers handle the local parts of addresses in a case-insensitive
18975 manner, though the actual case is preserved for transmission with the message.
18976 If you want the case of letters to be significant in a router, you must set
18977 this option true. For individual router options that contain address or local
18978 part lists (for example, &%local_parts%&), case-sensitive matching can be
18979 turned on by &"+caseful"& as a list item. See section &<<SECTcasletadd>>& for
18980 more details.
18981
18982 .vindex "&$local_part$&"
18983 .vindex "&$original_local_part$&"
18984 .vindex "&$parent_local_part$&"
18985 The value of the &$local_part$& variable is forced to lower case while a
18986 router is running unless &%caseful_local_part%& is set. When a router assigns
18987 an address to a transport, the value of &$local_part$& when the transport runs
18988 is the same as it was in the router. Similarly, when a router generates child
18989 addresses by aliasing or forwarding, the values of &$original_local_part$&
18990 and &$parent_local_part$& are those that were used by the redirecting router.
18991
18992 This option applies to the processing of an address by a router. When a
18993 recipient address is being processed in an ACL, there is a separate &%control%&
18994 modifier that can be used to specify case-sensitive processing within the ACL
18995 (see section &<<SECTcontrols>>&).
18996
18997
18998
18999 .option check_local_user routers&!? boolean false
19000 .cindex "local user, checking in router"
19001 .cindex "router" "checking for local user"
19002 .cindex "&_/etc/passwd_&"
19003 .vindex "&$home$&"
19004 When this option is true, Exim checks that the local part of the recipient
19005 address (with affixes removed if relevant) is the name of an account on the
19006 local system. The check is done by calling the &[getpwnam()]& function rather
19007 than trying to read &_/etc/passwd_& directly. This means that other methods of
19008 holding password data (such as NIS) are supported. If the local part is a local
19009 user,
19010 .cindex "tainted data" "de-tainting"
19011 &$local_part_data$& is set to an untainted version of the local part and
19012 &$home$& is set from the password data. The latter can be tested in other
19013 preconditions that are evaluated after this one (the order of evaluation is
19014 given in section &<<SECTrouprecon>>&). However, the value of &$home$& can be
19015 overridden by &%router_home_directory%&. If the local part is not a local user,
19016 the router is skipped.
19017
19018 If you want to check that the local part is either the name of a local user
19019 or matches something else, you cannot combine &%check_local_user%& with a
19020 setting of &%local_parts%&, because that specifies the logical &'and'& of the
19021 two conditions. However, you can use a &(passwd)& lookup in a &%local_parts%&
19022 setting to achieve this. For example:
19023 .code
19024 local_parts = passwd;$local_part : lsearch;/etc/other/users
19025 .endd
19026 Note, however, that the side effects of &%check_local_user%& (such as setting
19027 up a home directory) do not occur when a &(passwd)& lookup is used in a
19028 &%local_parts%& (or any other) precondition.
19029
19030
19031
19032 .option condition routers&!? string&!! unset
19033 .cindex "router" "customized precondition"
19034 This option specifies a general precondition test that has to succeed for the
19035 router to be called. The &%condition%& option is the last precondition to be
19036 evaluated (see section &<<SECTrouprecon>>&). The string is expanded, and if the
19037 result is a forced failure, or an empty string, or one of the strings &"0"& or
19038 &"no"& or &"false"& (checked without regard to the case of the letters), the
19039 router is skipped, and the address is offered to the next one.
19040
19041 If the result is any other value, the router is run (as this is the last
19042 precondition to be evaluated, all the other preconditions must be true).
19043
19044 This option is unusual in that multiple &%condition%& options may be present.
19045 All &%condition%& options must succeed.
19046
19047 The &%condition%& option provides a means of applying custom conditions to the
19048 running of routers. Note that in the case of a simple conditional expansion,
19049 the default expansion values are exactly what is wanted. For example:
19050 .code
19051 condition = ${if >{$message_age}{600}}
19052 .endd
19053 Because of the default behaviour of the string expansion, this is equivalent to
19054 .code
19055 condition = ${if >{$message_age}{600}{true}{}}
19056 .endd
19057
19058 A multiple condition example, which succeeds:
19059 .code
19060 condition = ${if >{$message_age}{600}}
19061 condition = ${if !eq{${lc:$local_part}}{postmaster}}
19062 condition = foobar
19063 .endd
19064
19065 If the expansion fails (other than forced failure) delivery is deferred. Some
19066 of the other precondition options are common special cases that could in fact
19067 be specified using &%condition%&.
19068
19069 Historical note: We have &%condition%& on ACLs and on Routers.  Routers
19070 are far older, and use one set of semantics.  ACLs are newer and when
19071 they were created, the ACL &%condition%& process was given far stricter
19072 parse semantics.  The &%bool{}%& expansion condition uses the same rules as
19073 ACLs.  The &%bool_lax{}%& expansion condition uses the same rules as
19074 Routers.  More pointedly, the &%bool_lax{}%& was written to match the existing
19075 Router rules processing behavior.
19076
19077 This is best illustrated in an example:
19078 .code
19079 # If used in an ACL condition will fail with a syntax error, but
19080 # in a router condition any extra characters are treated as a string
19081
19082 $ exim -be '${if eq {${lc:GOOGLE.com}} {google.com}} {yes} {no}}'
19083 true {yes} {no}}
19084
19085 $ exim -be '${if eq {${lc:WHOIS.com}} {google.com}} {yes} {no}}'
19086  {yes} {no}}
19087 .endd
19088 In each example above, the &%if%& statement actually ends after
19089 &"{google.com}}"&.  Since no true or false braces were defined, the
19090 default &%if%& behavior is to return a boolean true or a null answer
19091 (which evaluates to false). The rest of the line is then treated as a
19092 string. So the first example resulted in the boolean answer &"true"&
19093 with the string &" {yes} {no}}"& appended to it. The second example
19094 resulted in the null output (indicating false) with the string
19095 &" {yes} {no}}"& appended to it.
19096
19097 In fact you can put excess forward braces in too.  In the router
19098 &%condition%&, Exim's parser only looks for &"{"& symbols when they
19099 mean something, like after a &"$"& or when required as part of a
19100 conditional.  But otherwise &"{"& and &"}"& are treated as ordinary
19101 string characters.
19102
19103 Thus, in a Router, the above expansion strings will both always evaluate
19104 true, as the result of expansion is a non-empty string which doesn't
19105 match an explicit false value.  This can be tricky to debug.  By
19106 contrast, in an ACL either of those strings will always result in an
19107 expansion error because the result doesn't look sufficiently boolean.
19108
19109
19110 .option debug_print routers string&!! unset
19111 .cindex "testing" "variables in drivers"
19112 If this option is set and debugging is enabled (see the &%-d%& command line
19113 option) or in address-testing mode (see the &%-bt%& command line option),
19114 the string is expanded and included in the debugging output.
19115 If expansion of the string fails, the error message is written to the debugging
19116 output, and Exim carries on processing.
19117 This option is provided to help with checking out the values of variables and
19118 so on when debugging router configurations. For example, if a &%condition%&
19119 option appears not to be working, &%debug_print%& can be used to output the
19120 variables it references. The output happens after checks for &%domains%&,
19121 &%local_parts%&, and &%check_local_user%& but before any other preconditions
19122 are tested. A newline is added to the text if it does not end with one.
19123 The variable &$router_name$& contains the name of the router.
19124
19125
19126
19127 .option disable_logging routers boolean false
19128 If this option is set true, nothing is logged for any routing errors
19129 or for any deliveries caused by this router. You should not set this option
19130 unless you really, really know what you are doing. See also the generic
19131 transport option of the same name.
19132
19133 .option dnssec_request_domains routers "domain list&!!" *
19134 .cindex "MX record" "security"
19135 .cindex "DNSSEC" "MX lookup"
19136 .cindex "security" "MX lookup"
19137 .cindex "DNS" "DNSSEC"
19138 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
19139 the DNSSEC request bit set.
19140 This applies to all of the SRV, MX, AAAA, A lookup sequence.
19141
19142 .option dnssec_require_domains routers "domain list&!!" unset
19143 .cindex "MX record" "security"
19144 .cindex "DNSSEC" "MX lookup"
19145 .cindex "security" "MX lookup"
19146 .cindex "DNS" "DNSSEC"
19147 DNS lookups for domains matching &%dnssec_require_domains%& will be done with
19148 the DNSSEC request bit set.  Any returns not having the Authenticated Data bit
19149 (AD bit) set will be ignored and logged as a host-lookup failure.
19150 This applies to all of the SRV, MX, AAAA, A lookup sequence.
19151
19152
19153 .option domains routers&!? "domain list&!!" unset
19154 .cindex "router" "restricting to specific domains"
19155 .vindex "&$domain_data$&"
19156 If this option is set, the router is skipped unless the current domain matches
19157 the list. If the match is achieved by means of a file lookup, the data that the
19158 lookup returned for the domain is placed in &$domain_data$& for use in string
19159 expansions of the driver's private options and in the transport.
19160 See section &<<SECTrouprecon>>& for
19161 a list of the order in which preconditions are evaluated.
19162
19163
19164
19165 .option driver routers string unset
19166 This option must always be set. It specifies which of the available routers is
19167 to be used.
19168
19169
19170 .option dsn_lasthop routers boolean false
19171 .cindex "DSN" "success"
19172 .cindex "Delivery Status Notification" "success"
19173 If this option is set true, and extended DSN (RFC3461) processing is in effect,
19174 Exim will not pass on DSN requests to downstream DSN-aware hosts but will
19175 instead send a success DSN as if the next hop does not support DSN.
19176 Not effective on redirect routers.
19177
19178
19179
19180 .option errors_to routers string&!! unset
19181 .cindex "envelope from"
19182 .cindex "envelope sender"
19183 .cindex "router" "changing address for errors"
19184 If a router successfully handles an address, it may assign the address to a
19185 transport for delivery or it may generate child addresses. In both cases, if
19186 there is a delivery problem during later processing, the resulting bounce
19187 message is sent to the address that results from expanding this string,
19188 provided that the address verifies successfully. The &%errors_to%& option is
19189 expanded before &%headers_add%&, &%headers_remove%&, and &%transport%&.
19190
19191 The &%errors_to%& setting associated with an address can be overridden if it
19192 subsequently passes through other routers that have their own &%errors_to%&
19193 settings, or if the message is delivered by a transport with a &%return_path%&
19194 setting.
19195
19196 If &%errors_to%& is unset, or the expansion is forced to fail, or the result of
19197 the expansion fails to verify, the errors address associated with the incoming
19198 address is used. At top level, this is the envelope sender. A non-forced
19199 expansion failure causes delivery to be deferred.
19200
19201 If an address for which &%errors_to%& has been set ends up being delivered over
19202 SMTP, the envelope sender for that delivery is the &%errors_to%& value, so that
19203 any bounces that are generated by other MTAs on the delivery route are also
19204 sent there. You can set &%errors_to%& to the empty string by either of these
19205 settings:
19206 .code
19207 errors_to =
19208 errors_to = ""
19209 .endd
19210 An expansion item that yields an empty string has the same effect. If you do
19211 this, a locally detected delivery error for addresses processed by this router
19212 no longer gives rise to a bounce message; the error is discarded. If the
19213 address is delivered to a remote host, the return path is set to &`<>`&, unless
19214 overridden by the &%return_path%& option on the transport.
19215
19216 .vindex "&$address_data$&"
19217 If for some reason you want to discard local errors, but use a non-empty
19218 MAIL command for remote delivery, you can preserve the original return
19219 path in &$address_data$& in the router, and reinstate it in the transport by
19220 setting &%return_path%&.
19221
19222 The most common use of &%errors_to%& is to direct mailing list bounces to the
19223 manager of the list, as described in section &<<SECTmailinglists>>&, or to
19224 implement VERP (Variable Envelope Return Paths) (see section &<<SECTverp>>&).
19225
19226
19227
19228 .option expn routers&!? boolean true
19229 .cindex "address" "testing"
19230 .cindex "testing" "addresses"
19231 .cindex "EXPN" "router skipping"
19232 .cindex "router" "skipping for EXPN"
19233 If this option is turned off, the router is skipped when testing an address
19234 as a result of processing an SMTP EXPN command. You might, for example,
19235 want to turn it off on a router for users' &_.forward_& files, while leaving it
19236 on for the system alias file.
19237 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19238 are evaluated.
19239
19240 The use of the SMTP EXPN command is controlled by an ACL (see chapter
19241 &<<CHAPACL>>&). When Exim is running an EXPN command, it is similar to testing
19242 an address with &%-bt%&. Compare VRFY, whose counterpart is &%-bv%&.
19243
19244
19245
19246 .option fail_verify routers boolean false
19247 .cindex "router" "forcing verification failure"
19248 Setting this option has the effect of setting both &%fail_verify_sender%& and
19249 &%fail_verify_recipient%& to the same value.
19250
19251
19252
19253 .option fail_verify_recipient routers boolean false
19254 If this option is true and an address is accepted by this router when
19255 verifying a recipient, verification fails.
19256
19257
19258
19259 .option fail_verify_sender routers boolean false
19260 If this option is true and an address is accepted by this router when
19261 verifying a sender, verification fails.
19262
19263
19264
19265 .option fallback_hosts routers "string list" unset
19266 .cindex "router" "fallback hosts"
19267 .cindex "fallback" "hosts specified on router"
19268 String expansion is not applied to this option. The argument must be a
19269 colon-separated list of host names or IP addresses. The list separator can be
19270 changed (see section &<<SECTlistsepchange>>&), and a port can be specified with
19271 each name or address. In fact, the format of each item is exactly the same as
19272 defined for the list of hosts in a &(manualroute)& router (see section
19273 &<<SECTformatonehostitem>>&).
19274
19275 If a router queues an address for a remote transport, this host list is
19276 associated with the address, and used instead of the transport's fallback host
19277 list. If &%hosts_randomize%& is set on the transport, the order of the list is
19278 randomized for each use. See the &%fallback_hosts%& option of the &(smtp)&
19279 transport for further details.
19280
19281
19282 .option group routers string&!! "see below"
19283 .cindex "gid (group id)" "local delivery"
19284 .cindex "local transports" "uid and gid"
19285 .cindex "transport" "local"
19286 .cindex "router" "setting group"
19287 When a router queues an address for a transport, and the transport does not
19288 specify a group, the group given here is used when running the delivery
19289 process.
19290 The group may be specified numerically or by name. If expansion fails, the
19291 error is logged and delivery is deferred.
19292 The default is unset, unless &%check_local_user%& is set, when the default
19293 is taken from the password information. See also &%initgroups%& and &%user%&
19294 and the discussion in chapter &<<CHAPenvironment>>&.
19295
19296
19297
19298 .option headers_add routers list&!! unset
19299 .cindex "header lines" "adding"
19300 .cindex "router" "adding header lines"
19301 This option specifies a list of text headers,
19302 newline-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
19303 that is associated with any addresses that are accepted by the router.
19304 Each item is separately expanded, at routing time.  However, this
19305 option has no effect when an address is just being verified. The way in which
19306 the text is used to add header lines at transport time is described in section
19307 &<<SECTheadersaddrem>>&. New header lines are not actually added until the
19308 message is in the process of being transported. This means that references to
19309 header lines in string expansions in the transport's configuration do not
19310 &"see"& the added header lines.
19311
19312 The &%headers_add%& option is expanded after &%errors_to%&, but before
19313 &%headers_remove%& and &%transport%&. If an item is empty, or if
19314 an item expansion is forced to fail, the item has no effect. Other expansion
19315 failures are treated as configuration errors.
19316
19317 Unlike most options, &%headers_add%& can be specified multiple times
19318 for a router; all listed headers are added.
19319
19320 &*Warning 1*&: The &%headers_add%& option cannot be used for a &(redirect)&
19321 router that has the &%one_time%& option set.
19322
19323 .cindex "duplicate addresses"
19324 .oindex "&%unseen%&"
19325 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
19326 additions are deleted when the address is passed on to subsequent routers.
19327 For a &%redirect%& router, if a generated address is the same as the incoming
19328 address, this can lead to duplicate addresses with different header
19329 modifications. Exim does not do duplicate deliveries (except, in certain
19330 circumstances, to pipes -- see section &<<SECTdupaddr>>&), but it is undefined
19331 which of the duplicates is discarded, so this ambiguous situation should be
19332 avoided. The &%repeat_use%& option of the &%redirect%& router may be of help.
19333
19334
19335
19336 .option headers_remove routers list&!! unset
19337 .cindex "header lines" "removing"
19338 .cindex "router" "removing header lines"
19339 This option specifies a list of text headers,
19340 colon-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
19341 that is associated with any addresses that are accepted by the router.
19342 However, the option has no effect when an address is just being verified.
19343 Each list item is separately expanded, at transport time.
19344 If an item ends in *, it will match any header with the given prefix.
19345 The way in which
19346 the text is used to remove header lines at transport time is described in
19347 section &<<SECTheadersaddrem>>&. Header lines are not actually removed until
19348 the message is in the process of being transported. This means that references
19349 to header lines in string expansions in the transport's configuration still
19350 &"see"& the original header lines.
19351
19352 The &%headers_remove%& option is handled after &%errors_to%& and
19353 &%headers_add%&, but before &%transport%&. If an item expansion is forced to fail,
19354 the item has no effect. Other expansion failures are treated as configuration
19355 errors.
19356
19357 Unlike most options, &%headers_remove%& can be specified multiple times
19358 for a router; all listed headers are removed.
19359
19360 &*Warning 1*&: The &%headers_remove%& option cannot be used for a &(redirect)&
19361 router that has the &%one_time%& option set.
19362
19363 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
19364 removal requests are deleted when the address is passed on to subsequent
19365 routers, and this can lead to problems with duplicates -- see the similar
19366 warning for &%headers_add%& above.
19367
19368 &*Warning 3*&: Because of the separate expansion of the list items,
19369 items that contain a list separator must have it doubled.
19370 To avoid this, change the list separator (&<<SECTlistsepchange>>&).
19371
19372
19373
19374 .option ignore_target_hosts routers "host list&!!" unset
19375 .cindex "IP address" "discarding"
19376 .cindex "router" "discarding IP addresses"
19377 Although this option is a host list, it should normally contain IP address
19378 entries rather than names. If any host that is looked up by the router has an
19379 IP address that matches an item in this list, Exim behaves as if that IP
19380 address did not exist. This option allows you to cope with rogue DNS entries
19381 like
19382 .code
19383 remote.domain.example.  A  127.0.0.1
19384 .endd
19385 by setting
19386 .code
19387 ignore_target_hosts = 127.0.0.1
19388 .endd
19389 on the relevant router. If all the hosts found by a &(dnslookup)& router are
19390 discarded in this way, the router declines. In a conventional configuration, an
19391 attempt to mail to such a domain would normally provoke the &"unrouteable
19392 domain"& error, and an attempt to verify an address in the domain would fail.
19393 Similarly, if &%ignore_target_hosts%& is set on an &(ipliteral)& router, the
19394 router declines if presented with one of the listed addresses.
19395
19396 You can use this option to disable the use of IPv4 or IPv6 for mail delivery by
19397 means of the first or the second of the following settings, respectively:
19398 .code
19399 ignore_target_hosts = 0.0.0.0/0
19400 ignore_target_hosts = <; 0::0/0
19401 .endd
19402 The pattern in the first line matches all IPv4 addresses, whereas the pattern
19403 in the second line matches all IPv6 addresses.
19404
19405 This option may also be useful for ignoring link-local and site-local IPv6
19406 addresses. Because, like all host lists, the value of &%ignore_target_hosts%&
19407 is expanded before use as a list, it is possible to make it dependent on the
19408 domain that is being routed.
19409
19410 .vindex "&$host_address$&"
19411 During its expansion, &$host_address$& is set to the IP address that is being
19412 checked.
19413
19414 .option initgroups routers boolean false
19415 .cindex "additional groups"
19416 .cindex "groups" "additional"
19417 .cindex "local transports" "uid and gid"
19418 .cindex "transport" "local"
19419 If the router queues an address for a transport, and this option is true, and
19420 the uid supplied by the router is not overridden by the transport, the
19421 &[initgroups()]& function is called when running the transport to ensure that
19422 any additional groups associated with the uid are set up. See also &%group%&
19423 and &%user%& and the discussion in chapter &<<CHAPenvironment>>&.
19424
19425
19426
19427 .option local_part_prefix routers&!? "string list" unset
19428 .cindex affix "router precondition"
19429 .cindex "router" "prefix for local part"
19430 .cindex "prefix" "for local part, used in router"
19431 If this option is set, the router is skipped unless the local part starts with
19432 one of the given strings, or &%local_part_prefix_optional%& is true. See
19433 section &<<SECTrouprecon>>& for a list of the order in which preconditions are
19434 evaluated.
19435
19436 The list is scanned from left to right, and the first prefix that matches is
19437 used. A limited form of wildcard is available; if the prefix begins with an
19438 asterisk, it matches the longest possible sequence of arbitrary characters at
19439 the start of the local part. An asterisk should therefore always be followed by
19440 some character that does not occur in normal local parts.
19441 .cindex "multiple mailboxes"
19442 .cindex "mailbox" "multiple"
19443 Wildcarding can be used to set up multiple user mailboxes, as described in
19444 section &<<SECTmulbox>>&.
19445
19446 .vindex "&$local_part$&"
19447 .vindex "&$local_part_prefix$&"
19448 During the testing of the &%local_parts%& option, and while the router is
19449 running, the prefix is removed from the local part, and is available in the
19450 expansion variable &$local_part_prefix$&. When a message is being delivered, if
19451 the router accepts the address, this remains true during subsequent delivery by
19452 a transport. In particular, the local part that is transmitted in the RCPT
19453 command for LMTP, SMTP, and BSMTP deliveries has the prefix removed by default.
19454 This behaviour can be overridden by setting &%rcpt_include_affixes%& true on
19455 the relevant transport.
19456
19457 .vindex &$local_part_prefix_v$&
19458 If wildcarding (above) was used then the part of the prefix matching the
19459 wildcard is available in &$local_part_prefix_v$&.
19460
19461 When an address is being verified, &%local_part_prefix%& affects only the
19462 behaviour of the router. If the callout feature of verification is in use, this
19463 means that the full address, including the prefix, will be used during the
19464 callout.
19465
19466 The prefix facility is commonly used to handle local parts of the form
19467 &%owner-something%&. Another common use is to support local parts of the form
19468 &%real-username%& to bypass a user's &_.forward_& file &-- helpful when trying
19469 to tell a user their forwarding is broken &-- by placing a router like this one
19470 immediately before the router that handles &_.forward_& files:
19471 .code
19472 real_localuser:
19473   driver = accept
19474   local_part_prefix = real-
19475   check_local_user
19476   transport = local_delivery
19477 .endd
19478 For security, it would probably be a good idea to restrict the use of this
19479 router to locally-generated messages, using a condition such as this:
19480 .code
19481   condition = ${if match {$sender_host_address}\
19482                          {\N^(|127\.0\.0\.1)$\N}}
19483 .endd
19484
19485 If both &%local_part_prefix%& and &%local_part_suffix%& are set for a router,
19486 both conditions must be met if not optional. Care must be taken if wildcards
19487 are used in both a prefix and a suffix on the same router. Different
19488 separator characters must be used to avoid ambiguity.
19489
19490
19491 .option local_part_prefix_optional routers boolean false
19492 See &%local_part_prefix%& above.
19493
19494
19495
19496 .option local_part_suffix routers&!? "string list" unset
19497 .cindex "router" "suffix for local part"
19498 .cindex "suffix for local part" "used in router"
19499 This option operates in the same way as &%local_part_prefix%&, except that the
19500 local part must end (rather than start) with the given string, the
19501 &%local_part_suffix_optional%& option determines whether the suffix is
19502 mandatory, and the wildcard * character, if present, must be the last
19503 character of the suffix. This option facility is commonly used to handle local
19504 parts of the form &%something-request%& and multiple user mailboxes of the form
19505 &%username-foo%&.
19506
19507
19508 .option local_part_suffix_optional routers boolean false
19509 See &%local_part_suffix%& above.
19510
19511
19512
19513 .option local_parts routers&!? "local part list&!!" unset
19514 .cindex "router" "restricting to specific local parts"
19515 .cindex "local part" "checking in router"
19516 The router is run only if the local part of the address matches the list.
19517 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19518 are evaluated, and
19519 section &<<SECTlocparlis>>& for a discussion of local part lists. Because the
19520 string is expanded, it is possible to make it depend on the domain, for
19521 example:
19522 .code
19523 local_parts = dbm;/usr/local/specials/$domain_data
19524 .endd
19525 .vindex "&$local_part_data$&"
19526 If the match is achieved by a lookup, the data that the lookup returned
19527 for the local part is placed in the variable &$local_part_data$& for use in
19528 expansions of the router's private options or in the transport.
19529 You might use this option, for
19530 example, if you have a large number of local virtual domains, and you want to
19531 send all postmaster mail to the same place without having to set up an alias in
19532 each virtual domain:
19533 .code
19534 postmaster:
19535   driver = redirect
19536   local_parts = postmaster
19537   data = postmaster@real.domain.example
19538 .endd
19539
19540
19541 .option log_as_local routers boolean "see below"
19542 .cindex "log" "delivery line"
19543 .cindex "delivery" "log line format"
19544 Exim has two logging styles for delivery, the idea being to make local
19545 deliveries stand out more visibly from remote ones. In the &"local"& style, the
19546 recipient address is given just as the local part, without a domain. The use of
19547 this style is controlled by this option. It defaults to true for the &(accept)&
19548 router, and false for all the others. This option applies only when a
19549 router assigns an address to a transport. It has no effect on routers that
19550 redirect addresses.
19551
19552
19553
19554 .option more routers boolean&!! true
19555 The result of string expansion for this option must be a valid boolean value,
19556 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
19557 result causes an error, and delivery is deferred. If the expansion is forced to
19558 fail, the default value for the option (true) is used. Other failures cause
19559 delivery to be deferred.
19560
19561 If this option is set false, and the router declines to handle the address, no
19562 further routers are tried, routing fails, and the address is bounced.
19563 .oindex "&%self%&"
19564 However, if the router explicitly passes an address to the following router by
19565 means of the setting
19566 .code
19567 self = pass
19568 .endd
19569 or otherwise, the setting of &%more%& is ignored. Also, the setting of &%more%&
19570 does not affect the behaviour if one of the precondition tests fails. In that
19571 case, the address is always passed to the next router.
19572
19573 Note that &%address_data%& is not considered to be a precondition. If its
19574 expansion is forced to fail, the router declines, and the value of &%more%&
19575 controls what happens next.
19576
19577
19578 .option pass_on_timeout routers boolean false
19579 .cindex "timeout" "of router"
19580 .cindex "router" "timeout"
19581 If a router times out during a host lookup, it normally causes deferral of the
19582 address. If &%pass_on_timeout%& is set, the address is passed on to the next
19583 router, overriding &%no_more%&. This may be helpful for systems that are
19584 intermittently connected to the Internet, or those that want to pass to a smart
19585 host any messages that cannot immediately be delivered.
19586
19587 There are occasional other temporary errors that can occur while doing DNS
19588 lookups. They are treated in the same way as a timeout, and this option
19589 applies to all of them.
19590
19591
19592
19593 .option pass_router routers string unset
19594 .cindex "router" "go to after &""pass""&"
19595 Routers that recognize the generic &%self%& option (&(dnslookup)&,
19596 &(ipliteral)&, and &(manualroute)&) are able to return &"pass"&, forcing
19597 routing to continue, and overriding a false setting of &%more%&. When one of
19598 these routers returns &"pass"&, the address is normally handed on to the next
19599 router in sequence. This can be changed by setting &%pass_router%& to the name
19600 of another router. However (unlike &%redirect_router%&) the named router must
19601 be below the current router, to avoid loops. Note that this option applies only
19602 to the special case of &"pass"&. It does not apply when a router returns
19603 &"decline"& because it cannot handle an address.
19604
19605
19606
19607 .option redirect_router routers string unset
19608 .cindex "router" "start at after redirection"
19609 Sometimes an administrator knows that it is pointless to reprocess addresses
19610 generated from alias or forward files with the same router again. For
19611 example, if an alias file translates real names into login ids there is no
19612 point searching the alias file a second time, especially if it is a large file.
19613
19614 The &%redirect_router%& option can be set to the name of any router instance.
19615 It causes the routing of any generated addresses to start at the named router
19616 instead of at the first router. This option has no effect if the router in
19617 which it is set does not generate new addresses.
19618
19619
19620
19621 .option require_files routers&!? "string list&!!" unset
19622 .cindex "file" "requiring for router"
19623 .cindex "router" "requiring file existence"
19624 This option provides a general mechanism for predicating the running of a
19625 router on the existence or non-existence of certain files or directories.
19626 Before running a router, as one of its precondition tests, Exim works its way
19627 through the &%require_files%& list, expanding each item separately.
19628
19629 Because the list is split before expansion, any colons in expansion items must
19630 be doubled, or the facility for using a different list separator must be used
19631 (&<<SECTlistsepchange>>&).
19632 If any expansion is forced to fail, the item is ignored. Other expansion
19633 failures cause routing of the address to be deferred.
19634
19635 If any expanded string is empty, it is ignored. Otherwise, except as described
19636 below, each string must be a fully qualified file path, optionally preceded by
19637 &"!"&. The paths are passed to the &[stat()]& function to test for the
19638 existence of the files or directories. The router is skipped if any paths not
19639 preceded by &"!"& do not exist, or if any paths preceded by &"!"& do exist.
19640
19641 .cindex "NFS"
19642 If &[stat()]& cannot determine whether a file exists or not, delivery of
19643 the message is deferred. This can happen when NFS-mounted filesystems are
19644 unavailable.
19645
19646 This option is checked after the &%domains%&, &%local_parts%&, and &%senders%&
19647 options, so you cannot use it to check for the existence of a file in which to
19648 look up a domain, local part, or sender. (See section &<<SECTrouprecon>>& for a
19649 full list of the order in which preconditions are evaluated.) However, as
19650 these options are all expanded, you can use the &%exists%& expansion condition
19651 to make such tests. The &%require_files%& option is intended for checking files
19652 that the router may be going to use internally, or which are needed by a
19653 transport (e.g., &_.procmailrc_&).
19654
19655 During delivery, the &[stat()]& function is run as root, but there is a
19656 facility for some checking of the accessibility of a file by another user.
19657 This is not a proper permissions check, but just a &"rough"& check that
19658 operates as follows:
19659
19660 If an item in a &%require_files%& list does not contain any forward slash
19661 characters, it is taken to be the user (and optional group, separated by a
19662 comma) to be checked for subsequent files in the list. If no group is specified
19663 but the user is specified symbolically, the gid associated with the uid is
19664 used. For example:
19665 .code
19666 require_files = mail:/some/file
19667 require_files = $local_part_data:$home/.procmailrc
19668 .endd
19669 If a user or group name in a &%require_files%& list does not exist, the
19670 &%require_files%& condition fails.
19671
19672 Exim performs the check by scanning along the components of the file path, and
19673 checking the access for the given uid and gid. It checks for &"x"& access on
19674 directories, and &"r"& access on the final file. Note that this means that file
19675 access control lists, if the operating system has them, are ignored.
19676
19677 &*Warning 1*&: When the router is being run to verify addresses for an
19678 incoming SMTP message, Exim is not running as root, but under its own uid. This
19679 may affect the result of a &%require_files%& check. In particular, &[stat()]&
19680 may yield the error EACCES (&"Permission denied"&). This means that the Exim
19681 user is not permitted to read one of the directories on the file's path.
19682
19683 &*Warning 2*&: Even when Exim is running as root while delivering a message,
19684 &[stat()]& can yield EACCES for a file in an NFS directory that is mounted
19685 without root access. In this case, if a check for access by a particular user
19686 is requested, Exim creates a subprocess that runs as that user, and tries the
19687 check again in that process.
19688
19689 The default action for handling an unresolved EACCES is to consider it to
19690 be caused by a configuration error, and routing is deferred because the
19691 existence or non-existence of the file cannot be determined. However, in some
19692 circumstances it may be desirable to treat this condition as if the file did
19693 not exist. If the filename (or the exclamation mark that precedes the filename
19694 for non-existence) is preceded by a plus sign, the EACCES error is treated
19695 as if the file did not exist. For example:
19696 .code
19697 require_files = +/some/file
19698 .endd
19699 If the router is not an essential part of verification (for example, it
19700 handles users' &_.forward_& files), another solution is to set the &%verify%&
19701 option false so that the router is skipped when verifying.
19702
19703
19704
19705 .option retry_use_local_part routers boolean "see below"
19706 .cindex "hints database" "retry keys"
19707 .cindex "local part" "in retry keys"
19708 When a delivery suffers a temporary routing failure, a retry record is created
19709 in Exim's hints database. For addresses whose routing depends only on the
19710 domain, the key for the retry record should not involve the local part, but for
19711 other addresses, both the domain and the local part should be included.
19712 Usually, remote routing is of the former kind, and local routing is of the
19713 latter kind.
19714
19715 This option controls whether the local part is used to form the key for retry
19716 hints for addresses that suffer temporary errors while being handled by this
19717 router. The default value is true for any router that has any of
19718 &%check_local_user%&,
19719 &%local_parts%&,
19720 &%condition%&,
19721 &%local_part_prefix%&,
19722 &%local_part_suffix%&,
19723 &%senders%& or
19724 &%require_files%&
19725 set, and false otherwise. Note that this option does not apply to hints keys
19726 for transport delays; they are controlled by a generic transport option of the
19727 same name.
19728
19729 Failing to set this option when it is needed
19730 (because a remote router handles only some of the local-parts for a domain)
19731 can result in incorrect error messages being generated.
19732
19733 The setting of &%retry_use_local_part%& applies only to the router on which it
19734 appears. If the router generates child addresses, they are routed
19735 independently; this setting does not become attached to them.
19736
19737
19738
19739 .option router_home_directory routers string&!! unset
19740 .cindex "router" "home directory for"
19741 .cindex "home directory" "for router"
19742 .vindex "&$home$&"
19743 This option sets a home directory for use while the router is running. (Compare
19744 &%transport_home_directory%&, which sets a home directory for later
19745 transporting.) In particular, if used on a &(redirect)& router, this option
19746 sets a value for &$home$& while a filter is running. The value is expanded;
19747 forced expansion failure causes the option to be ignored &-- other failures
19748 cause the router to defer.
19749
19750 Expansion of &%router_home_directory%& happens immediately after the
19751 &%check_local_user%& test (if configured), before any further expansions take
19752 place.
19753 (See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19754 are evaluated.)
19755 While the router is running, &%router_home_directory%& overrides the value of
19756 &$home$& that came from &%check_local_user%&.
19757
19758 When a router accepts an address and assigns it to a local transport (including
19759 the cases when a &(redirect)& router generates a pipe, file, or autoreply
19760 delivery), the home directory setting for the transport is taken from the first
19761 of these values that is set:
19762
19763 .ilist
19764 The &%home_directory%& option on the transport;
19765 .next
19766 The &%transport_home_directory%& option on the router;
19767 .next
19768 The password data if &%check_local_user%& is set on the router;
19769 .next
19770 The &%router_home_directory%& option on the router.
19771 .endlist
19772
19773 In other words, &%router_home_directory%& overrides the password data for the
19774 router, but not for the transport.
19775
19776
19777
19778 .option self routers string freeze
19779 .cindex "MX record" "pointing to local host"
19780 .cindex "local host" "MX pointing to"
19781 This option applies to those routers that use a recipient address to find a
19782 list of remote hosts. Currently, these are the &(dnslookup)&, &(ipliteral)&,
19783 and &(manualroute)& routers.
19784 Certain configurations of the &(queryprogram)& router can also specify a list
19785 of remote hosts.
19786 Usually such routers are configured to send the message to a remote host via an
19787 &(smtp)& transport. The &%self%& option specifies what happens when the first
19788 host on the list turns out to be the local host.
19789 The way in which Exim checks for the local host is described in section
19790 &<<SECTreclocipadd>>&.
19791
19792 Normally this situation indicates either an error in Exim's configuration (for
19793 example, the router should be configured not to process this domain), or an
19794 error in the DNS (for example, the MX should not point to this host). For this
19795 reason, the default action is to log the incident, defer the address, and
19796 freeze the message. The following alternatives are provided for use in special
19797 cases:
19798
19799 .vlist
19800 .vitem &%defer%&
19801 Delivery of the message is tried again later, but the message is not frozen.
19802
19803 .vitem "&%reroute%&: <&'domain'&>"
19804 The domain is changed to the given domain, and the address is passed back to
19805 be reprocessed by the routers. No rewriting of headers takes place. This
19806 behaviour is essentially a redirection.
19807
19808 .vitem "&%reroute: rewrite:%& <&'domain'&>"
19809 The domain is changed to the given domain, and the address is passed back to be
19810 reprocessed by the routers. Any headers that contain the original domain are
19811 rewritten.
19812
19813 .vitem &%pass%&
19814 .oindex "&%more%&"
19815 .vindex "&$self_hostname$&"
19816 The router passes the address to the next router, or to the router named in the
19817 &%pass_router%& option if it is set. This overrides &%no_more%&. During
19818 subsequent routing and delivery, the variable &$self_hostname$& contains the
19819 name of the local host that the router encountered. This can be used to
19820 distinguish between different cases for hosts with multiple names. The
19821 combination
19822 .code
19823 self = pass
19824 no_more
19825 .endd
19826 ensures that only those addresses that routed to the local host are passed on.
19827 Without &%no_more%&, addresses that were declined for other reasons would also
19828 be passed to the next router.
19829
19830 .vitem &%fail%&
19831 Delivery fails and an error report is generated.
19832
19833 .vitem &%send%&
19834 .cindex "local host" "sending to"
19835 The anomaly is ignored and the address is queued for the transport. This
19836 setting should be used with extreme caution. For an &(smtp)& transport, it
19837 makes sense only in cases where the program that is listening on the SMTP port
19838 is not this version of Exim. That is, it must be some other MTA, or Exim with a
19839 different configuration file that handles the domain in another way.
19840 .endlist
19841
19842
19843
19844 .option senders routers&!? "address list&!!" unset
19845 .cindex "router" "checking senders"
19846 If this option is set, the router is skipped unless the message's sender
19847 address matches something on the list.
19848 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19849 are evaluated.
19850
19851 There are issues concerning verification when the running of routers is
19852 dependent on the sender. When Exim is verifying the address in an &%errors_to%&
19853 setting, it sets the sender to the null string. When using the &%-bt%& option
19854 to check a configuration file, it is necessary also to use the &%-f%& option to
19855 set an appropriate sender. For incoming mail, the sender is unset when
19856 verifying the sender, but is available when verifying any recipients. If the
19857 SMTP VRFY command is enabled, it must be used after MAIL if the sender address
19858 matters.
19859
19860
19861 .option set routers "string list" unset
19862 .cindex router variables
19863 This option may be used multiple times on a router;
19864 because of this the list aspect is mostly irrelevant.
19865 The list separator is a semicolon but can be changed in the
19866 usual way.
19867
19868 Each list-element given must be of the form &"name = value"&
19869 and the names used must start with the string &"r_"&.
19870 Values containing a list-separator should have them doubled.
19871 When a router runs, the strings are evaluated in order,
19872 to create variables which are added to the set associated with
19873 the address.
19874 .new
19875 This is done immediately after all the preconditions, before the
19876 evaluation of the &%address_data%& option.
19877 .wen
19878 The variable is set with the expansion of the value.
19879 The variables can be used by the router options
19880 (not including any preconditions)
19881 and by the transport.
19882 Later definitions of a given named variable will override former ones.
19883 Variable use is via the usual &$r_...$& syntax.
19884
19885 This is similar to the &%address_data%& option, except that
19886 many independent variables can be used, with choice of naming.
19887
19888
19889 .option translate_ip_address routers string&!! unset
19890 .cindex "IP address" "translating"
19891 .cindex "packet radio"
19892 .cindex "router" "IP address translation"
19893 There exist some rare networking situations (for example, packet radio) where
19894 it is helpful to be able to translate IP addresses generated by normal routing
19895 mechanisms into other IP addresses, thus performing a kind of manual IP
19896 routing. This should be done only if the normal IP routing of the TCP/IP stack
19897 is inadequate or broken. Because this is an extremely uncommon requirement, the
19898 code to support this option is not included in the Exim binary unless
19899 SUPPORT_TRANSLATE_IP_ADDRESS=yes is set in &_Local/Makefile_&.
19900
19901 .vindex "&$host_address$&"
19902 The &%translate_ip_address%& string is expanded for every IP address generated
19903 by the router, with the generated address set in &$host_address$&. If the
19904 expansion is forced to fail, no action is taken.
19905 For any other expansion error, delivery of the message is deferred.
19906 If the result of the expansion is an IP address, that replaces the original
19907 address; otherwise the result is assumed to be a host name &-- this is looked
19908 up using &[gethostbyname()]& (or &[getipnodebyname()]& when available) to
19909 produce one or more replacement IP addresses. For example, to subvert all IP
19910 addresses in some specific networks, this could be added to a router:
19911 .code
19912 translate_ip_address = \
19913   ${lookup{${mask:$host_address/26}}lsearch{/some/file}\
19914     {$value}fail}}
19915 .endd
19916 The file would contain lines like
19917 .code
19918 10.2.3.128/26    some.host
19919 10.8.4.34/26     10.44.8.15
19920 .endd
19921 You should not make use of this facility unless you really understand what you
19922 are doing.
19923
19924
19925
19926 .option transport routers string&!! unset
19927 This option specifies the transport to be used when a router accepts an address
19928 and sets it up for delivery. A transport is never needed if a router is used
19929 only for verification. The value of the option is expanded at routing time,
19930 after the expansion of &%errors_to%&, &%headers_add%&, and &%headers_remove%&,
19931 and result must be the name of one of the configured transports. If it is not,
19932 delivery is deferred.
19933
19934 The &%transport%& option is not used by the &(redirect)& router, but it does
19935 have some private options that set up transports for pipe and file deliveries
19936 (see chapter &<<CHAPredirect>>&).
19937
19938
19939
19940 .option transport_current_directory routers string&!! unset
19941 .cindex "current directory for local transport"
19942 This option associates a current directory with any address that is routed
19943 to a local transport. This can happen either because a transport is
19944 explicitly configured for the router, or because it generates a delivery to a
19945 file or a pipe. During the delivery process (that is, at transport time), this
19946 option string is expanded and is set as the current directory, unless
19947 overridden by a setting on the transport.
19948 If the expansion fails for any reason, including forced failure, an error is
19949 logged, and delivery is deferred.
19950 See chapter &<<CHAPenvironment>>& for details of the local delivery
19951 environment.
19952
19953
19954
19955
19956 .option transport_home_directory routers string&!! "see below"
19957 .cindex "home directory" "for local transport"
19958 This option associates a home directory with any address that is routed to a
19959 local transport. This can happen either because a transport is explicitly
19960 configured for the router, or because it generates a delivery to a file or a
19961 pipe. During the delivery process (that is, at transport time), the option
19962 string is expanded and is set as the home directory, unless overridden by a
19963 setting of &%home_directory%& on the transport.
19964 If the expansion fails for any reason, including forced failure, an error is
19965 logged, and delivery is deferred.
19966
19967 If the transport does not specify a home directory, and
19968 &%transport_home_directory%& is not set for the router, the home directory for
19969 the transport is taken from the password data if &%check_local_user%& is set for
19970 the router. Otherwise it is taken from &%router_home_directory%& if that option
19971 is set; if not, no home directory is set for the transport.
19972
19973 See chapter &<<CHAPenvironment>>& for further details of the local delivery
19974 environment.
19975
19976
19977
19978
19979 .option unseen routers boolean&!! false
19980 .cindex "router" "carrying on after success"
19981 The result of string expansion for this option must be a valid boolean value,
19982 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
19983 result causes an error, and delivery is deferred. If the expansion is forced to
19984 fail, the default value for the option (false) is used. Other failures cause
19985 delivery to be deferred.
19986
19987 When this option is set true, routing does not cease if the router accepts the
19988 address. Instead, a copy of the incoming address is passed to the next router,
19989 overriding a false setting of &%more%&. There is little point in setting
19990 &%more%& false if &%unseen%& is always true, but it may be useful in cases when
19991 the value of &%unseen%& contains expansion items (and therefore, presumably, is
19992 sometimes true and sometimes false).
19993
19994 .cindex "copy of message (&%unseen%& option)"
19995 Setting the &%unseen%& option has a similar effect to the &%unseen%& command
19996 qualifier in filter files. It can be used to cause copies of messages to be
19997 delivered to some other destination, while also carrying out a normal delivery.
19998 In effect, the current address is made into a &"parent"& that has two children
19999 &-- one that is delivered as specified by this router, and a clone that goes on
20000 to be routed further. For this reason, &%unseen%& may not be combined with the
20001 &%one_time%& option in a &(redirect)& router.
20002
20003 &*Warning*&: Header lines added to the address (or specified for removal) by
20004 this router or by previous routers affect the &"unseen"& copy of the message
20005 only. The clone that continues to be processed by further routers starts with
20006 no added headers and none specified for removal. For a &%redirect%& router, if
20007 a generated address is the same as the incoming address, this can lead to
20008 duplicate addresses with different header modifications. Exim does not do
20009 duplicate deliveries (except, in certain circumstances, to pipes -- see section
20010 &<<SECTdupaddr>>&), but it is undefined which of the duplicates is discarded,
20011 so this ambiguous situation should be avoided. The &%repeat_use%& option of the
20012 &%redirect%& router may be of help.
20013
20014 Unlike the handling of header modifications, any data that was set by the
20015 &%address_data%& option in the current or previous routers &'is'& passed on to
20016 subsequent routers.
20017
20018
20019 .option user routers string&!! "see below"
20020 .cindex "uid (user id)" "local delivery"
20021 .cindex "local transports" "uid and gid"
20022 .cindex "transport" "local"
20023 .cindex "router" "user for filter processing"
20024 .cindex "filter" "user for processing"
20025 When a router queues an address for a transport, and the transport does not
20026 specify a user, the user given here is used when running the delivery process.
20027 The user may be specified numerically or by name. If expansion fails, the
20028 error is logged and delivery is deferred.
20029 This user is also used by the &(redirect)& router when running a filter file.
20030 The default is unset, except when &%check_local_user%& is set. In this case,
20031 the default is taken from the password information. If the user is specified as
20032 a name, and &%group%& is not set, the group associated with the user is used.
20033 See also &%initgroups%& and &%group%& and the discussion in chapter
20034 &<<CHAPenvironment>>&.
20035
20036
20037
20038 .option verify routers&!? boolean true
20039 Setting this option has the effect of setting &%verify_sender%& and
20040 &%verify_recipient%& to the same value.
20041
20042
20043 .option verify_only routers&!? boolean false
20044 .cindex "EXPN" "with &%verify_only%&"
20045 .oindex "&%-bv%&"
20046 .cindex "router" "used only when verifying"
20047 If this option is set, the router is used only when verifying an address,
20048 delivering in cutthrough mode or
20049 testing with the &%-bv%& option, not when actually doing a delivery, testing
20050 with the &%-bt%& option, or running the SMTP EXPN command. It can be further
20051 restricted to verifying only senders or recipients by means of
20052 &%verify_sender%& and &%verify_recipient%&.
20053
20054 &*Warning*&: When the router is being run to verify addresses for an incoming
20055 SMTP message, Exim is not running as root, but under its own uid. If the router
20056 accesses any files, you need to make sure that they are accessible to the Exim
20057 user or group.
20058
20059
20060 .option verify_recipient routers&!? boolean true
20061 If this option is false, the router is skipped when verifying recipient
20062 addresses,
20063 delivering in cutthrough mode
20064 or testing recipient verification using &%-bv%&.
20065 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
20066 are evaluated.
20067 See also the &$verify_mode$& variable.
20068
20069
20070 .option verify_sender routers&!? boolean true
20071 If this option is false, the router is skipped when verifying sender addresses
20072 or testing sender verification using &%-bvs%&.
20073 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
20074 are evaluated.
20075 See also the &$verify_mode$& variable.
20076 .ecindex IIDgenoprou1
20077 .ecindex IIDgenoprou2
20078
20079
20080
20081
20082
20083
20084 . ////////////////////////////////////////////////////////////////////////////
20085 . ////////////////////////////////////////////////////////////////////////////
20086
20087 .chapter "The accept router" "CHID4"
20088 .cindex "&(accept)& router"
20089 .cindex "routers" "&(accept)&"
20090 The &(accept)& router has no private options of its own. Unless it is being
20091 used purely for verification (see &%verify_only%&) a transport is required to
20092 be defined by the generic &%transport%& option. If the preconditions that are
20093 specified by generic options are met, the router accepts the address and queues
20094 it for the given transport. The most common use of this router is for setting
20095 up deliveries to local mailboxes. For example:
20096 .code
20097 localusers:
20098   driver = accept
20099   domains = mydomain.example
20100   check_local_user
20101   transport = local_delivery
20102 .endd
20103 The &%domains%& condition in this example checks the domain of the address, and
20104 &%check_local_user%& checks that the local part is the login of a local user.
20105 When both preconditions are met, the &(accept)& router runs, and queues the
20106 address for the &(local_delivery)& transport.
20107
20108
20109
20110
20111
20112
20113 . ////////////////////////////////////////////////////////////////////////////
20114 . ////////////////////////////////////////////////////////////////////////////
20115
20116 .chapter "The dnslookup router" "CHAPdnslookup"
20117 .scindex IIDdnsrou1 "&(dnslookup)& router"
20118 .scindex IIDdnsrou2 "routers" "&(dnslookup)&"
20119 The &(dnslookup)& router looks up the hosts that handle mail for the
20120 recipient's domain in the DNS. A transport must always be set for this router,
20121 unless &%verify_only%& is set.
20122
20123 If SRV support is configured (see &%check_srv%& below), Exim first searches for
20124 SRV records. If none are found, or if SRV support is not configured,
20125 MX records are looked up. If no MX records exist, address records are sought.
20126 However, &%mx_domains%& can be set to disable the direct use of address
20127 records.
20128
20129 MX records of equal priority are sorted by Exim into a random order. Exim then
20130 looks for address records for the host names obtained from MX or SRV records.
20131 When a host has more than one IP address, they are sorted into a random order,
20132 except that IPv6 addresses are sorted before IPv4 addresses. If all the
20133 IP addresses found are discarded by a setting of the &%ignore_target_hosts%&
20134 generic option, the router declines.
20135
20136 Unless they have the highest priority (lowest MX value), MX records that point
20137 to the local host, or to any host name that matches &%hosts_treat_as_local%&,
20138 are discarded, together with any other MX records of equal or lower priority.
20139
20140 .cindex "MX record" "pointing to local host"
20141 .cindex "local host" "MX pointing to"
20142 .oindex "&%self%&" "in &(dnslookup)& router"
20143 If the host pointed to by the highest priority MX record, or looked up as an
20144 address record, is the local host, or matches &%hosts_treat_as_local%&, what
20145 happens is controlled by the generic &%self%& option.
20146
20147
20148 .section "Problems with DNS lookups" "SECTprowitdnsloo"
20149 There have been problems with DNS servers when SRV records are looked up.
20150 Some misbehaving servers return a DNS error or timeout when a non-existent
20151 SRV record is sought. Similar problems have in the past been reported for
20152 MX records. The global &%dns_again_means_nonexist%& option can help with this
20153 problem, but it is heavy-handed because it is a global option.
20154
20155 For this reason, there are two options, &%srv_fail_domains%& and
20156 &%mx_fail_domains%&, that control what happens when a DNS lookup in a
20157 &(dnslookup)& router results in a DNS failure or a &"try again"& response. If
20158 an attempt to look up an SRV or MX record causes one of these results, and the
20159 domain matches the relevant list, Exim behaves as if the DNS had responded &"no
20160 such record"&. In the case of an SRV lookup, this means that the router
20161 proceeds to look for MX records; in the case of an MX lookup, it proceeds to
20162 look for A or AAAA records, unless the domain matches &%mx_domains%&, in which
20163 case routing fails.
20164
20165
20166 .section "Declining addresses by dnslookup" "SECTdnslookupdecline"
20167 .cindex "&(dnslookup)& router" "declines"
20168 There are a few cases where a &(dnslookup)& router will decline to accept
20169 an address; if such a router is expected to handle "all remaining non-local
20170 domains", then it is important to set &%no_more%&.
20171
20172 The router will defer rather than decline if the domain
20173 is found in the &%fail_defer_domains%& router option.
20174
20175 Reasons for a &(dnslookup)& router to decline currently include:
20176 .ilist
20177 The domain does not exist in DNS
20178 .next
20179 The domain exists but the MX record's host part is just "."; this is a common
20180 convention (borrowed from SRV) used to indicate that there is no such service
20181 for this domain and to not fall back to trying A/AAAA records.
20182 .next
20183 Ditto, but for SRV records, when &%check_srv%& is set on this router.
20184 .next
20185 MX record points to a non-existent host.
20186 .next
20187 MX record points to an IP address and the main section option
20188 &%allow_mx_to_ip%& is not set.
20189 .next
20190 MX records exist and point to valid hosts, but all hosts resolve only to
20191 addresses blocked by the &%ignore_target_hosts%& generic option on this router.
20192 .next
20193 The domain is not syntactically valid (see also &%allow_utf8_domains%& and
20194 &%dns_check_names_pattern%& for handling one variant of this)
20195 .next
20196 &%check_secondary_mx%& is set on this router but the local host can
20197 not be found in the MX records (see below)
20198 .endlist
20199
20200
20201
20202
20203 .section "Private options for dnslookup" "SECID118"
20204 .cindex "options" "&(dnslookup)& router"
20205 The private options for the &(dnslookup)& router are as follows:
20206
20207 .option check_secondary_mx dnslookup boolean false
20208 .cindex "MX record" "checking for secondary"
20209 If this option is set, the router declines unless the local host is found in
20210 (and removed from) the list of hosts obtained by MX lookup. This can be used to
20211 process domains for which the local host is a secondary mail exchanger
20212 differently to other domains. The way in which Exim decides whether a host is
20213 the local host is described in section &<<SECTreclocipadd>>&.
20214
20215
20216 .option check_srv dnslookup string&!! unset
20217 .cindex "SRV record" "enabling use of"
20218 The &(dnslookup)& router supports the use of SRV records (see RFC 2782) in
20219 addition to MX and address records. The support is disabled by default. To
20220 enable SRV support, set the &%check_srv%& option to the name of the service
20221 required. For example,
20222 .code
20223 check_srv = smtp
20224 .endd
20225 looks for SRV records that refer to the normal smtp service. The option is
20226 expanded, so the service name can vary from message to message or address
20227 to address. This might be helpful if SRV records are being used for a
20228 submission service. If the expansion is forced to fail, the &%check_srv%&
20229 option is ignored, and the router proceeds to look for MX records in the
20230 normal way.
20231
20232 When the expansion succeeds, the router searches first for SRV records for
20233 the given service (it assumes TCP protocol). A single SRV record with a
20234 host name that consists of just a single dot indicates &"no such service for
20235 this domain"&; if this is encountered, the router declines. If other kinds of
20236 SRV record are found, they are used to construct a host list for delivery
20237 according to the rules of RFC 2782. MX records are not sought in this case.
20238
20239 When no SRV records are found, MX records (and address records) are sought in
20240 the traditional way. In other words, SRV records take precedence over MX
20241 records, just as MX records take precedence over address records. Note that
20242 this behaviour is not sanctioned by RFC 2782, though a previous draft RFC
20243 defined it. It is apparently believed that MX records are sufficient for email
20244 and that SRV records should not be used for this purpose. However, SRV records
20245 have an additional &"weight"& feature which some people might find useful when
20246 trying to split an SMTP load between hosts of different power.
20247
20248 See section &<<SECTprowitdnsloo>>& above for a discussion of Exim's behaviour
20249 when there is a DNS lookup error.
20250
20251
20252
20253
20254 .option fail_defer_domains dnslookup "domain list&!!" unset
20255 .cindex "MX record" "not found"
20256 DNS lookups for domains matching &%fail_defer_domains%&
20257 which find no matching record will cause the router to defer
20258 rather than the default behaviour of decline.
20259 This maybe be useful for queueing messages for a newly created
20260 domain while the DNS configuration is not ready.
20261 However, it will result in any message with mistyped domains
20262 also being queued.
20263
20264
20265 .option ipv4_only "string&!!" unset
20266 .cindex IPv6 disabling
20267 .cindex DNS "IPv6 disabling"
20268 The string is expanded, and if the result is anything but a forced failure,
20269 or an empty string, or one of the strings “0” or “no” or “false”
20270 (checked without regard to the case of the letters),
20271 only A records are used.
20272
20273 .option ipv4_prefer "string&!!" unset
20274 .cindex IPv4 preference
20275 .cindex DNS "IPv4 preference"
20276 The string is expanded, and if the result is anything but a forced failure,
20277 or an empty string, or one of the strings “0” or “no” or “false”
20278 (checked without regard to the case of the letters),
20279 A records are sorted before AAAA records (inverting the default).
20280
20281 .option mx_domains dnslookup "domain list&!!" unset
20282 .cindex "MX record" "required to exist"
20283 .cindex "SRV record" "required to exist"
20284 A domain that matches &%mx_domains%& is required to have either an MX or an SRV
20285 record in order to be recognized. (The name of this option could be improved.)
20286 For example, if all the mail hosts in &'fict.example'& are known to have MX
20287 records, except for those in &'discworld.fict.example'&, you could use this
20288 setting:
20289 .code
20290 mx_domains = ! *.discworld.fict.example : *.fict.example
20291 .endd
20292 This specifies that messages addressed to a domain that matches the list but
20293 has no MX record should be bounced immediately instead of being routed using
20294 the address record.
20295
20296
20297 .option mx_fail_domains dnslookup "domain list&!!" unset
20298 If the DNS lookup for MX records for one of the domains in this list causes a
20299 DNS lookup error, Exim behaves as if no MX records were found. See section
20300 &<<SECTprowitdnsloo>>& for more discussion.
20301
20302
20303
20304
20305 .option qualify_single dnslookup boolean true
20306 .cindex "DNS" "resolver options"
20307 .cindex "DNS" "qualifying single-component names"
20308 When this option is true, the resolver option RES_DEFNAMES is set for DNS
20309 lookups. Typically, but not standardly, this causes the resolver to qualify
20310 single-component names with the default domain. For example, on a machine
20311 called &'dictionary.ref.example'&, the domain &'thesaurus'& would be changed to
20312 &'thesaurus.ref.example'& inside the resolver. For details of what your
20313 resolver actually does, consult your man pages for &'resolver'& and
20314 &'resolv.conf'&.
20315
20316
20317
20318 .option rewrite_headers dnslookup boolean true
20319 .cindex "rewriting" "header lines"
20320 .cindex "header lines" "rewriting"
20321 If the domain name in the address that is being processed is not fully
20322 qualified, it may be expanded to its full form by a DNS lookup. For example, if
20323 an address is specified as &'dormouse@teaparty'&, the domain might be
20324 expanded to &'teaparty.wonderland.fict.example'&. Domain expansion can also
20325 occur as a result of setting the &%widen_domains%& option. If
20326 &%rewrite_headers%& is true, all occurrences of the abbreviated domain name in
20327 any &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-to:'&, &'Sender:'&, and &'To:'&
20328 header lines of the message are rewritten with the full domain name.
20329
20330 This option should be turned off only when it is known that no message is
20331 ever going to be sent outside an environment where the abbreviation makes
20332 sense.
20333
20334 When an MX record is looked up in the DNS and matches a wildcard record, name
20335 servers normally return a record containing the name that has been looked up,
20336 making it impossible to detect whether a wildcard was present or not. However,
20337 some name servers have recently been seen to return the wildcard entry. If the
20338 name returned by a DNS lookup begins with an asterisk, it is not used for
20339 header rewriting.
20340
20341
20342 .option same_domain_copy_routing dnslookup boolean false
20343 .cindex "address" "copying routing"
20344 Addresses with the same domain are normally routed by the &(dnslookup)& router
20345 to the same list of hosts. However, this cannot be presumed, because the router
20346 options and preconditions may refer to the local part of the address. By
20347 default, therefore, Exim routes each address in a message independently. DNS
20348 servers run caches, so repeated DNS lookups are not normally expensive, and in
20349 any case, personal messages rarely have more than a few recipients.
20350
20351 If you are running mailing lists with large numbers of subscribers at the same
20352 domain, and you are using a &(dnslookup)& router which is independent of the
20353 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
20354 lookups for identical domains in one message. In this case, when &(dnslookup)&
20355 routes an address to a remote transport, any other unrouted addresses in the
20356 message that have the same domain are automatically given the same routing
20357 without processing them independently,
20358 provided the following conditions are met:
20359
20360 .ilist
20361 No router that processed the address specified &%headers_add%& or
20362 &%headers_remove%&.
20363 .next
20364 The router did not change the address in any way, for example, by &"widening"&
20365 the domain.
20366 .endlist
20367
20368
20369
20370
20371 .option search_parents dnslookup boolean false
20372 .cindex "DNS" "resolver options"
20373 When this option is true, the resolver option RES_DNSRCH is set for DNS
20374 lookups. This is different from the &%qualify_single%& option in that it
20375 applies to domains containing dots. Typically, but not standardly, it causes
20376 the resolver to search for the name in the current domain and in parent
20377 domains. For example, on a machine in the &'fict.example'& domain, if looking
20378 up &'teaparty.wonderland'& failed, the resolver would try
20379 &'teaparty.wonderland.fict.example'&. For details of what your resolver
20380 actually does, consult your man pages for &'resolver'& and &'resolv.conf'&.
20381
20382 Setting this option true can cause problems in domains that have a wildcard MX
20383 record, because any domain that does not have its own MX record matches the
20384 local wildcard.
20385
20386
20387
20388 .option srv_fail_domains dnslookup "domain list&!!" unset
20389 If the DNS lookup for SRV records for one of the domains in this list causes a
20390 DNS lookup error, Exim behaves as if no SRV records were found. See section
20391 &<<SECTprowitdnsloo>>& for more discussion.
20392
20393
20394
20395
20396 .option widen_domains dnslookup "string list" unset
20397 .cindex "domain" "partial; widening"
20398 If a DNS lookup fails and this option is set, each of its strings in turn is
20399 added onto the end of the domain, and the lookup is tried again. For example,
20400 if
20401 .code
20402 widen_domains = fict.example:ref.example
20403 .endd
20404 is set and a lookup of &'klingon.dictionary'& fails,
20405 &'klingon.dictionary.fict.example'& is looked up, and if this fails,
20406 &'klingon.dictionary.ref.example'& is tried. Note that the &%qualify_single%&
20407 and &%search_parents%& options can cause some widening to be undertaken inside
20408 the DNS resolver. &%widen_domains%& is not applied to sender addresses
20409 when verifying, unless &%rewrite_headers%& is false (not the default).
20410
20411
20412 .section "Effect of qualify_single and search_parents" "SECID119"
20413 When a domain from an envelope recipient is changed by the resolver as a result
20414 of the &%qualify_single%& or &%search_parents%& options, Exim rewrites the
20415 corresponding address in the message's header lines unless &%rewrite_headers%&
20416 is set false. Exim then re-routes the address, using the full domain.
20417
20418 These two options affect only the DNS lookup that takes place inside the router
20419 for the domain of the address that is being routed. They do not affect lookups
20420 such as that implied by
20421 .code
20422 domains = @mx_any
20423 .endd
20424 that may happen while processing a router precondition before the router is
20425 entered. No widening ever takes place for these lookups.
20426 .ecindex IIDdnsrou1
20427 .ecindex IIDdnsrou2
20428
20429
20430
20431
20432
20433
20434
20435
20436
20437 . ////////////////////////////////////////////////////////////////////////////
20438 . ////////////////////////////////////////////////////////////////////////////
20439
20440 .chapter "The ipliteral router" "CHID5"
20441 .cindex "&(ipliteral)& router"
20442 .cindex "domain literal" "routing"
20443 .cindex "routers" "&(ipliteral)&"
20444 This router has no private options. Unless it is being used purely for
20445 verification (see &%verify_only%&) a transport is required to be defined by the
20446 generic &%transport%& option. The router accepts the address if its domain part
20447 takes the form of an RFC 2822 domain literal. For example, the &(ipliteral)&
20448 router handles the address
20449 .code
20450 root@[192.168.1.1]
20451 .endd
20452 by setting up delivery to the host with that IP address. IPv4 domain literals
20453 consist of an IPv4 address enclosed in square brackets. IPv6 domain literals
20454 are similar, but the address is preceded by &`ipv6:`&. For example:
20455 .code
20456 postmaster@[ipv6:fe80::a00:20ff:fe86:a061.5678]
20457 .endd
20458 Exim allows &`ipv4:`& before IPv4 addresses, for consistency, and on the
20459 grounds that sooner or later somebody will try it.
20460
20461 .oindex "&%self%&" "in &(ipliteral)& router"
20462 If the IP address matches something in &%ignore_target_hosts%&, the router
20463 declines. If an IP literal turns out to refer to the local host, the generic
20464 &%self%& option determines what happens.
20465
20466 The RFCs require support for domain literals; however, their use is
20467 controversial in today's Internet. If you want to use this router, you must
20468 also set the main configuration option &%allow_domain_literals%&. Otherwise,
20469 Exim will not recognize the domain literal syntax in addresses.
20470
20471
20472
20473 . ////////////////////////////////////////////////////////////////////////////
20474 . ////////////////////////////////////////////////////////////////////////////
20475
20476 .chapter "The iplookup router" "CHID6"
20477 .cindex "&(iplookup)& router"
20478 .cindex "routers" "&(iplookup)&"
20479 The &(iplookup)& router was written to fulfil a specific requirement in
20480 Cambridge University (which in fact no longer exists). For this reason, it is
20481 not included in the binary of Exim by default. If you want to include it, you
20482 must set
20483 .code
20484 ROUTER_IPLOOKUP=yes
20485 .endd
20486 in your &_Local/Makefile_& configuration file.
20487
20488 The &(iplookup)& router routes an address by sending it over a TCP or UDP
20489 connection to one or more specific hosts. The host can then return the same or
20490 a different address &-- in effect rewriting the recipient address in the
20491 message's envelope. The new address is then passed on to subsequent routers. If
20492 this process fails, the address can be passed on to other routers, or delivery
20493 can be deferred. Since &(iplookup)& is just a rewriting router, a transport
20494 must not be specified for it.
20495
20496 .cindex "options" "&(iplookup)& router"
20497 .option hosts iplookup string unset
20498 This option must be supplied. Its value is a colon-separated list of host
20499 names. The hosts are looked up using &[gethostbyname()]&
20500 (or &[getipnodebyname()]& when available)
20501 and are tried in order until one responds to the query. If none respond, what
20502 happens is controlled by &%optional%&.
20503
20504
20505 .option optional iplookup boolean false
20506 If &%optional%& is true, if no response is obtained from any host, the address
20507 is passed to the next router, overriding &%no_more%&. If &%optional%& is false,
20508 delivery to the address is deferred.
20509
20510
20511 .option port iplookup integer 0
20512 .cindex "port" "&(iplookup)& router"
20513 This option must be supplied. It specifies the port number for the TCP or UDP
20514 call.
20515
20516
20517 .option protocol iplookup string udp
20518 This option can be set to &"udp"& or &"tcp"& to specify which of the two
20519 protocols is to be used.
20520
20521
20522 .option query iplookup string&!! "see below"
20523 This defines the content of the query that is sent to the remote hosts. The
20524 default value is:
20525 .code
20526 $local_part@$domain $local_part@$domain
20527 .endd
20528 The repetition serves as a way of checking that a response is to the correct
20529 query in the default case (see &%response_pattern%& below).
20530
20531
20532 .option reroute iplookup string&!! unset
20533 If this option is not set, the rerouted address is precisely the byte string
20534 returned by the remote host, up to the first white space, if any. If set, the
20535 string is expanded to form the rerouted address. It can include parts matched
20536 in the response by &%response_pattern%& by means of numeric variables such as
20537 &$1$&, &$2$&, etc. The variable &$0$& refers to the entire input string,
20538 whether or not a pattern is in use. In all cases, the rerouted address must end
20539 up in the form &'local_part@domain'&.
20540
20541
20542 .option response_pattern iplookup string unset
20543 This option can be set to a regular expression that is applied to the string
20544 returned from the remote host. If the pattern does not match the response, the
20545 router declines. If &%response_pattern%& is not set, no checking of the
20546 response is done, unless the query was defaulted, in which case there is a
20547 check that the text returned after the first white space is the original
20548 address. This checks that the answer that has been received is in response to
20549 the correct question. For example, if the response is just a new domain, the
20550 following could be used:
20551 .code
20552 response_pattern = ^([^@]+)$
20553 reroute = $local_part@$1
20554 .endd
20555
20556 .option timeout iplookup time 5s
20557 This specifies the amount of time to wait for a response from the remote
20558 machine. The same timeout is used for the &[connect()]& function for a TCP
20559 call. It does not apply to UDP.
20560
20561
20562
20563
20564 . ////////////////////////////////////////////////////////////////////////////
20565 . ////////////////////////////////////////////////////////////////////////////
20566
20567 .chapter "The manualroute router" "CHID7"
20568 .scindex IIDmanrou1 "&(manualroute)& router"
20569 .scindex IIDmanrou2 "routers" "&(manualroute)&"
20570 .cindex "domain" "manually routing"
20571 The &(manualroute)& router is so-called because it provides a way of manually
20572 routing an address according to its domain. It is mainly used when you want to
20573 route addresses to remote hosts according to your own rules, bypassing the
20574 normal DNS routing that looks up MX records. However, &(manualroute)& can also
20575 route to local transports, a facility that may be useful if you want to save
20576 messages for dial-in hosts in local files.
20577
20578 The &(manualroute)& router compares a list of domain patterns with the domain
20579 it is trying to route. If there is no match, the router declines. Each pattern
20580 has associated with it a list of hosts and some other optional data, which may
20581 include a transport. The combination of a pattern and its data is called a
20582 &"routing rule"&. For patterns that do not have an associated transport, the
20583 generic &%transport%& option must specify a transport, unless the router is
20584 being used purely for verification (see &%verify_only%&).
20585
20586 .vindex "&$host$&"
20587 In the case of verification, matching the domain pattern is sufficient for the
20588 router to accept the address. When actually routing an address for delivery,
20589 an address that matches a domain pattern is queued for the associated
20590 transport. If the transport is not a local one, a host list must be associated
20591 with the pattern; IP addresses are looked up for the hosts, and these are
20592 passed to the transport along with the mail address. For local transports, a
20593 host list is optional. If it is present, it is passed in &$host$& as a single
20594 text string.
20595
20596 The list of routing rules can be provided as an inline string in
20597 &%route_list%&, or the data can be obtained by looking up the domain in a file
20598 or database by setting &%route_data%&. Only one of these settings may appear in
20599 any one instance of &(manualroute)&. The format of routing rules is described
20600 below, following the list of private options.
20601
20602
20603 .section "Private options for manualroute" "SECTprioptman"
20604
20605 .cindex "options" "&(manualroute)& router"
20606 The private options for the &(manualroute)& router are as follows:
20607
20608 .option host_all_ignored manualroute string defer
20609 See &%host_find_failed%&.
20610
20611 .option host_find_failed manualroute string freeze
20612 This option controls what happens when &(manualroute)& tries to find an IP
20613 address for a host, and the host does not exist. The option can be set to one
20614 of the following values:
20615 .code
20616 decline
20617 defer
20618 fail
20619 freeze
20620 ignore
20621 pass
20622 .endd
20623 The default (&"freeze"&) assumes that this state is a serious configuration
20624 error. The difference between &"pass"& and &"decline"& is that the former
20625 forces the address to be passed to the next router (or the router defined by
20626 &%pass_router%&),
20627 .oindex "&%more%&"
20628 overriding &%no_more%&, whereas the latter passes the address to the next
20629 router only if &%more%& is true.
20630
20631 The value &"ignore"& causes Exim to completely ignore a host whose IP address
20632 cannot be found. If all the hosts in the list are ignored, the behaviour is
20633 controlled by the &%host_all_ignored%& option. This takes the same values
20634 as &%host_find_failed%&, except that it cannot be set to &"ignore"&.
20635
20636 The &%host_find_failed%& option applies only to a definite &"does not exist"&
20637 state; if a host lookup gets a temporary error, delivery is deferred unless the
20638 generic &%pass_on_timeout%& option is set.
20639
20640
20641 .option hosts_randomize manualroute boolean false
20642 .cindex "randomized host list"
20643 .cindex "host" "list of; randomized"
20644 If this option is set, the order of the items in a host list in a routing rule
20645 is randomized each time the list is used, unless an option in the routing rule
20646 overrides (see below). Randomizing the order of a host list can be used to do
20647 crude load sharing. However, if more than one mail address is routed by the
20648 same router to the same host list, the host lists are considered to be the same
20649 (even though they may be randomized into different orders) for the purpose of
20650 deciding whether to batch the deliveries into a single SMTP transaction.
20651
20652 When &%hosts_randomize%& is true, a host list may be split
20653 into groups whose order is separately randomized. This makes it possible to
20654 set up MX-like behaviour. The boundaries between groups are indicated by an
20655 item that is just &`+`& in the host list. For example:
20656 .code
20657 route_list = * host1:host2:host3:+:host4:host5
20658 .endd
20659 The order of the first three hosts and the order of the last two hosts is
20660 randomized for each use, but the first three always end up before the last two.
20661 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored. If a
20662 randomized host list is passed to an &(smtp)& transport that also has
20663 &%hosts_randomize set%&, the list is not re-randomized.
20664
20665
20666 .option route_data manualroute string&!! unset
20667 If this option is set, it must expand to yield the data part of a routing rule.
20668 Typically, the expansion string includes a lookup based on the domain. For
20669 example:
20670 .code
20671 route_data = ${lookup{$domain}dbm{/etc/routes}}
20672 .endd
20673 If the expansion is forced to fail, or the result is an empty string, the
20674 router declines. Other kinds of expansion failure cause delivery to be
20675 deferred.
20676
20677
20678 .option route_list manualroute "string list" unset
20679 This string is a list of routing rules, in the form defined below. Note that,
20680 unlike most string lists, the items are separated by semicolons. This is so
20681 that they may contain colon-separated host lists.
20682
20683
20684 .option same_domain_copy_routing manualroute boolean false
20685 .cindex "address" "copying routing"
20686 Addresses with the same domain are normally routed by the &(manualroute)&
20687 router to the same list of hosts. However, this cannot be presumed, because the
20688 router options and preconditions may refer to the local part of the address. By
20689 default, therefore, Exim routes each address in a message independently. DNS
20690 servers run caches, so repeated DNS lookups are not normally expensive, and in
20691 any case, personal messages rarely have more than a few recipients.
20692
20693 If you are running mailing lists with large numbers of subscribers at the same
20694 domain, and you are using a &(manualroute)& router which is independent of the
20695 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
20696 lookups for identical domains in one message. In this case, when
20697 &(manualroute)& routes an address to a remote transport, any other unrouted
20698 addresses in the message that have the same domain are automatically given the
20699 same routing without processing them independently. However, this is only done
20700 if &%headers_add%& and &%headers_remove%& are unset.
20701
20702
20703
20704
20705 .section "Routing rules in route_list" "SECID120"
20706 The value of &%route_list%& is a string consisting of a sequence of routing
20707 rules, separated by semicolons. If a semicolon is needed in a rule, it can be
20708 entered as two semicolons. Alternatively, the list separator can be changed as
20709 described (for colon-separated lists) in section &<<SECTlistconstruct>>&.
20710 Empty rules are ignored. The format of each rule is
20711 .display
20712 <&'domain pattern'&>  <&'list of hosts'&>  <&'options'&>
20713 .endd
20714 The following example contains two rules, each with a simple domain pattern and
20715 no options:
20716 .code
20717 route_list = \
20718   dict.ref.example  mail-1.ref.example:mail-2.ref.example ; \
20719   thes.ref.example  mail-3.ref.example:mail-4.ref.example
20720 .endd
20721 The three parts of a rule are separated by white space. The pattern and the
20722 list of hosts can be enclosed in quotes if necessary, and if they are, the
20723 usual quoting rules apply. Each rule in a &%route_list%& must start with a
20724 single domain pattern, which is the only mandatory item in the rule. The
20725 pattern is in the same format as one item in a domain list (see section
20726 &<<SECTdomainlist>>&),
20727 except that it may not be the name of an interpolated file.
20728 That is, it may be wildcarded, or a regular expression, or a file or database
20729 lookup (with semicolons doubled, because of the use of semicolon as a separator
20730 in a &%route_list%&).
20731
20732 The rules in &%route_list%& are searched in order until one of the patterns
20733 matches the domain that is being routed. The list of hosts and then options are
20734 then used as described below. If there is no match, the router declines. When
20735 &%route_list%& is set, &%route_data%& must not be set.
20736
20737
20738
20739 .section "Routing rules in route_data" "SECID121"
20740 The use of &%route_list%& is convenient when there are only a small number of
20741 routing rules. For larger numbers, it is easier to use a file or database to
20742 hold the routing information, and use the &%route_data%& option instead.
20743 The value of &%route_data%& is a list of hosts, followed by (optional) options.
20744 Most commonly, &%route_data%& is set as a string that contains an
20745 expansion lookup. For example, suppose we place two routing rules in a file
20746 like this:
20747 .code
20748 dict.ref.example:  mail-1.ref.example:mail-2.ref.example
20749 thes.ref.example:  mail-3.ref.example:mail-4.ref.example
20750 .endd
20751 This data can be accessed by setting
20752 .code
20753 route_data = ${lookup{$domain}lsearch{/the/file/name}}
20754 .endd
20755 Failure of the lookup results in an empty string, causing the router to
20756 decline. However, you do not have to use a lookup in &%route_data%&. The only
20757 requirement is that the result of expanding the string is a list of hosts,
20758 possibly followed by options, separated by white space. The list of hosts must
20759 be enclosed in quotes if it contains white space.
20760
20761
20762
20763
20764 .section "Format of the list of hosts" "SECID122"
20765 A list of hosts, whether obtained via &%route_data%& or &%route_list%&, is
20766 always separately expanded before use. If the expansion fails, the router
20767 declines. The result of the expansion must be a colon-separated list of names
20768 and/or IP addresses, optionally also including ports.
20769 If the list is written with spaces, it must be protected with quotes.
20770 The format of each item
20771 in the list is described in the next section. The list separator can be changed
20772 as described in section &<<SECTlistsepchange>>&.
20773
20774 If the list of hosts was obtained from a &%route_list%& item, the following
20775 variables are set during its expansion:
20776
20777 .ilist
20778 .cindex "numerical variables (&$1$& &$2$&  etc)" "in &(manualroute)& router"
20779 If the domain was matched against a regular expression, the numeric variables
20780 &$1$&, &$2$&, etc. may be set. For example:
20781 .code
20782 route_list = ^domain(\d+)   host-$1.text.example
20783 .endd
20784 .next
20785 &$0$& is always set to the entire domain.
20786 .next
20787 &$1$& is also set when partial matching is done in a file lookup.
20788
20789 .next
20790 .vindex "&$value$&"
20791 If the pattern that matched the domain was a lookup item, the data that was
20792 looked up is available in the expansion variable &$value$&. For example:
20793 .code
20794 route_list = lsearch;;/some/file.routes  $value
20795 .endd
20796 .endlist
20797
20798 Note the doubling of the semicolon in the pattern that is necessary because
20799 semicolon is the default route list separator.
20800
20801
20802
20803 .section "Format of one host item" "SECTformatonehostitem"
20804 Each item in the list of hosts can be either a host name or an IP address,
20805 optionally with an attached port number, or it can be a single "+"
20806 (see &%hosts_randomize%&).
20807 When no port is given, an IP address
20808 is not enclosed in brackets. When a port is specified, it overrides the port
20809 specification on the transport. The port is separated from the name or address
20810 by a colon. This leads to some complications:
20811
20812 .ilist
20813 Because colon is the default separator for the list of hosts, either
20814 the colon that specifies a port must be doubled, or the list separator must
20815 be changed. The following two examples have the same effect:
20816 .code
20817 route_list = * "host1.tld::1225 : host2.tld::1226"
20818 route_list = * "<+ host1.tld:1225 + host2.tld:1226"
20819 .endd
20820 .next
20821 When IPv6 addresses are involved, it gets worse, because they contain
20822 colons of their own. To make this case easier, it is permitted to
20823 enclose an IP address (either v4 or v6) in square brackets if a port
20824 number follows. For example:
20825 .code
20826 route_list = * "</ [10.1.1.1]:1225 / [::1]:1226"
20827 .endd
20828 .endlist
20829
20830 .section "How the list of hosts is used" "SECThostshowused"
20831 When an address is routed to an &(smtp)& transport by &(manualroute)&, each of
20832 the hosts is tried, in the order specified, when carrying out the SMTP
20833 delivery. However, the order can be changed by setting the &%hosts_randomize%&
20834 option, either on the router (see section &<<SECTprioptman>>& above), or on the
20835 transport.
20836
20837 Hosts may be listed by name or by IP address. An unadorned name in the list of
20838 hosts is interpreted as a host name. A name that is followed by &`/MX`& is
20839 interpreted as an indirection to a sublist of hosts obtained by looking up MX
20840 records in the DNS. For example:
20841 .code
20842 route_list = *  x.y.z:p.q.r/MX:e.f.g
20843 .endd
20844 If this feature is used with a port specifier, the port must come last. For
20845 example:
20846 .code
20847 route_list = *  dom1.tld/mx::1225
20848 .endd
20849 If the &%hosts_randomize%& option is set, the order of the items in the list is
20850 randomized before any lookups are done. Exim then scans the list; for any name
20851 that is not followed by &`/MX`& it looks up an IP address. If this turns out to
20852 be an interface on the local host and the item is not the first in the list,
20853 Exim discards it and any subsequent items. If it is the first item, what
20854 happens is controlled by the
20855 .oindex "&%self%&" "in &(manualroute)& router"
20856 &%self%& option of the router.
20857
20858 A name on the list that is followed by &`/MX`& is replaced with the list of
20859 hosts obtained by looking up MX records for the name. This is always a DNS
20860 lookup; the &%bydns%& and &%byname%& options (see section &<<SECThowoptused>>&
20861 below) are not relevant here. The order of these hosts is determined by the
20862 preference values in the MX records, according to the usual rules. Because
20863 randomizing happens before the MX lookup, it does not affect the order that is
20864 defined by MX preferences.
20865
20866 If the local host is present in the sublist obtained from MX records, but is
20867 not the most preferred host in that list, it and any equally or less
20868 preferred hosts are removed before the sublist is inserted into the main list.
20869
20870 If the local host is the most preferred host in the MX list, what happens
20871 depends on where in the original list of hosts the &`/MX`& item appears. If it
20872 is not the first item (that is, there are previous hosts in the main list),
20873 Exim discards this name and any subsequent items in the main list.
20874
20875 If the MX item is first in the list of hosts, and the local host is the
20876 most preferred host, what happens is controlled by the &%self%& option of the
20877 router.
20878
20879 DNS failures when lookup up the MX records are treated in the same way as DNS
20880 failures when looking up IP addresses: &%pass_on_timeout%& and
20881 &%host_find_failed%& are used when relevant.
20882
20883 The generic &%ignore_target_hosts%& option applies to all hosts in the list,
20884 whether obtained from an MX lookup or not.
20885
20886
20887
20888 .section "How the options are used" "SECThowoptused"
20889 The options are a sequence of words, space-separated.
20890 One of the words can be the name of a transport; this overrides the
20891 &%transport%& option on the router for this particular routing rule only. The
20892 other words (if present) control randomization of the list of hosts on a
20893 per-rule basis, and how the IP addresses of the hosts are to be found when
20894 routing to a remote transport. These options are as follows:
20895
20896 .ilist
20897 &%randomize%&: randomize the order of the hosts in this list, overriding the
20898 setting of &%hosts_randomize%& for this routing rule only.
20899 .next
20900 &%no_randomize%&: do not randomize the order of the hosts in this list,
20901 overriding the setting of &%hosts_randomize%& for this routing rule only.
20902 .next
20903 &%byname%&: use &[getipnodebyname()]& (&[gethostbyname()]& on older systems) to
20904 find IP addresses. This function may ultimately cause a DNS lookup, but it may
20905 also look in &_/etc/hosts_& or other sources of information.
20906 .next
20907 &%bydns%&: look up address records for the hosts directly in the DNS; fail if
20908 no address records are found. If there is a temporary DNS error (such as a
20909 timeout), delivery is deferred.
20910 .next
20911 &%ipv4_only%&: in direct DNS lookups, look up only A records.
20912 .next
20913 &%ipv4_prefer%&: in direct DNS lookups, sort A records before AAAA records.
20914 .endlist
20915
20916 For example:
20917 .code
20918 route_list = domain1  host1:host2:host3  randomize bydns;\
20919              domain2  host4:host5
20920 .endd
20921 If neither &%byname%& nor &%bydns%& is given, Exim behaves as follows: First, a
20922 DNS lookup is done. If this yields anything other than HOST_NOT_FOUND, that
20923 result is used. Otherwise, Exim goes on to try a call to &[getipnodebyname()]&
20924 or &[gethostbyname()]&, and the result of the lookup is the result of that
20925 call.
20926
20927 &*Warning*&: It has been discovered that on some systems, if a DNS lookup
20928 called via &[getipnodebyname()]& times out, HOST_NOT_FOUND is returned
20929 instead of TRY_AGAIN. That is why the default action is to try a DNS
20930 lookup first. Only if that gives a definite &"no such host"& is the local
20931 function called.
20932
20933 &*Compatibility*&: From Exim 4.85 until fixed for 4.90, there was an
20934 inadvertent constraint that a transport name as an option had to be the last
20935 option specified.
20936
20937
20938
20939 If no IP address for a host can be found, what happens is controlled by the
20940 &%host_find_failed%& option.
20941
20942 .vindex "&$host$&"
20943 When an address is routed to a local transport, IP addresses are not looked up.
20944 The host list is passed to the transport in the &$host$& variable.
20945
20946
20947
20948 .section "Manualroute examples" "SECID123"
20949 In some of the examples that follow, the presence of the &%remote_smtp%&
20950 transport, as defined in the default configuration file, is assumed:
20951
20952 .ilist
20953 .cindex "smart host" "example router"
20954 The &(manualroute)& router can be used to forward all external mail to a
20955 &'smart host'&. If you have set up, in the main part of the configuration, a
20956 named domain list that contains your local domains, for example:
20957 .code
20958 domainlist local_domains = my.domain.example
20959 .endd
20960 You can arrange for all other domains to be routed to a smart host by making
20961 your first router something like this:
20962 .code
20963 smart_route:
20964   driver = manualroute
20965   domains = !+local_domains
20966   transport = remote_smtp
20967   route_list = * smarthost.ref.example
20968 .endd
20969 This causes all non-local addresses to be sent to the single host
20970 &'smarthost.ref.example'&. If a colon-separated list of smart hosts is given,
20971 they are tried in order
20972 (but you can use &%hosts_randomize%& to vary the order each time).
20973 Another way of configuring the same thing is this:
20974 .code
20975 smart_route:
20976   driver = manualroute
20977   transport = remote_smtp
20978   route_list = !+local_domains  smarthost.ref.example
20979 .endd
20980 There is no difference in behaviour between these two routers as they stand.
20981 However, they behave differently if &%no_more%& is added to them. In the first
20982 example, the router is skipped if the domain does not match the &%domains%&
20983 precondition; the following router is always tried. If the router runs, it
20984 always matches the domain and so can never decline. Therefore, &%no_more%&
20985 would have no effect. In the second case, the router is never skipped; it
20986 always runs. However, if it doesn't match the domain, it declines. In this case
20987 &%no_more%& would prevent subsequent routers from running.
20988
20989 .next
20990 .cindex "mail hub example"
20991 A &'mail hub'& is a host which receives mail for a number of domains via MX
20992 records in the DNS and delivers it via its own private routing mechanism. Often
20993 the final destinations are behind a firewall, with the mail hub being the one
20994 machine that can connect to machines both inside and outside the firewall. The
20995 &(manualroute)& router is usually used on a mail hub to route incoming messages
20996 to the correct hosts. For a small number of domains, the routing can be inline,
20997 using the &%route_list%& option, but for a larger number a file or database
20998 lookup is easier to manage.
20999
21000 If the domain names are in fact the names of the machines to which the mail is
21001 to be sent by the mail hub, the configuration can be quite simple. For
21002 example:
21003 .code
21004 hub_route:
21005   driver = manualroute
21006   transport = remote_smtp
21007   route_list = *.rhodes.tvs.example  $domain
21008 .endd
21009 This configuration routes domains that match &`*.rhodes.tvs.example`& to hosts
21010 whose names are the same as the mail domains. A similar approach can be taken
21011 if the host name can be obtained from the domain name by a string manipulation
21012 that the expansion facilities can handle. Otherwise, a lookup based on the
21013 domain can be used to find the host:
21014 .code
21015 through_firewall:
21016   driver = manualroute
21017   transport = remote_smtp
21018   route_data = ${lookup {$domain} cdb {/internal/host/routes}}
21019 .endd
21020 The result of the lookup must be the name or IP address of the host (or
21021 hosts) to which the address is to be routed. If the lookup fails, the route
21022 data is empty, causing the router to decline. The address then passes to the
21023 next router.
21024
21025 .next
21026 .cindex "batched SMTP output example"
21027 .cindex "SMTP" "batched outgoing; example"
21028 You can use &(manualroute)& to deliver messages to pipes or files in batched
21029 SMTP format for onward transportation by some other means. This is one way of
21030 storing mail for a dial-up host when it is not connected. The route list entry
21031 can be as simple as a single domain name in a configuration like this:
21032 .code
21033 save_in_file:
21034   driver = manualroute
21035   transport = batchsmtp_appendfile
21036   route_list = saved.domain.example
21037 .endd
21038 though often a pattern is used to pick up more than one domain. If there are
21039 several domains or groups of domains with different transport requirements,
21040 different transports can be listed in the routing information:
21041 .code
21042 save_in_file:
21043   driver = manualroute
21044   route_list = \
21045     *.saved.domain1.example  $domain  batch_appendfile; \
21046     *.saved.domain2.example  \
21047       ${lookup{$domain}dbm{/domain2/hosts}{$value}fail} \
21048       batch_pipe
21049 .endd
21050 .vindex "&$domain$&"
21051 .vindex "&$host$&"
21052 The first of these just passes the domain in the &$host$& variable, which
21053 doesn't achieve much (since it is also in &$domain$&), but the second does a
21054 file lookup to find a value to pass, causing the router to decline to handle
21055 the address if the lookup fails.
21056
21057 .next
21058 .cindex "UUCP" "example of router for"
21059 Routing mail directly to UUCP software is a specific case of the use of
21060 &(manualroute)& in a gateway to another mail environment. This is an example of
21061 one way it can be done:
21062 .code
21063 # Transport
21064 uucp:
21065   driver = pipe
21066   user = nobody
21067   command = /usr/local/bin/uux -r - \
21068     ${substr_-5:$host}!rmail ${local_part}
21069   return_fail_output = true
21070
21071 # Router
21072 uucphost:
21073   transport = uucp
21074   driver = manualroute
21075   route_data = \
21076     ${lookup{$domain}lsearch{/usr/local/exim/uucphosts}}
21077 .endd
21078 The file &_/usr/local/exim/uucphosts_& contains entries like
21079 .code
21080 darksite.ethereal.example:           darksite.UUCP
21081 .endd
21082 It can be set up more simply without adding and removing &".UUCP"& but this way
21083 makes clear the distinction between the domain name
21084 &'darksite.ethereal.example'& and the UUCP host name &'darksite'&.
21085 .endlist
21086 .ecindex IIDmanrou1
21087 .ecindex IIDmanrou2
21088
21089
21090
21091
21092
21093
21094
21095
21096 . ////////////////////////////////////////////////////////////////////////////
21097 . ////////////////////////////////////////////////////////////////////////////
21098
21099 .chapter "The queryprogram router" "CHAPdriverlast"
21100 .scindex IIDquerou1 "&(queryprogram)& router"
21101 .scindex IIDquerou2 "routers" "&(queryprogram)&"
21102 .cindex "routing" "by external program"
21103 The &(queryprogram)& router routes an address by running an external command
21104 and acting on its output. This is an expensive way to route, and is intended
21105 mainly for use in lightly-loaded systems, or for performing experiments.
21106 However, if it is possible to use the precondition options (&%domains%&,
21107 &%local_parts%&, etc) to skip this router for most addresses, it could sensibly
21108 be used in special cases, even on a busy host. There are the following private
21109 options:
21110 .cindex "options" "&(queryprogram)& router"
21111
21112 .option command queryprogram string&!! unset
21113 This option must be set. It specifies the command that is to be run. The
21114 command is split up into a command name and arguments, and then each is
21115 expanded separately (exactly as for a &(pipe)& transport, described in chapter
21116 &<<CHAPpipetransport>>&).
21117
21118
21119 .option command_group queryprogram string unset
21120 .cindex "gid (group id)" "in &(queryprogram)& router"
21121 This option specifies a gid to be set when running the command while routing an
21122 address for deliver. It must be set if &%command_user%& specifies a numerical
21123 uid. If it begins with a digit, it is interpreted as the numerical value of the
21124 gid. Otherwise it is looked up using &[getgrnam()]&.
21125
21126
21127 .option command_user queryprogram string unset
21128 .cindex "uid (user id)" "for &(queryprogram)&"
21129 This option must be set. It specifies the uid which is set when running the
21130 command while routing an address for delivery. If the value begins with a digit,
21131 it is interpreted as the numerical value of the uid. Otherwise, it is looked up
21132 using &[getpwnam()]& to obtain a value for the uid and, if &%command_group%& is
21133 not set, a value for the gid also.
21134
21135 &*Warning:*& Changing uid and gid is possible only when Exim is running as
21136 root, which it does during a normal delivery in a conventional configuration.
21137 However, when an address is being verified during message reception, Exim is
21138 usually running as the Exim user, not as root. If the &(queryprogram)& router
21139 is called from a non-root process, Exim cannot change uid or gid before running
21140 the command. In this circumstance the command runs under the current uid and
21141 gid.
21142
21143
21144 .option current_directory queryprogram string /
21145 This option specifies an absolute path which is made the current directory
21146 before running the command.
21147
21148
21149 .option timeout queryprogram time 1h
21150 If the command does not complete within the timeout period, its process group
21151 is killed and the message is frozen. A value of zero time specifies no
21152 timeout.
21153
21154
21155 The standard output of the command is connected to a pipe, which is read when
21156 the command terminates. It should consist of a single line of output,
21157 containing up to five fields, separated by white space. The maximum length of
21158 the line is 1023 characters. Longer lines are silently truncated. The first
21159 field is one of the following words (case-insensitive):
21160
21161 .ilist
21162 &'Accept'&: routing succeeded; the remaining fields specify what to do (see
21163 below).
21164 .next
21165 &'Decline'&: the router declines; pass the address to the next router, unless
21166 &%no_more%& is set.
21167 .next
21168 &'Fail'&: routing failed; do not pass the address to any more routers. Any
21169 subsequent text on the line is an error message. If the router is run as part
21170 of address verification during an incoming SMTP message, the message is
21171 included in the SMTP response.
21172 .next
21173 &'Defer'&: routing could not be completed at this time; try again later. Any
21174 subsequent text on the line is an error message which is logged. It is not
21175 included in any SMTP response.
21176 .next
21177 &'Freeze'&: the same as &'defer'&, except that the message is frozen.
21178 .next
21179 &'Pass'&: pass the address to the next router (or the router specified by
21180 &%pass_router%&), overriding &%no_more%&.
21181 .next
21182 &'Redirect'&: the message is redirected. The remainder of the line is a list of
21183 new addresses, which are routed independently, starting with the first router,
21184 or the router specified by &%redirect_router%&, if set.
21185 .endlist
21186
21187 When the first word is &'accept'&, the remainder of the line consists of a
21188 number of keyed data values, as follows (split into two lines here, to fit on
21189 the page):
21190 .code
21191 ACCEPT TRANSPORT=<transport> HOSTS=<list of hosts>
21192 LOOKUP=byname|bydns DATA=<text>
21193 .endd
21194 The data items can be given in any order, and all are optional. If no transport
21195 is included, the transport specified by the generic &%transport%& option is
21196 used. The list of hosts and the lookup type are needed only if the transport is
21197 an &(smtp)& transport that does not itself supply a list of hosts.
21198
21199 The format of the list of hosts is the same as for the &(manualroute)& router.
21200 As well as host names and IP addresses with optional port numbers, as described
21201 in section &<<SECTformatonehostitem>>&, it may contain names followed by
21202 &`/MX`& to specify sublists of hosts that are obtained by looking up MX records
21203 (see section &<<SECThostshowused>>&).
21204
21205 If the lookup type is not specified, Exim behaves as follows when trying to
21206 find an IP address for each host: First, a DNS lookup is done. If this yields
21207 anything other than HOST_NOT_FOUND, that result is used. Otherwise, Exim
21208 goes on to try a call to &[getipnodebyname()]& or &[gethostbyname()]&, and the
21209 result of the lookup is the result of that call.
21210
21211 .vindex "&$address_data$&"
21212 If the DATA field is set, its value is placed in the &$address_data$&
21213 variable. For example, this return line
21214 .code
21215 accept hosts=x1.y.example:x2.y.example data="rule1"
21216 .endd
21217 routes the address to the default transport, passing a list of two hosts. When
21218 the transport runs, the string &"rule1"& is in &$address_data$&.
21219 .ecindex IIDquerou1
21220 .ecindex IIDquerou2
21221
21222
21223
21224
21225 . ////////////////////////////////////////////////////////////////////////////
21226 . ////////////////////////////////////////////////////////////////////////////
21227
21228 .chapter "The redirect router" "CHAPredirect"
21229 .scindex IIDredrou1 "&(redirect)& router"
21230 .scindex IIDredrou2 "routers" "&(redirect)&"
21231 .cindex "alias file" "in a &(redirect)& router"
21232 .cindex "address redirection" "&(redirect)& router"
21233 The &(redirect)& router handles several kinds of address redirection. Its most
21234 common uses are for resolving local part aliases from a central alias file
21235 (usually called &_/etc/aliases_&) and for handling users' personal &_.forward_&
21236 files, but it has many other potential uses. The incoming address can be
21237 redirected in several different ways:
21238
21239 .ilist
21240 It can be replaced by one or more new addresses which are themselves routed
21241 independently.
21242 .next
21243 It can be routed to be delivered to a given file or directory.
21244 .next
21245 It can be routed to be delivered to a specified pipe command.
21246 .next
21247 It can cause an automatic reply to be generated.
21248 .next
21249 It can be forced to fail, optionally with a custom error message.
21250 .next
21251 It can be temporarily deferred, optionally with a custom message.
21252 .next
21253 It can be discarded.
21254 .endlist
21255
21256 The generic &%transport%& option must not be set for &(redirect)& routers.
21257 However, there are some private options which define transports for delivery to
21258 files and pipes, and for generating autoreplies. See the &%file_transport%&,
21259 &%pipe_transport%& and &%reply_transport%& descriptions below.
21260
21261 If success DSNs have been requested
21262 .cindex "DSN" "success"
21263 .cindex "Delivery Status Notification" "success"
21264 redirection triggers one and the DSN options are not passed any further.
21265
21266
21267
21268 .section "Redirection data" "SECID124"
21269 The router operates by interpreting a text string which it obtains either by
21270 expanding the contents of the &%data%& option, or by reading the entire
21271 contents of a file whose name is given in the &%file%& option. These two
21272 options are mutually exclusive. The first is commonly used for handling system
21273 aliases, in a configuration like this:
21274 .code
21275 system_aliases:
21276   driver = redirect
21277   data = ${lookup{$local_part}lsearch{/etc/aliases}}
21278 .endd
21279 If the lookup fails, the expanded string in this example is empty. When the
21280 expansion of &%data%& results in an empty string, the router declines. A forced
21281 expansion failure also causes the router to decline; other expansion failures
21282 cause delivery to be deferred.
21283
21284 A configuration using &%file%& is commonly used for handling users'
21285 &_.forward_& files, like this:
21286 .code
21287 userforward:
21288   driver = redirect
21289   check_local_user
21290   file = $home/.forward
21291   no_verify
21292 .endd
21293 If the file does not exist, or causes no action to be taken (for example, it is
21294 empty or consists only of comments), the router declines. &*Warning*&: This
21295 is not the case when the file contains syntactically valid items that happen to
21296 yield empty addresses, for example, items containing only RFC 2822 address
21297 comments.
21298
21299 .cindex "tainted data" "in filenames"
21300 .cindex redirect "tainted data"
21301 Tainted data may not be used for a filename.
21302
21303 &*Warning*&: It is unwise to use &$local_part$& or &$domain$&
21304 directly for redirection,
21305 as they are provided by a potential attacker.
21306 In the examples above, &$local_part$& is used for looking up data held locally
21307 on the system, and not used directly (the second example derives &$home$& via
21308 the passsword file or database, using &$local_part$&).
21309
21310
21311
21312 .section "Forward files and address verification" "SECID125"
21313 .cindex "address redirection" "while verifying"
21314 It is usual to set &%no_verify%& on &(redirect)& routers which handle users'
21315 &_.forward_& files, as in the example above. There are two reasons for this:
21316
21317 .ilist
21318 When Exim is receiving an incoming SMTP message from a remote host, it is
21319 running under the Exim uid, not as root. Exim is unable to change uid to read
21320 the file as the user, and it may not be able to read it as the Exim user. So in
21321 practice the router may not be able to operate.
21322 .next
21323 However, even when the router can operate, the existence of a &_.forward_& file
21324 is unimportant when verifying an address. What should be checked is whether the
21325 local part is a valid user name or not. Cutting out the redirection processing
21326 saves some resources.
21327 .endlist
21328
21329
21330
21331
21332
21333
21334 .section "Interpreting redirection data" "SECID126"
21335 .cindex "Sieve filter" "specifying in redirection data"
21336 .cindex "filter" "specifying in redirection data"
21337 The contents of the data string, whether obtained from &%data%& or &%file%&,
21338 can be interpreted in two different ways:
21339
21340 .ilist
21341 If the &%allow_filter%& option is set true, and the data begins with the text
21342 &"#Exim filter"& or &"#Sieve filter"&, it is interpreted as a list of
21343 &'filtering'& instructions in the form of an Exim or Sieve filter file,
21344 respectively. Details of the syntax and semantics of filter files are described
21345 in a separate document entitled &'Exim's interfaces to mail filtering'&; this
21346 document is intended for use by end users.
21347 .next
21348 Otherwise, the data must be a comma-separated list of redirection items, as
21349 described in the next section.
21350 .endlist
21351
21352 When a message is redirected to a file (a &"mail folder"&), the filename given
21353 in a non-filter redirection list must always be an absolute path. A filter may
21354 generate a relative path &-- how this is handled depends on the transport's
21355 configuration. See section &<<SECTfildiropt>>& for a discussion of this issue
21356 for the &(appendfile)& transport.
21357
21358
21359
21360 .section "Items in a non-filter redirection list" "SECTitenonfilred"
21361 .cindex "address redirection" "non-filter list items"
21362 When the redirection data is not an Exim or Sieve filter, for example, if it
21363 comes from a conventional alias or forward file, it consists of a list of
21364 addresses, filenames, pipe commands, or certain special items (see section
21365 &<<SECTspecitredli>>& below). The special items can be individually enabled or
21366 disabled by means of options whose names begin with &%allow_%& or &%forbid_%&,
21367 depending on their default values. The items in the list are separated by
21368 commas or newlines.
21369 If a comma is required in an item, the entire item must be enclosed in double
21370 quotes.
21371
21372 Lines starting with a # character are comments, and are ignored, and # may
21373 also appear following a comma, in which case everything between the # and the
21374 next newline character is ignored.
21375
21376 If an item is entirely enclosed in double quotes, these are removed. Otherwise
21377 double quotes are retained because some forms of mail address require their use
21378 (but never to enclose the entire address). In the following description,
21379 &"item"& refers to what remains after any surrounding double quotes have been
21380 removed.
21381
21382 .vindex "&$local_part$&"
21383 &*Warning*&: If you use an Exim expansion to construct a redirection address,
21384 and the expansion contains a reference to &$local_part$&, you should make use
21385 of the &%quote_local_part%& expansion operator, in case the local part contains
21386 special characters. For example, to redirect all mail for the domain
21387 &'obsolete.example'&, retaining the existing local part, you could use this
21388 setting:
21389 .code
21390 data = ${quote_local_part:$local_part}@newdomain.example
21391 .endd
21392
21393
21394 .section "Redirecting to a local mailbox" "SECTredlocmai"
21395 .cindex "routing" "loops in"
21396 .cindex "loop" "while routing, avoidance of"
21397 .cindex "address redirection" "to local mailbox"
21398 A redirection item may safely be the same as the address currently under
21399 consideration. This does not cause a routing loop, because a router is
21400 automatically skipped if any ancestor of the address that is being processed
21401 is the same as the current address and was processed by the current router.
21402 Such an address is therefore passed to the following routers, so it is handled
21403 as if there were no redirection. When making this loop-avoidance test, the
21404 complete local part, including any prefix or suffix, is used.
21405
21406 .cindex "address redirection" "local part without domain"
21407 Specifying the same local part without a domain is a common usage in personal
21408 filter files when the user wants to have messages delivered to the local
21409 mailbox and also forwarded elsewhere. For example, the user whose login is
21410 &'cleo'& might have a &_.forward_& file containing this:
21411 .code
21412 cleo, cleopatra@egypt.example
21413 .endd
21414 .cindex "backslash in alias file"
21415 .cindex "alias file" "backslash in"
21416 For compatibility with other MTAs, such unqualified local parts may be
21417 preceded by &"\"&, but this is not a requirement for loop prevention. However,
21418 it does make a difference if more than one domain is being handled
21419 synonymously.
21420
21421 If an item begins with &"\"& and the rest of the item parses as a valid RFC
21422 2822 address that does not include a domain, the item is qualified using the
21423 domain of the incoming address. In the absence of a leading &"\"&, unqualified
21424 addresses are qualified using the value in &%qualify_recipient%&, but you can
21425 force the incoming domain to be used by setting &%qualify_preserve_domain%&.
21426
21427 Care must be taken if there are alias names for local users.
21428 Consider an MTA handling a single local domain where the system alias file
21429 contains:
21430 .code
21431 Sam.Reman: spqr
21432 .endd
21433 Now suppose that Sam (whose login id is &'spqr'&) wants to save copies of
21434 messages in the local mailbox, and also forward copies elsewhere. He creates
21435 this forward file:
21436 .code
21437 Sam.Reman, spqr@reme.elsewhere.example
21438 .endd
21439 With these settings, an incoming message addressed to &'Sam.Reman'& fails. The
21440 &(redirect)& router for system aliases does not process &'Sam.Reman'& the
21441 second time round, because it has previously routed it,
21442 and the following routers presumably cannot handle the alias. The forward file
21443 should really contain
21444 .code
21445 spqr, spqr@reme.elsewhere.example
21446 .endd
21447 but because this is such a common error, the &%check_ancestor%& option (see
21448 below) exists to provide a way to get round it. This is normally set on a
21449 &(redirect)& router that is handling users' &_.forward_& files.
21450
21451
21452
21453 .section "Special items in redirection lists" "SECTspecitredli"
21454 In addition to addresses, the following types of item may appear in redirection
21455 lists (that is, in non-filter redirection data):
21456
21457 .ilist
21458 .cindex "pipe" "in redirection list"
21459 .cindex "address redirection" "to pipe"
21460 An item is treated as a pipe command if it begins with &"|"& and does not parse
21461 as a valid RFC 2822 address that includes a domain. A transport for running the
21462 command must be specified by the &%pipe_transport%& option.
21463 Normally, either the router or the transport specifies a user and a group under
21464 which to run the delivery. The default is to use the Exim user and group.
21465
21466 Single or double quotes can be used for enclosing the individual arguments of
21467 the pipe command; no interpretation of escapes is done for single quotes. If
21468 the command contains a comma character, it is necessary to put the whole item
21469 in double quotes, for example:
21470 .code
21471 "|/some/command ready,steady,go"
21472 .endd
21473 since items in redirection lists are terminated by commas. Do not, however,
21474 quote just the command. An item such as
21475 .code
21476 |"/some/command ready,steady,go"
21477 .endd
21478 is interpreted as a pipe with a rather strange command name, and no arguments.
21479
21480 Note that the above example assumes that the text comes from a lookup source
21481 of some sort, so that the quotes are part of the data.  If composing a
21482 redirect router with a &%data%& option directly specifying this command, the
21483 quotes will be used by the configuration parser to define the extent of one
21484 string, but will not be passed down into the redirect router itself.  There
21485 are two main approaches to get around this: escape quotes to be part of the
21486 data itself, or avoid using this mechanism and instead create a custom
21487 transport with the &%command%& option set and reference that transport from
21488 an &%accept%& router.
21489
21490 .next
21491 .cindex "file" "in redirection list"
21492 .cindex "address redirection" "to file"
21493 An item is interpreted as a path name if it begins with &"/"& and does not
21494 parse as a valid RFC 2822 address that includes a domain. For example,
21495 .code
21496 /home/world/minbari
21497 .endd
21498 is treated as a filename, but
21499 .code
21500 /s=molari/o=babylon/@x400gate.way
21501 .endd
21502 is treated as an address. For a filename, a transport must be specified using
21503 the &%file_transport%& option. However, if the generated path name ends with a
21504 forward slash character, it is interpreted as a directory name rather than a
21505 filename, and &%directory_transport%& is used instead.
21506
21507 Normally, either the router or the transport specifies a user and a group under
21508 which to run the delivery. The default is to use the Exim user and group.
21509
21510 .cindex "&_/dev/null_&"
21511 However, if a redirection item is the path &_/dev/null_&, delivery to it is
21512 bypassed at a high level, and the log entry shows &"**bypassed**"&
21513 instead of a transport name. In this case the user and group are not used.
21514
21515 .next
21516 .cindex "included address list"
21517 .cindex "address redirection" "included external list"
21518 If an item is of the form
21519 .code
21520 :include:<path name>
21521 .endd
21522 a list of further items is taken from the given file and included at that
21523 point. &*Note*&: Such a file can not be a filter file; it is just an
21524 out-of-line addition to the list. The items in the included list are separated
21525 by commas or newlines and are not subject to expansion. If this is the first
21526 item in an alias list in an &(lsearch)& file, a colon must be used to terminate
21527 the alias name. This example is incorrect:
21528 .code
21529 list1    :include:/opt/lists/list1
21530 .endd
21531 It must be given as
21532 .code
21533 list1:   :include:/opt/lists/list1
21534 .endd
21535 .cindex "tainted data" "in filenames"
21536 .cindex redirect "tainted data"
21537 Tainted data may not be used for a filename.
21538 .next
21539 .cindex "address redirection" "to black hole"
21540 .cindex "delivery" "discard"
21541 .cindex "delivery" "blackhole"
21542 .cindex "black hole"
21543 .cindex "abandoning mail"
21544 Sometimes you want to throw away mail to a particular local part.  Making the
21545 &%data%& option expand to an empty string does not work, because that causes
21546 the router to decline. Instead, the alias item
21547 .code
21548 :blackhole:
21549 .endd
21550 can be used. It does what its name implies. No delivery is
21551 done, and no error message is generated. This has the same effect as specifying
21552 &_/dev/null_& as a destination, but it can be independently disabled.
21553
21554 &*Warning*&: If &':blackhole:'& appears anywhere in a redirection list, no
21555 delivery is done for the original local part, even if other redirection items
21556 are present. If you are generating a multi-item list (for example, by reading a
21557 database) and need the ability to provide a no-op item, you must use
21558 &_/dev/null_&.
21559
21560 .next
21561 .cindex "delivery" "forcing failure"
21562 .cindex "delivery" "forcing deferral"
21563 .cindex "failing delivery" "forcing"
21564 .cindex "deferred delivery, forcing"
21565 .cindex "customizing" "failure message"
21566 An attempt to deliver a particular address can be deferred or forced to fail by
21567 redirection items of the form
21568 .code
21569 :defer:
21570 :fail:
21571 .endd
21572 respectively. When a redirection list contains such an item, it applies
21573 to the entire redirection; any other items in the list are ignored. Any
21574 text following &':fail:'& or &':defer:'& is placed in the error text
21575 associated with the failure. For example, an alias file might contain:
21576 .code
21577 X.Employee:  :fail: Gone away, no forwarding address
21578 .endd
21579 In the case of an address that is being verified from an ACL or as the subject
21580 of a
21581 .cindex "VRFY" "error text, display of"
21582 VRFY command, the text is included in the SMTP error response by
21583 default.
21584 .cindex "EXPN" "error text, display of"
21585 The text is not included in the response to an EXPN command. In non-SMTP cases
21586 the text is included in the error message that Exim generates.
21587
21588 .cindex "SMTP" "error codes"
21589 By default for verify, Exim sends a 451 SMTP code for a &':defer:'&, and 550 for
21590 &':fail:'&. However, if the message starts with three digits followed by a
21591 space, optionally followed by an extended code of the form &'n.n.n'&, also
21592 followed by a space, and the very first digit is the same as the default error
21593 code, the code from the message is used instead. If the very first digit is
21594 incorrect, a panic error is logged, and the default code is used. You can
21595 suppress the use of the supplied code in a redirect router by setting the
21596 &%forbid_smtp_code%& option true. In this case, any SMTP code is quietly
21597 ignored.
21598
21599 .vindex "&$acl_verify_message$&"
21600 In an ACL, an explicitly provided message overrides the default, but the
21601 default message is available in the variable &$acl_verify_message$& and can
21602 therefore be included in a custom message if this is desired.
21603
21604 Normally the error text is the rest of the redirection list &-- a comma does
21605 not terminate it &-- but a newline does act as a terminator. Newlines are not
21606 normally present in alias expansions. In &(lsearch)& lookups they are removed
21607 as part of the continuation process, but they may exist in other kinds of
21608 lookup and in &':include:'& files.
21609
21610 During routing for message delivery (as opposed to verification), a redirection
21611 containing &':fail:'& causes an immediate failure of the incoming address,
21612 whereas &':defer:'& causes the message to remain in the queue so that a
21613 subsequent delivery attempt can happen at a later time. If an address is
21614 deferred for too long, it will ultimately fail, because the normal retry
21615 rules still apply.
21616
21617 .next
21618 .cindex "alias file" "exception to default"
21619 Sometimes it is useful to use a single-key search type with a default (see
21620 chapter &<<CHAPfdlookup>>&) to look up aliases. However, there may be a need
21621 for exceptions to the default. These can be handled by aliasing them to
21622 &':unknown:'&. This differs from &':fail:'& in that it causes the &(redirect)&
21623 router to decline, whereas &':fail:'& forces routing to fail. A lookup which
21624 results in an empty redirection list has the same effect.
21625 .endlist
21626
21627
21628 .section "Duplicate addresses" "SECTdupaddr"
21629 .cindex "duplicate addresses"
21630 .cindex "address duplicate, discarding"
21631 .cindex "pipe" "duplicated"
21632 Exim removes duplicate addresses from the list to which it is delivering, so as
21633 to deliver just one copy to each address. This does not apply to deliveries
21634 routed to pipes by different immediate parent addresses, but an indirect
21635 aliasing scheme of the type
21636 .code
21637 pipe:       |/some/command $local_part
21638 localpart1: pipe
21639 localpart2: pipe
21640 .endd
21641 does not work with a message that is addressed to both local parts, because
21642 when the second is aliased to the intermediate local part &"pipe"& it gets
21643 discarded as being the same as a previously handled address. However, a scheme
21644 such as
21645 .code
21646 localpart1: |/some/command $local_part
21647 localpart2: |/some/command $local_part
21648 .endd
21649 does result in two different pipe deliveries, because the immediate parents of
21650 the pipes are distinct.
21651
21652
21653
21654 .section "Repeated redirection expansion" "SECID128"
21655 .cindex "repeated redirection expansion"
21656 .cindex "address redirection" "repeated for each delivery attempt"
21657 When a message cannot be delivered to all of its recipients immediately,
21658 leading to two or more delivery attempts, redirection expansion is carried out
21659 afresh each time for those addresses whose children were not all previously
21660 delivered. If redirection is being used as a mailing list, this can lead to new
21661 members of the list receiving copies of old messages. The &%one_time%& option
21662 can be used to avoid this.
21663
21664
21665 .section "Errors in redirection lists" "SECID129"
21666 .cindex "address redirection" "errors"
21667 If &%skip_syntax_errors%& is set, a malformed address that causes a parsing
21668 error is skipped, and an entry is written to the main log. This may be useful
21669 for mailing lists that are automatically managed. Otherwise, if an error is
21670 detected while generating the list of new addresses, the original address is
21671 deferred. See also &%syntax_errors_to%&.
21672
21673
21674
21675 .section "Private options for the redirect router" "SECID130"
21676
21677 .cindex "options" "&(redirect)& router"
21678 The private options for the &(redirect)& router are as follows:
21679
21680
21681 .option allow_defer redirect boolean false
21682 Setting this option allows the use of &':defer:'& in non-filter redirection
21683 data, or the &%defer%& command in an Exim filter file.
21684
21685
21686 .option allow_fail redirect boolean false
21687 .cindex "failing delivery" "from filter"
21688 If this option is true, the &':fail:'& item can be used in a redirection list,
21689 and the &%fail%& command may be used in an Exim filter file.
21690
21691
21692 .option allow_filter redirect boolean false
21693 .cindex "filter" "enabling use of"
21694 .cindex "Sieve filter" "enabling use of"
21695 Setting this option allows Exim to interpret redirection data that starts with
21696 &"#Exim filter"& or &"#Sieve filter"& as a set of filtering instructions. There
21697 are some features of Exim filter files that some administrators may wish to
21698 lock out; see the &%forbid_filter_%&&'xxx'& options below.
21699
21700 It is also possible to lock out Exim filters or Sieve filters while allowing
21701 the other type; see &%forbid_exim_filter%& and &%forbid_sieve_filter%&.
21702
21703
21704 The filter is run using the uid and gid set by the generic &%user%& and
21705 &%group%& options. These take their defaults from the password data if
21706 &%check_local_user%& is set, so in the normal case of users' personal filter
21707 files, the filter is run as the relevant user. When &%allow_filter%& is set
21708 true, Exim insists that either &%check_local_user%& or &%user%& is set.
21709
21710
21711
21712 .option allow_freeze redirect boolean false
21713 .cindex "freezing messages" "allowing in filter"
21714 Setting this option allows the use of the &%freeze%& command in an Exim filter.
21715 This command is more normally encountered in system filters, and is disabled by
21716 default for redirection filters because it isn't something you usually want to
21717 let ordinary users do.
21718
21719
21720
21721 .option check_ancestor redirect boolean false
21722 This option is concerned with handling generated addresses that are the same
21723 as some address in the list of redirection ancestors of the current address.
21724 Although it is turned off by default in the code, it is set in the default
21725 configuration file for handling users' &_.forward_& files. It is recommended
21726 for this use of the &(redirect)& router.
21727
21728 When &%check_ancestor%& is set, if a generated address (including the domain)
21729 is the same as any ancestor of the current address, it is replaced by a copy of
21730 the current address. This helps in the case where local part A is aliased to B,
21731 and B has a &_.forward_& file pointing back to A. For example, within a single
21732 domain, the local part &"Joe.Bloggs"& is aliased to &"jb"& and
21733 &_&~jb/.forward_& contains:
21734 .code
21735 \Joe.Bloggs, <other item(s)>
21736 .endd
21737 Without the &%check_ancestor%& setting, either local part (&"jb"& or
21738 &"joe.bloggs"&) gets processed once by each router and so ends up as it was
21739 originally. If &"jb"& is the real mailbox name, mail to &"jb"& gets delivered
21740 (having been turned into &"joe.bloggs"& by the &_.forward_& file and back to
21741 &"jb"& by the alias), but mail to &"joe.bloggs"& fails. Setting
21742 &%check_ancestor%& on the &(redirect)& router that handles the &_.forward_&
21743 file prevents it from turning &"jb"& back into &"joe.bloggs"& when that was the
21744 original address. See also the &%repeat_use%& option below.
21745
21746
21747 .option check_group redirect boolean "see below"
21748 When the &%file%& option is used, the group owner of the file is checked only
21749 when this option is set. The permitted groups are those listed in the
21750 &%owngroups%& option, together with the user's default group if
21751 &%check_local_user%& is set. If the file has the wrong group, routing is
21752 deferred. The default setting for this option is true if &%check_local_user%&
21753 is set and the &%modemask%& option permits the group write bit, or if the
21754 &%owngroups%& option is set. Otherwise it is false, and no group check occurs.
21755
21756
21757
21758 .option check_owner redirect boolean "see below"
21759 When the &%file%& option is used, the owner of the file is checked only when
21760 this option is set. If &%check_local_user%& is set, the local user is
21761 permitted; otherwise the owner must be one of those listed in the &%owners%&
21762 option. The default value for this option is true if &%check_local_user%& or
21763 &%owners%& is set. Otherwise the default is false, and no owner check occurs.
21764
21765
21766 .option data redirect string&!! unset
21767 This option is mutually exclusive with &%file%&. One or other of them must be
21768 set, but not both. The contents of &%data%& are expanded, and then used as the
21769 list of forwarding items, or as a set of filtering instructions. If the
21770 expansion is forced to fail, or the result is an empty string or a string that
21771 has no effect (consists entirely of comments), the router declines.
21772
21773 When filtering instructions are used, the string must begin with &"#Exim
21774 filter"&, and all comments in the string, including this initial one, must be
21775 terminated with newline characters. For example:
21776 .code
21777 data = #Exim filter\n\
21778        if $h_to: contains Exim then save $home/mail/exim endif
21779 .endd
21780 If you are reading the data from a database where newlines cannot be included,
21781 you can use the &${sg}$& expansion item to turn the escape string of your
21782 choice into a newline.
21783
21784
21785 .option directory_transport redirect string&!! unset
21786 A &(redirect)& router sets up a direct delivery to a directory when a path name
21787 ending with a slash is specified as a new &"address"&. The transport used is
21788 specified by this option, which, after expansion, must be the name of a
21789 configured transport. This should normally be an &(appendfile)& transport.
21790
21791
21792 .option file redirect string&!! unset
21793 This option specifies the name of a file that contains the redirection data. It
21794 is mutually exclusive with the &%data%& option. The string is expanded before
21795 use; if the expansion is forced to fail, the router declines. Other expansion
21796 failures cause delivery to be deferred. The result of a successful expansion
21797 must be an absolute path. The entire file is read and used as the redirection
21798 data. If the data is an empty string or a string that has no effect (consists
21799 entirely of comments), the router declines.
21800
21801 .cindex "NFS" "checking for file existence"
21802 If the attempt to open the file fails with a &"does not exist"& error, Exim
21803 runs a check on the containing directory,
21804 unless &%ignore_enotdir%& is true (see below).
21805 If the directory does not appear to exist, delivery is deferred. This can
21806 happen when users' &_.forward_& files are in NFS-mounted directories, and there
21807 is a mount problem. If the containing directory does exist, but the file does
21808 not, the router declines.
21809
21810
21811 .option file_transport redirect string&!! unset
21812 .vindex "&$address_file$&"
21813 A &(redirect)& router sets up a direct delivery to a file when a path name not
21814 ending in a slash is specified as a new &"address"&. The transport used is
21815 specified by this option, which, after expansion, must be the name of a
21816 configured transport. This should normally be an &(appendfile)& transport. When
21817 it is running, the filename is in &$address_file$&.
21818
21819
21820 .option filter_prepend_home redirect boolean true
21821 When this option is true, if a &(save)& command in an Exim filter specifies a
21822 relative path, and &$home$& is defined, it is automatically prepended to the
21823 relative path. If this option is set false, this action does not happen. The
21824 relative path is then passed to the transport unmodified.
21825
21826
21827 .option forbid_blackhole redirect boolean false
21828 .cindex "restricting access to features"
21829 .cindex "filter" "locking out certain features"
21830 If this option is true, the &':blackhole:'& item may not appear in a
21831 redirection list.
21832
21833
21834 .option forbid_exim_filter redirect boolean false
21835 .cindex "restricting access to features"
21836 .cindex "filter" "locking out certain features"
21837 If this option is set true, only Sieve filters are permitted when
21838 &%allow_filter%& is true.
21839
21840
21841
21842
21843 .option forbid_file redirect boolean false
21844 .cindex "restricting access to features"
21845 .cindex "delivery" "to file; forbidding"
21846 .cindex "filter" "locking out certain features"
21847 .cindex "Sieve filter" "forbidding delivery to a file"
21848 .cindex "Sieve filter" "&""keep""& facility; disabling"
21849 If this option is true, this router may not generate a new address that
21850 specifies delivery to a local file or directory, either from a filter or from a
21851 conventional forward file. This option is forced to be true if &%one_time%& is
21852 set. It applies to Sieve filters as well as to Exim filters, but if true, it
21853 locks out the Sieve's &"keep"& facility.
21854
21855
21856 .option forbid_filter_dlfunc redirect boolean false
21857 .cindex "restricting access to features"
21858 .cindex "filter" "locking out certain features"
21859 If this option is true, string expansions in Exim filters are not allowed to
21860 make use of the &%dlfunc%& expansion facility to run dynamically loaded
21861 functions.
21862
21863 .option forbid_filter_existstest redirect boolean false
21864 .cindex "restricting access to features"
21865 .cindex "filter" "locking out certain features"
21866 .cindex "expansion" "statting a file"
21867 If this option is true, string expansions in Exim filters are not allowed to
21868 make use of the &%exists%& condition or the &%stat%& expansion item.
21869
21870 .option forbid_filter_logwrite redirect boolean false
21871 .cindex "restricting access to features"
21872 .cindex "filter" "locking out certain features"
21873 If this option is true, use of the logging facility in Exim filters is not
21874 permitted. Logging is in any case available only if the filter is being run
21875 under some unprivileged uid (which is normally the case for ordinary users'
21876 &_.forward_& files).
21877
21878
21879 .option forbid_filter_lookup redirect boolean false
21880 .cindex "restricting access to features"
21881 .cindex "filter" "locking out certain features"
21882 If this option is true, string expansions in Exim filter files are not allowed
21883 to make use of &%lookup%& items.
21884
21885
21886 .option forbid_filter_perl redirect boolean false
21887 .cindex "restricting access to features"
21888 .cindex "filter" "locking out certain features"
21889 This option has an effect only if Exim is built with embedded Perl support. If
21890 it is true, string expansions in Exim filter files are not allowed to make use
21891 of the embedded Perl support.
21892
21893
21894 .option forbid_filter_readfile redirect boolean false
21895 .cindex "restricting access to features"
21896 .cindex "filter" "locking out certain features"
21897 If this option is true, string expansions in Exim filter files are not allowed
21898 to make use of &%readfile%& items.
21899
21900
21901 .option forbid_filter_readsocket redirect boolean false
21902 .cindex "restricting access to features"
21903 .cindex "filter" "locking out certain features"
21904 If this option is true, string expansions in Exim filter files are not allowed
21905 to make use of &%readsocket%& items.
21906
21907
21908 .option forbid_filter_reply redirect boolean false
21909 .cindex "restricting access to features"
21910 .cindex "filter" "locking out certain features"
21911 If this option is true, this router may not generate an automatic reply
21912 message. Automatic replies can be generated only from Exim or Sieve filter
21913 files, not from traditional forward files. This option is forced to be true if
21914 &%one_time%& is set.
21915
21916
21917 .option forbid_filter_run redirect boolean false
21918 .cindex "restricting access to features"
21919 .cindex "filter" "locking out certain features"
21920 If this option is true, string expansions in Exim filter files are not allowed
21921 to make use of &%run%& items.
21922
21923
21924 .option forbid_include redirect boolean false
21925 .cindex "restricting access to features"
21926 .cindex "filter" "locking out certain features"
21927 If this option is true, items of the form
21928 .code
21929 :include:<path name>
21930 .endd
21931 are not permitted in non-filter redirection lists.
21932
21933
21934 .option forbid_pipe redirect boolean false
21935 .cindex "restricting access to features"
21936 .cindex "filter" "locking out certain features"
21937 .cindex "delivery" "to pipe; forbidding"
21938 If this option is true, this router may not generate a new address which
21939 specifies delivery to a pipe, either from an Exim filter or from a conventional
21940 forward file. This option is forced to be true if &%one_time%& is set.
21941
21942
21943 .option forbid_sieve_filter redirect boolean false
21944 .cindex "restricting access to features"
21945 .cindex "filter" "locking out certain features"
21946 If this option is set true, only Exim filters are permitted when
21947 &%allow_filter%& is true.
21948
21949
21950 .cindex "SMTP" "error codes"
21951 .option forbid_smtp_code redirect boolean false
21952 If this option is set true, any SMTP error codes that are present at the start
21953 of messages specified for &`:defer:`& or &`:fail:`& are quietly ignored, and
21954 the default codes (451 and 550, respectively) are always used.
21955
21956
21957
21958
21959 .option hide_child_in_errmsg redirect boolean false
21960 .cindex "bounce message" "redirection details; suppressing"
21961 If this option is true, it prevents Exim from quoting a child address if it
21962 generates a bounce or delay message for it. Instead it says &"an address
21963 generated from <&'the top level address'&>"&. Of course, this applies only to
21964 bounces generated locally. If a message is forwarded to another host, &'its'&
21965 bounce may well quote the generated address.
21966
21967
21968 .option ignore_eacces redirect boolean false
21969 .cindex "EACCES"
21970 If this option is set and an attempt to open a redirection file yields the
21971 EACCES error (permission denied), the &(redirect)& router behaves as if the
21972 file did not exist.
21973
21974
21975 .option ignore_enotdir redirect boolean false
21976 .cindex "ENOTDIR"
21977 If this option is set and an attempt to open a redirection file yields the
21978 ENOTDIR error (something on the path is not a directory), the &(redirect)&
21979 router behaves as if the file did not exist.
21980
21981 Setting &%ignore_enotdir%& has another effect as well: When a &(redirect)&
21982 router that has the &%file%& option set discovers that the file does not exist
21983 (the ENOENT error), it tries to &[stat()]& the parent directory, as a check
21984 against unmounted NFS directories. If the parent can not be statted, delivery
21985 is deferred. However, it seems wrong to do this check when &%ignore_enotdir%&
21986 is set, because that option tells Exim to ignore &"something on the path is not
21987 a directory"& (the ENOTDIR error). This is a confusing area, because it seems
21988 that some operating systems give ENOENT where others give ENOTDIR.
21989
21990
21991
21992 .option include_directory redirect string unset
21993 If this option is set, the path names of any &':include:'& items in a
21994 redirection list must start with this directory.
21995
21996
21997 .option modemask redirect "octal integer" 022
21998 This specifies mode bits which must not be set for a file specified by the
21999 &%file%& option. If any of the forbidden bits are set, delivery is deferred.
22000
22001
22002 .option one_time redirect boolean false
22003 .cindex "one-time aliasing/forwarding expansion"
22004 .cindex "alias file" "one-time expansion"
22005 .cindex "forward file" "one-time expansion"
22006 .cindex "mailing lists" "one-time expansion"
22007 .cindex "address redirection" "one-time expansion"
22008 Sometimes the fact that Exim re-evaluates aliases and reprocesses redirection
22009 files each time it tries to deliver a message causes a problem when one or more
22010 of the generated addresses fails be delivered at the first attempt. The problem
22011 is not one of duplicate delivery &-- Exim is clever enough to handle that &--
22012 but of what happens when the redirection list changes during the time that the
22013 message is on Exim's queue. This is particularly true in the case of mailing
22014 lists, where new subscribers might receive copies of messages that were posted
22015 before they subscribed.
22016
22017 If &%one_time%& is set and any addresses generated by the router fail to
22018 deliver at the first attempt, the failing addresses are added to the message as
22019 &"top level"& addresses, and the parent address that generated them is marked
22020 &"delivered"&. Thus, redirection does not happen again at the next delivery
22021 attempt.
22022
22023 &*Warning 1*&: Any header line addition or removal that is specified by this
22024 router would be lost if delivery did not succeed at the first attempt. For this
22025 reason, the &%headers_add%& and &%headers_remove%& generic options are not
22026 permitted when &%one_time%& is set.
22027
22028 &*Warning 2*&: To ensure that the router generates only addresses (as opposed
22029 to pipe or file deliveries or auto-replies) &%forbid_file%&, &%forbid_pipe%&,
22030 and &%forbid_filter_reply%& are forced to be true when &%one_time%& is set.
22031
22032 &*Warning 3*&: The &%unseen%& generic router option may not be set with
22033 &%one_time%&.
22034
22035 The original top-level address is remembered with each of the generated
22036 addresses, and is output in any log messages. However, any intermediate parent
22037 addresses are not recorded. This makes a difference to the log only if
22038 &%all_parents%& log selector is set. It is expected that &%one_time%& will
22039 typically be used for mailing lists, where there is normally just one level of
22040 expansion.
22041
22042
22043 .option owners redirect "string list" unset
22044 .cindex "ownership" "alias file"
22045 .cindex "ownership" "forward file"
22046 .cindex "alias file" "ownership"
22047 .cindex "forward file" "ownership"
22048 This specifies a list of permitted owners for the file specified by &%file%&.
22049 This list is in addition to the local user when &%check_local_user%& is set.
22050 See &%check_owner%& above.
22051
22052
22053 .option owngroups redirect "string list" unset
22054 This specifies a list of permitted groups for the file specified by &%file%&.
22055 The list is in addition to the local user's primary group when
22056 &%check_local_user%& is set. See &%check_group%& above.
22057
22058
22059 .option pipe_transport redirect string&!! unset
22060 .vindex "&$address_pipe$&"
22061 A &(redirect)& router sets up a direct delivery to a pipe when a string
22062 starting with a vertical bar character is specified as a new &"address"&. The
22063 transport used is specified by this option, which, after expansion, must be the
22064 name of a configured transport. This should normally be a &(pipe)& transport.
22065 When the transport is run, the pipe command is in &$address_pipe$&.
22066
22067
22068 .option qualify_domain redirect string&!! unset
22069 .vindex "&$qualify_recipient$&"
22070 If this option is set, and an unqualified address (one without a domain) is
22071 generated, and that address would normally be qualified by the global setting
22072 in &%qualify_recipient%&, it is instead qualified with the domain specified by
22073 expanding this string. If the expansion fails, the router declines. If you want
22074 to revert to the default, you can have the expansion generate
22075 &$qualify_recipient$&.
22076
22077 This option applies to all unqualified addresses generated by Exim filters,
22078 but for traditional &_.forward_& files, it applies only to addresses that are
22079 not preceded by a backslash. Sieve filters cannot generate unqualified
22080 addresses.
22081
22082 .option qualify_preserve_domain redirect boolean false
22083 .cindex "domain" "in redirection; preserving"
22084 .cindex "preserving domain in redirection"
22085 .cindex "address redirection" "domain; preserving"
22086 If this option is set, the router's local &%qualify_domain%& option must not be
22087 set (a configuration error occurs if it is). If an unqualified address (one
22088 without a domain) is generated, it is qualified with the domain of the parent
22089 address (the immediately preceding ancestor) instead of the global
22090 &%qualify_recipient%& value. In the case of a traditional &_.forward_& file,
22091 this applies whether or not the address is preceded by a backslash.
22092
22093
22094 .option repeat_use redirect boolean true
22095 If this option is set false, the router is skipped for a child address that has
22096 any ancestor that was routed by this router. This test happens before any of
22097 the other preconditions are tested. Exim's default anti-looping rules skip
22098 only when the ancestor is the same as the current address. See also
22099 &%check_ancestor%& above and the generic &%redirect_router%& option.
22100
22101
22102 .option reply_transport redirect string&!! unset
22103 A &(redirect)& router sets up an automatic reply when a &%mail%& or
22104 &%vacation%& command is used in a filter file. The transport used is specified
22105 by this option, which, after expansion, must be the name of a configured
22106 transport. This should normally be an &(autoreply)& transport. Other transports
22107 are unlikely to do anything sensible or useful.
22108
22109
22110 .option rewrite redirect boolean true
22111 .cindex "address redirection" "disabling rewriting"
22112 If this option is set false, addresses generated by the router are not
22113 subject to address rewriting. Otherwise, they are treated like new addresses
22114 and are rewritten according to the global rewriting rules.
22115
22116
22117 .option sieve_subaddress redirect string&!! unset
22118 The value of this option is passed to a Sieve filter to specify the
22119 :subaddress part of an address.
22120
22121 .option sieve_useraddress redirect string&!! unset
22122 The value of this option is passed to a Sieve filter to specify the :user part
22123 of an address. However, if it is unset, the entire original local part
22124 (including any prefix or suffix) is used for :user.
22125
22126
22127 .option sieve_vacation_directory redirect string&!! unset
22128 .cindex "Sieve filter" "vacation directory"
22129 To enable the &"vacation"& extension for Sieve filters, you must set
22130 &%sieve_vacation_directory%& to the directory where vacation databases are held
22131 (do not put anything else in that directory), and ensure that the
22132 &%reply_transport%& option refers to an &(autoreply)& transport. Each user
22133 needs their own directory; Exim will create it if necessary.
22134
22135
22136
22137 .option skip_syntax_errors redirect boolean false
22138 .cindex "forward file" "broken"
22139 .cindex "address redirection" "broken files"
22140 .cindex "alias file" "broken"
22141 .cindex "broken alias or forward files"
22142 .cindex "ignoring faulty addresses"
22143 .cindex "skipping faulty addresses"
22144 .cindex "error" "skipping bad syntax"
22145 If &%skip_syntax_errors%& is set, syntactically malformed addresses in
22146 non-filter redirection data are skipped, and each failing address is logged. If
22147 &%syntax_errors_to%& is set, a message is sent to the address it defines,
22148 giving details of the failures. If &%syntax_errors_text%& is set, its contents
22149 are expanded and placed at the head of the error message generated by
22150 &%syntax_errors_to%&. Usually it is appropriate to set &%syntax_errors_to%& to
22151 be the same address as the generic &%errors_to%& option. The
22152 &%skip_syntax_errors%& option is often used when handling mailing lists.
22153
22154 If all the addresses in a redirection list are skipped because of syntax
22155 errors, the router declines to handle the original address, and it is passed to
22156 the following routers.
22157
22158 If &%skip_syntax_errors%& is set when an Exim filter is interpreted, any syntax
22159 error in the filter causes filtering to be abandoned without any action being
22160 taken. The incident is logged, and the router declines to handle the address,
22161 so it is passed to the following routers.
22162
22163 .cindex "Sieve filter" "syntax errors in"
22164 Syntax errors in a Sieve filter file cause the &"keep"& action to occur. This
22165 action is specified by RFC 3028. The values of &%skip_syntax_errors%&,
22166 &%syntax_errors_to%&, and &%syntax_errors_text%& are not used.
22167
22168 &%skip_syntax_errors%& can be used to specify that errors in users' forward
22169 lists or filter files should not prevent delivery. The &%syntax_errors_to%&
22170 option, used with an address that does not get redirected, can be used to
22171 notify users of these errors, by means of a router like this:
22172 .code
22173 userforward:
22174   driver = redirect
22175   allow_filter
22176   check_local_user
22177   file = $home/.forward
22178   file_transport = address_file
22179   pipe_transport = address_pipe
22180   reply_transport = address_reply
22181   no_verify
22182   skip_syntax_errors
22183   syntax_errors_to = real-$local_part@$domain
22184   syntax_errors_text = \
22185    This is an automatically generated message. An error has\n\
22186    been found in your .forward file. Details of the error are\n\
22187    reported below. While this error persists, you will receive\n\
22188    a copy of this message for every message that is addressed\n\
22189    to you. If your .forward file is a filter file, or if it is\n\
22190    a non-filter file containing no valid forwarding addresses,\n\
22191    a copy of each incoming message will be put in your normal\n\
22192    mailbox. If a non-filter file contains at least one valid\n\
22193    forwarding address, forwarding to the valid addresses will\n\
22194    happen, and those will be the only deliveries that occur.
22195 .endd
22196 You also need a router to ensure that local addresses that are prefixed by
22197 &`real-`& are recognized, but not forwarded or filtered. For example, you could
22198 put this immediately before the &(userforward)& router:
22199 .code
22200 real_localuser:
22201   driver = accept
22202   check_local_user
22203   local_part_prefix = real-
22204   transport = local_delivery
22205 .endd
22206 For security, it would probably be a good idea to restrict the use of this
22207 router to locally-generated messages, using a condition such as this:
22208 .code
22209   condition = ${if match {$sender_host_address}\
22210                          {\N^(|127\.0\.0\.1)$\N}}
22211 .endd
22212
22213
22214 .option syntax_errors_text redirect string&!! unset
22215 See &%skip_syntax_errors%& above.
22216
22217
22218 .option syntax_errors_to redirect string unset
22219 See &%skip_syntax_errors%& above.
22220 .ecindex IIDredrou1
22221 .ecindex IIDredrou2
22222
22223
22224
22225
22226
22227
22228 . ////////////////////////////////////////////////////////////////////////////
22229 . ////////////////////////////////////////////////////////////////////////////
22230
22231 .chapter "Environment for running local transports" "CHAPenvironment" &&&
22232          "Environment for local transports"
22233 .scindex IIDenvlotra1 "local transports" "environment for"
22234 .scindex IIDenvlotra2 "environment" "local transports"
22235 .scindex IIDenvlotra3 "transport" "local; environment for"
22236 Local transports handle deliveries to files and pipes. (The &(autoreply)&
22237 transport can be thought of as similar to a pipe.) Exim always runs transports
22238 in subprocesses, under specified uids and gids. Typical deliveries to local
22239 mailboxes run under the uid and gid of the local user.
22240
22241 Exim also sets a specific current directory while running the transport; for
22242 some transports a home directory setting is also relevant. The &(pipe)&
22243 transport is the only one that sets up environment variables; see section
22244 &<<SECTpipeenv>>& for details.
22245
22246 The values used for the uid, gid, and the directories may come from several
22247 different places. In many cases, the router that handles the address associates
22248 settings with that address as a result of its &%check_local_user%&, &%group%&,
22249 or &%user%& options. However, values may also be given in the transport's own
22250 configuration, and these override anything that comes from the router.
22251
22252
22253
22254 .section "Concurrent deliveries" "SECID131"
22255 .cindex "concurrent deliveries"
22256 .cindex "simultaneous deliveries"
22257 If two different messages for the same local recipient arrive more or less
22258 simultaneously, the two delivery processes are likely to run concurrently. When
22259 the &(appendfile)& transport is used to write to a file, Exim applies locking
22260 rules to stop concurrent processes from writing to the same file at the same
22261 time.
22262
22263 However, when you use a &(pipe)& transport, it is up to you to arrange any
22264 locking that is needed. Here is a silly example:
22265 .code
22266 my_transport:
22267   driver = pipe
22268   command = /bin/sh -c 'cat >>/some/file'
22269 .endd
22270 This is supposed to write the message at the end of the file. However, if two
22271 messages arrive at the same time, the file will be scrambled. You can use the
22272 &%exim_lock%& utility program (see section &<<SECTmailboxmaint>>&) to lock a
22273 file using the same algorithm that Exim itself uses.
22274
22275
22276
22277
22278 .section "Uids and gids" "SECTenvuidgid"
22279 .cindex "local transports" "uid and gid"
22280 .cindex "transport" "local; uid and gid"
22281 All transports have the options &%group%& and &%user%&. If &%group%& is set, it
22282 overrides any group that the router set in the address, even if &%user%& is not
22283 set for the transport. This makes it possible, for example, to run local mail
22284 delivery under the uid of the recipient (set by the router), but in a special
22285 group (set by the transport). For example:
22286 .code
22287 # Routers ...
22288 # User/group are set by check_local_user in this router
22289 local_users:
22290   driver = accept
22291   check_local_user
22292   transport = group_delivery
22293
22294 # Transports ...
22295 # This transport overrides the group
22296 group_delivery:
22297   driver = appendfile
22298   file = /var/spool/mail/$local_part_data
22299   group = mail
22300 .endd
22301 If &%user%& is set for a transport, its value overrides what is set in the
22302 address by the router. If &%user%& is non-numeric and &%group%& is not set, the
22303 gid associated with the user is used. If &%user%& is numeric, &%group%& must be
22304 set.
22305
22306 .oindex "&%initgroups%&"
22307 When the uid is taken from the transport's configuration, the &[initgroups()]&
22308 function is called for the groups associated with that uid if the
22309 &%initgroups%& option is set for the transport. When the uid is not specified
22310 by the transport, but is associated with the address by a router, the option
22311 for calling &[initgroups()]& is taken from the router configuration.
22312
22313 .cindex "&(pipe)& transport" "uid for"
22314 The &(pipe)& transport contains the special option &%pipe_as_creator%&. If this
22315 is set and &%user%& is not set, the uid of the process that called Exim to
22316 receive the message is used, and if &%group%& is not set, the corresponding
22317 original gid is also used.
22318
22319 This is the detailed preference order for obtaining a gid; the first of the
22320 following that is set is used:
22321
22322 .ilist
22323 A &%group%& setting of the transport;
22324 .next
22325 A &%group%& setting of the router;
22326 .next
22327 A gid associated with a user setting of the router, either as a result of
22328 &%check_local_user%& or an explicit non-numeric &%user%& setting;
22329 .next
22330 The group associated with a non-numeric &%user%& setting of the transport;
22331 .next
22332 In a &(pipe)& transport, the creator's gid if &%deliver_as_creator%& is set and
22333 the uid is the creator's uid;
22334 .next
22335 The Exim gid if the Exim uid is being used as a default.
22336 .endlist
22337
22338 If, for example, the user is specified numerically on the router and there are
22339 no group settings, no gid is available. In this situation, an error occurs.
22340 This is different for the uid, for which there always is an ultimate default.
22341 The first of the following that is set is used:
22342
22343 .ilist
22344 A &%user%& setting of the transport;
22345 .next
22346 In a &(pipe)& transport, the creator's uid if &%deliver_as_creator%& is set;
22347 .next
22348 A &%user%& setting of the router;
22349 .next
22350 A &%check_local_user%& setting of the router;
22351 .next
22352 The Exim uid.
22353 .endlist
22354
22355 Of course, an error will still occur if the uid that is chosen is on the
22356 &%never_users%& list.
22357
22358
22359
22360
22361
22362 .section "Current and home directories" "SECID132"
22363 .cindex "current directory for local transport"
22364 .cindex "home directory" "for local transport"
22365 .cindex "transport" "local; home directory for"
22366 .cindex "transport" "local; current directory for"
22367 Routers may set current and home directories for local transports by means of
22368 the &%transport_current_directory%& and &%transport_home_directory%& options.
22369 However, if the transport's &%current_directory%& or &%home_directory%& options
22370 are set, they override the router's values. In detail, the home directory
22371 for a local transport is taken from the first of these values that is set:
22372
22373 .ilist
22374 The &%home_directory%& option on the transport;
22375 .next
22376 The &%transport_home_directory%& option on the router;
22377 .next
22378 The password data if &%check_local_user%& is set on the router;
22379 .next
22380 The &%router_home_directory%& option on the router.
22381 .endlist
22382
22383 The current directory is taken from the first of these values that is set:
22384
22385 .ilist
22386 The &%current_directory%& option on the transport;
22387 .next
22388 The &%transport_current_directory%& option on the router.
22389 .endlist
22390
22391
22392 If neither the router nor the transport sets a current directory, Exim uses the
22393 value of the home directory, if it is set. Otherwise it sets the current
22394 directory to &_/_& before running a local transport.
22395
22396
22397
22398 .section "Expansion variables derived from the address" "SECID133"
22399 .vindex "&$domain$&"
22400 .vindex "&$local_part$&"
22401 .vindex "&$original_domain$&"
22402 Normally a local delivery is handling a single address, and in that case the
22403 variables such as &$domain$& and &$local_part$& are set during local
22404 deliveries. However, in some circumstances more than one address may be handled
22405 at once (for example, while writing batch SMTP for onward transmission by some
22406 other means). In this case, the variables associated with the local part are
22407 never set, &$domain$& is set only if all the addresses have the same domain,
22408 and &$original_domain$& is never set.
22409 .ecindex IIDenvlotra1
22410 .ecindex IIDenvlotra2
22411 .ecindex IIDenvlotra3
22412
22413
22414
22415
22416
22417
22418
22419 . ////////////////////////////////////////////////////////////////////////////
22420 . ////////////////////////////////////////////////////////////////////////////
22421
22422 .chapter "Generic options for transports" "CHAPtransportgeneric"
22423 .scindex IIDgenoptra1 "generic options" "transport"
22424 .scindex IIDgenoptra2 "options" "generic; for transports"
22425 .scindex IIDgenoptra3 "transport" "generic options for"
22426 .new
22427 The name of a transport is limited to be &drivernamemax; ASCII characters long;
22428 prior to Exim 4.95 names would be silently truncated at this length, but now
22429 it is enforced.
22430 .wen
22431
22432 The following generic options apply to all transports:
22433
22434
22435 .option body_only transports boolean false
22436 .cindex "transport" "body only"
22437 .cindex "message" "transporting body only"
22438 .cindex "body of message" "transporting"
22439 If this option is set, the message's headers are not transported. It is
22440 mutually exclusive with &%headers_only%&. If it is used with the &(appendfile)&
22441 or &(pipe)& transports, the settings of &%message_prefix%& and
22442 &%message_suffix%& should be checked, because this option does not
22443 automatically suppress them.
22444
22445
22446 .option current_directory transports string&!! unset
22447 .cindex "transport" "current directory for"
22448 This specifies the current directory that is to be set while running the
22449 transport, overriding any value that may have been set by the router.
22450 If the expansion fails for any reason, including forced failure, an error is
22451 logged, and delivery is deferred.
22452
22453
22454 .option disable_logging transports boolean false
22455 If this option is set true, nothing is logged for any
22456 deliveries by the transport or for any
22457 transport errors. You should not set this option unless you really, really know
22458 what you are doing.
22459
22460
22461 .option debug_print transports string&!! unset
22462 .cindex "testing" "variables in drivers"
22463 If this option is set and debugging is enabled (see the &%-d%& command line
22464 option), the string is expanded and included in the debugging output when the
22465 transport is run.
22466 If expansion of the string fails, the error message is written to the debugging
22467 output, and Exim carries on processing.
22468 This facility is provided to help with checking out the values of variables and
22469 so on when debugging driver configurations. For example, if a &%headers_add%&
22470 option is not working properly, &%debug_print%& could be used to output the
22471 variables it references. A newline is added to the text if it does not end with
22472 one.
22473 The variables &$transport_name$& and &$router_name$& contain the name of the
22474 transport and the router that called it.
22475
22476 .option delivery_date_add transports boolean false
22477 .cindex "&'Delivery-date:'& header line"
22478 If this option is true, a &'Delivery-date:'& header is added to the message.
22479 This gives the actual time the delivery was made. As this is not a standard
22480 header, Exim has a configuration option (&%delivery_date_remove%&) which
22481 requests its removal from incoming messages, so that delivered messages can
22482 safely be resent to other recipients.
22483
22484
22485 .option driver transports string unset
22486 This specifies which of the available transport drivers is to be used.
22487 There is no default, and this option must be set for every transport.
22488
22489
22490 .option envelope_to_add transports boolean false
22491 .cindex "&'Envelope-to:'& header line"
22492 If this option is true, an &'Envelope-to:'& header is added to the message.
22493 This gives the original address(es) in the incoming envelope that caused this
22494 delivery to happen. More than one address may be present if the transport is
22495 configured to handle several addresses at once, or if more than one original
22496 address was redirected to the same final address. As this is not a standard
22497 header, Exim has a configuration option (&%envelope_to_remove%&) which requests
22498 its removal from incoming messages, so that delivered messages can safely be
22499 resent to other recipients.
22500
22501
22502 .option event_action transports string&!! unset
22503 .cindex events
22504 This option declares a string to be expanded for Exim's events mechanism.
22505 For details see chapter &<<CHAPevents>>&.
22506
22507
22508 .option group transports string&!! "Exim group"
22509 .cindex "transport" "group; specifying"
22510 This option specifies a gid for running the transport process, overriding any
22511 value that the router supplies, and also overriding any value associated with
22512 &%user%& (see below).
22513
22514
22515 .option headers_add transports list&!! unset
22516 .cindex "header lines" "adding in transport"
22517 .cindex "transport" "header lines; adding"
22518 This option specifies a list of text headers,
22519 newline-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
22520 which are (separately) expanded and added to the header
22521 portion of a message as it is transported, as described in section
22522 &<<SECTheadersaddrem>>&. Additional header lines can also be specified by
22523 routers. If the result of the expansion is an empty string, or if the expansion
22524 is forced to fail, no action is taken. Other expansion failures are treated as
22525 errors and cause the delivery to be deferred.
22526
22527 Unlike most options, &%headers_add%& can be specified multiple times
22528 for a transport; all listed headers are added.
22529
22530
22531 .option headers_only transports boolean false
22532 .cindex "transport" "header lines only"
22533 .cindex "message" "transporting headers only"
22534 .cindex "header lines" "transporting"
22535 If this option is set, the message's body is not transported. It is mutually
22536 exclusive with &%body_only%&. If it is used with the &(appendfile)& or &(pipe)&
22537 transports, the settings of &%message_prefix%& and &%message_suffix%& should be
22538 checked, since this option does not automatically suppress them.
22539
22540
22541 .option headers_remove transports list&!! unset
22542 .cindex "header lines" "removing"
22543 .cindex "transport" "header lines; removing"
22544 This option specifies a list of text headers,
22545 colon-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
22546 to be removed from the message.
22547 However, the option has no effect when an address is just being verified.
22548 Each list item is separately expanded.
22549 If the result of the expansion is an empty string, or if the expansion
22550 is forced to fail, no action is taken. Other expansion failures are treated as
22551 errors and cause the delivery to be deferred.
22552 If an item ends in *, it will match any header with the given prefix.
22553
22554 Matching headers are omitted from the message as it is transported, as described
22555 in section &<<SECTheadersaddrem>>&. Header removal can also be specified by
22556 routers.
22557
22558 Unlike most options, &%headers_remove%& can be specified multiple times
22559 for a transport; all listed headers are removed.
22560
22561 &*Warning*&: Because of the separate expansion of the list items,
22562 items that contain a list separator must have it doubled.
22563 To avoid this, change the list separator (&<<SECTlistsepchange>>&).
22564
22565
22566
22567 .option headers_rewrite transports string unset
22568 .cindex "transport" "header lines; rewriting"
22569 .cindex "rewriting" "at transport time"
22570 This option allows addresses in header lines to be rewritten at transport time,
22571 that is, as the message is being copied to its destination. The contents of the
22572 option are a colon-separated list of rewriting rules. Each rule is in exactly
22573 the same form as one of the general rewriting rules that are applied when a
22574 message is received. These are described in chapter &<<CHAPrewrite>>&. For
22575 example,
22576 .code
22577 headers_rewrite = a@b c@d f : \
22578                   x@y w@z
22579 .endd
22580 changes &'a@b'& into &'c@d'& in &'From:'& header lines, and &'x@y'& into
22581 &'w@z'& in all address-bearing header lines. The rules are applied to the
22582 header lines just before they are written out at transport time, so they affect
22583 only those copies of the message that pass through the transport. However, only
22584 the message's original header lines, and any that were added by a system
22585 filter, are rewritten. If a router or transport adds header lines, they are not
22586 affected by this option. These rewriting rules are &'not'& applied to the
22587 envelope. You can change the return path using &%return_path%&, but you cannot
22588 change envelope recipients at this time.
22589
22590
22591 .option home_directory transports string&!! unset
22592 .cindex "transport" "home directory for"
22593 .vindex "&$home$&"
22594 This option specifies a home directory setting for a local transport,
22595 overriding any value that may be set by the router. The home directory is
22596 placed in &$home$& while expanding the transport's private options. It is also
22597 used as the current directory if no current directory is set by the
22598 &%current_directory%& option on the transport or the
22599 &%transport_current_directory%& option on the router. If the expansion fails
22600 for any reason, including forced failure, an error is logged, and delivery is
22601 deferred.
22602
22603
22604 .option initgroups transports boolean false
22605 .cindex "additional groups"
22606 .cindex "groups" "additional"
22607 .cindex "transport" "group; additional"
22608 If this option is true and the uid for the delivery process is provided by the
22609 transport, the &[initgroups()]& function is called when running the transport
22610 to ensure that any additional groups associated with the uid are set up.
22611
22612
22613 .option max_parallel transports integer&!! unset
22614 .cindex limit "transport parallelism"
22615 .cindex transport "parallel processes"
22616 .cindex transport "concurrency limit"
22617 .cindex "delivery" "parallelism for transport"
22618 If this option is set and expands to an integer greater than zero
22619 it limits the number of concurrent runs of the transport.
22620 The control does not apply to shadow transports.
22621
22622 .cindex "hints database" "transport concurrency control"
22623 Exim implements this control by means of a hints database in which a record is
22624 incremented whenever a transport process is being created. The record
22625 is decremented and possibly removed when the process terminates.
22626 Obviously there is scope for
22627 records to get left lying around if there is a system or program crash. To
22628 guard against this, Exim ignores any records that are more than six hours old.
22629
22630 If you use this option, you should also arrange to delete the
22631 relevant hints database whenever your system reboots. The names of the files
22632 start with &_misc_& and they are kept in the &_spool/db_& directory. There
22633 may be one or two files, depending on the type of DBM in use. The same files
22634 are used for ETRN and smtp transport serialization.
22635
22636
22637 .option message_size_limit transports string&!! 0
22638 .cindex "limit" "message size per transport"
22639 .cindex "size" "of message, limit"
22640 .cindex "transport" "message size; limiting"
22641 This option controls the size of messages passed through the transport. It is
22642 expanded before use; the result of the expansion must be a sequence of decimal
22643 digits, optionally followed by K or M. If the expansion fails for any reason,
22644 including forced failure, or if the result is not of the required form,
22645 delivery is deferred. If the value is greater than zero and the size of a
22646 message exceeds this limit, the address is failed. If there is any chance that
22647 the resulting bounce message could be routed to the same transport, you should
22648 ensure that &%return_size_limit%& is less than the transport's
22649 &%message_size_limit%&, as otherwise the bounce message will fail to get
22650 delivered.
22651
22652
22653
22654 .option rcpt_include_affixes transports boolean false
22655 .cindex "prefix" "for local part, including in envelope"
22656 .cindex "suffix for local part" "including in envelope"
22657 .cindex "local part" "prefix"
22658 .cindex "local part" "suffix"
22659 When this option is false (the default), and an address that has had any
22660 affixes (prefixes or suffixes) removed from the local part is delivered by any
22661 form of SMTP or LMTP, the affixes are not included. For example, if a router
22662 that contains
22663 .code
22664 local_part_prefix = *-
22665 .endd
22666 routes the address &'abc-xyz@some.domain'& to an SMTP transport, the envelope
22667 is delivered with
22668 .code
22669 RCPT TO:<xyz@some.domain>
22670 .endd
22671 This is also the case when an ACL-time callout is being used to verify a
22672 recipient address. However, if &%rcpt_include_affixes%& is set true, the
22673 whole local part is included in the RCPT command. This option applies to BSMTP
22674 deliveries by the &(appendfile)& and &(pipe)& transports as well as to the
22675 &(lmtp)& and &(smtp)& transports.
22676
22677
22678 .option retry_use_local_part transports boolean "see below"
22679 .cindex "hints database" "retry keys"
22680 When a delivery suffers a temporary failure, a retry record is created
22681 in Exim's hints database. For remote deliveries, the key for the retry record
22682 is based on the name and/or IP address of the failing remote host. For local
22683 deliveries, the key is normally the entire address, including both the local
22684 part and the domain. This is suitable for most common cases of local delivery
22685 temporary failure &-- for example, exceeding a mailbox quota should delay only
22686 deliveries to that mailbox, not to the whole domain.
22687
22688 However, in some special cases you may want to treat a temporary local delivery
22689 as a failure associated with the domain, and not with a particular local part.
22690 (For example, if you are storing all mail for some domain in files.) You can do
22691 this by setting &%retry_use_local_part%& false.
22692
22693 For all the local transports, its default value is true. For remote transports,
22694 the default value is false for tidiness, but changing the value has no effect
22695 on a remote transport in the current implementation.
22696
22697
22698 .option return_path transports string&!! unset
22699 .cindex "envelope sender"
22700 .cindex "envelope from"
22701 .cindex "transport" "return path; changing"
22702 .cindex "return path" "changing in transport"
22703 If this option is set, the string is expanded at transport time and replaces
22704 the existing return path (envelope sender) value in the copy of the message
22705 that is being delivered. An empty return path is permitted. This feature is
22706 designed for remote deliveries, where the value of this option is used in the
22707 SMTP MAIL command. If you set &%return_path%& for a local transport, the
22708 only effect is to change the address that is placed in the &'Return-path:'&
22709 header line, if one is added to the message (see the next option).
22710
22711 &*Note:*& A changed return path is not logged unless you add
22712 &%return_path_on_delivery%& to the log selector.
22713
22714 .vindex "&$return_path$&"
22715 The expansion can refer to the existing value via &$return_path$&. This is
22716 either the message's envelope sender, or an address set by the
22717 &%errors_to%& option on a router. If the expansion is forced to fail, no
22718 replacement occurs; if it fails for another reason, delivery is deferred. This
22719 option can be used to support VERP (Variable Envelope Return Paths) &-- see
22720 section &<<SECTverp>>&.
22721
22722 &*Note*&: If a delivery error is detected locally, including the case when a
22723 remote server rejects a message at SMTP time, the bounce message is not sent to
22724 the value of this option. It is sent to the previously set errors address.
22725 This defaults to the incoming sender address, but can be changed by setting
22726 &%errors_to%& in a router.
22727
22728
22729
22730 .option return_path_add transports boolean false
22731 .chindex Return-path:
22732 If this option is true, a &'Return-path:'& header is added to the message.
22733 Although the return path is normally available in the prefix line of BSD
22734 mailboxes, this is commonly not displayed by MUAs, and so the user does not
22735 have easy access to it.
22736
22737 RFC 2821 states that the &'Return-path:'& header is added to a message &"when
22738 the delivery SMTP server makes the final delivery"&. This implies that this
22739 header should not be present in incoming messages. Exim has a configuration
22740 option, &%return_path_remove%&, which requests removal of this header from
22741 incoming messages, so that delivered messages can safely be resent to other
22742 recipients.
22743
22744
22745 .option shadow_condition transports string&!! unset
22746 See &%shadow_transport%& below.
22747
22748
22749 .option shadow_transport transports string unset
22750 .cindex "shadow transport"
22751 .cindex "transport" "shadow"
22752 A local transport may set the &%shadow_transport%& option to the name of
22753 another local transport. Shadow remote transports are not supported.
22754
22755 Whenever a delivery to the main transport succeeds, and either
22756 &%shadow_condition%& is unset, or its expansion does not result in the empty
22757 string or one of the strings &"0"& or &"no"& or &"false"&, the message is also
22758 passed to the shadow transport, with the same delivery address or addresses. If
22759 expansion fails, no action is taken except that non-forced expansion failures
22760 cause a log line to be written.
22761
22762 The result of the shadow transport is discarded and does not affect the
22763 subsequent processing of the message. Only a single level of shadowing is
22764 provided; the &%shadow_transport%& option is ignored on any transport when it
22765 is running as a shadow. Options concerned with output from pipes are also
22766 ignored. The log line for the successful delivery has an item added on the end,
22767 of the form
22768 .code
22769 ST=<shadow transport name>
22770 .endd
22771 If the shadow transport did not succeed, the error message is put in
22772 parentheses afterwards. Shadow transports can be used for a number of different
22773 purposes, including keeping more detailed log information than Exim normally
22774 provides, and implementing automatic acknowledgment policies based on message
22775 headers that some sites insist on.
22776
22777
22778 .option transport_filter transports string&!! unset
22779 .cindex "transport" "filter"
22780 .cindex "filter" "transport filter"
22781 This option sets up a filtering (in the Unix shell sense) process for messages
22782 at transport time. It should not be confused with mail filtering as set up by
22783 individual users or via a system filter.
22784 If unset, or expanding to an empty string, no filtering is done.
22785
22786 When the message is about to be written out, the command specified by
22787 &%transport_filter%& is started up in a separate, parallel process, and
22788 the entire message, including the header lines, is passed to it on its standard
22789 input (this in fact is done from a third process, to avoid deadlock). The
22790 command must be specified as an absolute path.
22791
22792 The lines of the message that are written to the transport filter are
22793 terminated by newline (&"\n"&). The message is passed to the filter before any
22794 SMTP-specific processing, such as turning &"\n"& into &"\r\n"& and escaping
22795 lines beginning with a dot, and also before any processing implied by the
22796 settings of &%check_string%& and &%escape_string%& in the &(appendfile)& or
22797 &(pipe)& transports.
22798
22799 The standard error for the filter process is set to the same destination as its
22800 standard output; this is read and written to the message's ultimate
22801 destination. The process that writes the message to the filter, the
22802 filter itself, and the original process that reads the result and delivers it
22803 are all run in parallel, like a shell pipeline.
22804
22805 The filter can perform any transformations it likes, but of course should take
22806 care not to break RFC 2822 syntax. Exim does not check the result, except to
22807 test for a final newline when SMTP is in use. All messages transmitted over
22808 SMTP must end with a newline, so Exim supplies one if it is missing.
22809
22810 .cindex "content scanning" "per user"
22811 A transport filter can be used to provide content-scanning on a per-user basis
22812 at delivery time if the only required effect of the scan is to modify the
22813 message. For example, a content scan could insert a new header line containing
22814 a spam score. This could be interpreted by a filter in the user's MUA. It is
22815 not possible to discard a message at this stage.
22816
22817 .cindex "SIZE" "ESMTP extension"
22818 A problem might arise if the filter increases the size of a message that is
22819 being sent down an SMTP connection. If the receiving SMTP server has indicated
22820 support for the SIZE parameter, Exim will have sent the size of the message
22821 at the start of the SMTP session. If what is actually sent is substantially
22822 more, the server might reject the message. This can be worked round by setting
22823 the &%size_addition%& option on the &(smtp)& transport, either to allow for
22824 additions to the message, or to disable the use of SIZE altogether.
22825
22826 .vindex "&$pipe_addresses$&"
22827 The value of the &%transport_filter%& option is the command string for starting
22828 the filter, which is run directly from Exim, not under a shell. The string is
22829 parsed by Exim in the same way as a command string for the &(pipe)& transport:
22830 Exim breaks it up into arguments and then expands each argument separately (see
22831 section &<<SECThowcommandrun>>&). Any kind of expansion failure causes delivery
22832 to be deferred. The special argument &$pipe_addresses$& is replaced by a number
22833 of arguments, one for each address that applies to this delivery. (This isn't
22834 an ideal name for this feature here, but as it was already implemented for the
22835 &(pipe)& transport, it seemed sensible not to change it.)
22836
22837 .vindex "&$host$&"
22838 .vindex "&$host_address$&"
22839 The expansion variables &$host$& and &$host_address$& are available when the
22840 transport is a remote one. They contain the name and IP address of the host to
22841 which the message is being sent. For example:
22842 .code
22843 transport_filter = /some/directory/transport-filter.pl \
22844   $host $host_address $sender_address $pipe_addresses
22845 .endd
22846
22847 Two problems arise if you want to use more complicated expansion items to
22848 generate transport filter commands, both of which due to the fact that the
22849 command is split up &'before'& expansion.
22850 .ilist
22851 If an expansion item contains white space, you must quote it, so that it is all
22852 part of the same command item. If the entire option setting is one such
22853 expansion item, you have to take care what kind of quoting you use. For
22854 example:
22855 .code
22856 transport_filter = '/bin/cmd${if eq{$host}{a.b.c}{1}{2}}'
22857 .endd
22858 This runs the command &(/bin/cmd1)& if the host name is &'a.b.c'&, and
22859 &(/bin/cmd2)& otherwise. If double quotes had been used, they would have been
22860 stripped by Exim when it read the option's value. When the value is used, if
22861 the single quotes were missing, the line would be split into two items,
22862 &`/bin/cmd${if`& and &`eq{$host}{a.b.c}{1}{2}`&, and an error would occur when
22863 Exim tried to expand the first one.
22864 .next
22865 Except for the special case of &$pipe_addresses$& that is mentioned above, an
22866 expansion cannot generate multiple arguments, or a command name followed by
22867 arguments. Consider this example:
22868 .code
22869 transport_filter = ${lookup{$host}lsearch{/a/file}\
22870                     {$value}{/bin/cat}}
22871 .endd
22872 The result of the lookup is interpreted as the name of the command, even
22873 if it contains white space. The simplest way round this is to use a shell:
22874 .code
22875 transport_filter = /bin/sh -c ${lookup{$host}lsearch{/a/file}\
22876                                {$value}{/bin/cat}}
22877 .endd
22878 .endlist
22879
22880 The filter process is run under the same uid and gid as the normal delivery.
22881 For remote deliveries this is the Exim uid/gid by default. The command should
22882 normally yield a zero return code. Transport filters are not supposed to fail.
22883 A non-zero code is taken to mean that the transport filter encountered some
22884 serious problem. Delivery of the message is deferred; the message remains on
22885 the queue and is tried again later. It is not possible to cause a message to be
22886 bounced from a transport filter.
22887
22888 If a transport filter is set on an autoreply transport, the original message is
22889 passed through the filter as it is being copied into the newly generated
22890 message, which happens if the &%return_message%& option is set.
22891
22892
22893 .option transport_filter_timeout transports time 5m
22894 .cindex "transport" "filter, timeout"
22895 When Exim is reading the output of a transport filter, it applies a timeout
22896 that can be set by this option. Exceeding the timeout is normally treated as a
22897 temporary delivery failure. However, if a transport filter is used with a
22898 &(pipe)& transport, a timeout in the transport filter is treated in the same
22899 way as a timeout in the pipe command itself. By default, a timeout is a hard
22900 error, but if the &(pipe)& transport's &%timeout_defer%& option is set true, it
22901 becomes a temporary error.
22902
22903
22904 .option user transports string&!! "Exim user"
22905 .cindex "uid (user id)" "local delivery"
22906 .cindex "transport" "user, specifying"
22907 This option specifies the user under whose uid the delivery process is to be
22908 run, overriding any uid that may have been set by the router. If the user is
22909 given as a name, the uid is looked up from the password data, and the
22910 associated group is taken as the value of the gid to be used if the &%group%&
22911 option is not set.
22912
22913 For deliveries that use local transports, a user and group are normally
22914 specified explicitly or implicitly (for example, as a result of
22915 &%check_local_user%&) by the router or transport.
22916
22917 .cindex "hints database" "access by remote transport"
22918 For remote transports, you should leave this option unset unless you really are
22919 sure you know what you are doing. When a remote transport is running, it needs
22920 to be able to access Exim's hints databases, because each host may have its own
22921 retry data.
22922 .ecindex IIDgenoptra1
22923 .ecindex IIDgenoptra2
22924 .ecindex IIDgenoptra3
22925
22926
22927
22928
22929
22930
22931 . ////////////////////////////////////////////////////////////////////////////
22932 . ////////////////////////////////////////////////////////////////////////////
22933
22934 .chapter "Address batching in local transports" "CHAPbatching" &&&
22935          "Address batching"
22936 .cindex "transport" "local; address batching in"
22937 The only remote transport (&(smtp)&) is normally configured to handle more than
22938 one address at a time, so that when several addresses are routed to the same
22939 remote host, just one copy of the message is sent. Local transports, however,
22940 normally handle one address at a time. That is, a separate instance of the
22941 transport is run for each address that is routed to the transport. A separate
22942 copy of the message is delivered each time.
22943
22944 .cindex "batched local delivery"
22945 .oindex "&%batch_max%&"
22946 .oindex "&%batch_id%&"
22947 In special cases, it may be desirable to handle several addresses at once in a
22948 local transport, for example:
22949
22950 .ilist
22951 In an &(appendfile)& transport, when storing messages in files for later
22952 delivery by some other means, a single copy of the message with multiple
22953 recipients saves space.
22954 .next
22955 In an &(lmtp)& transport, when delivering over &"local SMTP"& to some process,
22956 a single copy saves time, and is the normal way LMTP is expected to work.
22957 .next
22958 In a &(pipe)& transport, when passing the message
22959 to a scanner program or
22960 to some other delivery mechanism such as UUCP, multiple recipients may be
22961 acceptable.
22962 .endlist
22963
22964 These three local transports all have the same options for controlling multiple
22965 (&"batched"&) deliveries, namely &%batch_max%& and &%batch_id%&. To save
22966 repeating the information for each transport, these options are described here.
22967
22968 The &%batch_max%& option specifies the maximum number of addresses that can be
22969 delivered together in a single run of the transport. Its default value is one
22970 (no batching). When more than one address is routed to a transport that has a
22971 &%batch_max%& value greater than one, the addresses are delivered in a batch
22972 (that is, in a single run of the transport with multiple recipients), subject
22973 to certain conditions:
22974
22975 .ilist
22976 .vindex "&$local_part$&"
22977 If any of the transport's options contain a reference to &$local_part$&, no
22978 batching is possible.
22979 .next
22980 .vindex "&$domain$&"
22981 If any of the transport's options contain a reference to &$domain$&, only
22982 addresses with the same domain are batched.
22983 .next
22984 .cindex "customizing" "batching condition"
22985 If &%batch_id%& is set, it is expanded for each address, and only those
22986 addresses with the same expanded value are batched. This allows you to specify
22987 customized batching conditions. Failure of the expansion for any reason,
22988 including forced failure, disables batching, but it does not stop the delivery
22989 from taking place.
22990 .next
22991 Batched addresses must also have the same errors address (where to send
22992 delivery errors), the same header additions and removals, the same user and
22993 group for the transport, and if a host list is present, the first host must
22994 be the same.
22995 .endlist
22996
22997 In the case of the &(appendfile)& and &(pipe)& transports, batching applies
22998 both when the file or pipe command is specified in the transport, and when it
22999 is specified by a &(redirect)& router, but all the batched addresses must of
23000 course be routed to the same file or pipe command. These two transports have an
23001 option called &%use_bsmtp%&, which causes them to deliver the message in
23002 &"batched SMTP"& format, with the envelope represented as SMTP commands. The
23003 &%check_string%& and &%escape_string%& options are forced to the values
23004 .code
23005 check_string = "."
23006 escape_string = ".."
23007 .endd
23008 when batched SMTP is in use. A full description of the batch SMTP mechanism is
23009 given in section &<<SECTbatchSMTP>>&. The &(lmtp)& transport does not have a
23010 &%use_bsmtp%& option, because it always delivers using the SMTP protocol.
23011
23012 .cindex "&'Envelope-to:'& header line"
23013 If the generic &%envelope_to_add%& option is set for a batching transport, the
23014 &'Envelope-to:'& header that is added to the message contains all the addresses
23015 that are being processed together. If you are using a batching &(appendfile)&
23016 transport without &%use_bsmtp%&, the only way to preserve the recipient
23017 addresses is to set the &%envelope_to_add%& option.
23018
23019 .cindex "&(pipe)& transport" "with multiple addresses"
23020 .vindex "&$pipe_addresses$&"
23021 If you are using a &(pipe)& transport without BSMTP, and setting the
23022 transport's &%command%& option, you can include &$pipe_addresses$& as part of
23023 the command. This is not a true variable; it is a bit of magic that causes each
23024 of the recipient addresses to be inserted into the command as a separate
23025 argument. This provides a way of accessing all the addresses that are being
23026 delivered in the batch. &*Note:*& This is not possible for pipe commands that
23027 are specified by a &(redirect)& router.
23028
23029
23030
23031
23032 . ////////////////////////////////////////////////////////////////////////////
23033 . ////////////////////////////////////////////////////////////////////////////
23034
23035 .chapter "The appendfile transport" "CHAPappendfile"
23036 .scindex IIDapptra1 "&(appendfile)& transport"
23037 .scindex IIDapptra2 "transports" "&(appendfile)&"
23038 .cindex "directory creation"
23039 .cindex "creating directories"
23040 The &(appendfile)& transport delivers a message by appending it to an existing
23041 file, or by creating an entirely new file in a specified directory. Single
23042 files to which messages are appended can be in the traditional Unix mailbox
23043 format, or optionally in the MBX format supported by the Pine MUA and
23044 University of Washington IMAP daemon, &'inter alia'&. When each message is
23045 being delivered as a separate file, &"maildir"& format can optionally be used
23046 to give added protection against failures that happen part-way through the
23047 delivery. A third form of separate-file delivery known as &"mailstore"& is also
23048 supported. For all file formats, Exim attempts to create as many levels of
23049 directory as necessary, provided that &%create_directory%& is set.
23050
23051 The code for the optional formats is not included in the Exim binary by
23052 default. It is necessary to set SUPPORT_MBX, SUPPORT_MAILDIR and/or
23053 SUPPORT_MAILSTORE in &_Local/Makefile_& to have the appropriate code
23054 included.
23055
23056 .cindex "quota" "system"
23057 Exim recognizes system quota errors, and generates an appropriate message. Exim
23058 also supports its own quota control within the transport, for use when the
23059 system facility is unavailable or cannot be used for some reason.
23060
23061 If there is an error while appending to a file (for example, quota exceeded or
23062 partition filled), Exim attempts to reset the file's length and last
23063 modification time back to what they were before. If there is an error while
23064 creating an entirely new file, the new file is removed.
23065
23066 Before appending to a file, a number of security checks are made, and the
23067 file is locked. A detailed description is given below, after the list of
23068 private options.
23069
23070 The &(appendfile)& transport is most commonly used for local deliveries to
23071 users' mailboxes. However, it can also be used as a pseudo-remote transport for
23072 putting messages into files for remote delivery by some means other than Exim.
23073 &"Batch SMTP"& format is often used in this case (see the &%use_bsmtp%&
23074 option).
23075
23076
23077
23078 .section "The file and directory options" "SECTfildiropt"
23079 The &%file%& option specifies a single file, to which the message is appended;
23080 the &%directory%& option specifies a directory, in which a new file containing
23081 the message is created. Only one of these two options can be set, and for
23082 normal deliveries to mailboxes, one of them &'must'& be set.
23083
23084 .vindex "&$address_file$&"
23085 .vindex "&$local_part$&"
23086 However, &(appendfile)& is also used for delivering messages to files or
23087 directories whose names (or parts of names) are obtained from alias,
23088 forwarding, or filtering operations (for example, a &%save%& command in a
23089 user's Exim filter). When such a transport is running, &$local_part$& contains
23090 the local part that was aliased or forwarded, and &$address_file$& contains the
23091 name (or partial name) of the file or directory generated by the redirection
23092 operation. There are two cases:
23093
23094 .ilist
23095 If neither &%file%& nor &%directory%& is set, the redirection operation
23096 must specify an absolute path (one that begins with &`/`&). This is the most
23097 common case when users with local accounts use filtering to sort mail into
23098 different folders. See for example, the &(address_file)& transport in the
23099 default configuration. If the path ends with a slash, it is assumed to be the
23100 name of a directory. A delivery to a directory can also be forced by setting
23101 &%maildir_format%& or &%mailstore_format%&.
23102 .next
23103 If &%file%& or &%directory%& is set for a delivery from a redirection, it is
23104 used to determine the file or directory name for the delivery. Normally, the
23105 contents of &$address_file$& are used in some way in the string expansion.
23106 .endlist
23107 If the &%create_file%& option is set to a path which
23108 matches (see the option definition below for details)
23109 a file or directory name
23110 for the delivery, that name becomes de-tainted.
23111
23112 .cindex "tainted data" "in filenames"
23113 .cindex appendfile "tainted data"
23114 Tainted data may not be used for a file or directory name.
23115 This means that, for instance, &$local_part$& cannot be used directly
23116 as a component of a path.  It can however be used as the key for a lookup
23117 which returns a path (or component).
23118
23119
23120 .cindex "Sieve filter" "configuring &(appendfile)&"
23121 .cindex "Sieve filter" "relative mailbox path handling"
23122 As an example of the second case, consider an environment where users do not
23123 have home directories. They may be permitted to use Exim filter commands of the
23124 form:
23125 .code
23126 save folder23
23127 .endd
23128 or Sieve filter commands of the form:
23129 .code
23130 require "fileinto";
23131 fileinto "folder23";
23132 .endd
23133 In this situation, the expansion of &%file%& or &%directory%& in the transport
23134 must transform the relative path into an appropriate absolute filename. In the
23135 case of Sieve filters, the name &'inbox'& must be handled. It is the name that
23136 is used as a result of a &"keep"& action in the filter. This example shows one
23137 way of handling this requirement:
23138 .code
23139 file = ${if eq{$address_file}{inbox} \
23140             {/var/mail/$local_part_data} \
23141             {${if eq{${substr_0_1:$address_file}}{/} \
23142                   {$address_file} \
23143                   {$home/mail/$address_file} \
23144             }} \
23145        }
23146 .endd
23147 With this setting of &%file%&, &'inbox'& refers to the standard mailbox
23148 location, absolute paths are used without change, and other folders are in the
23149 &_mail_& directory within the home directory.
23150
23151 &*Note 1*&: While processing an Exim filter, a relative path such as
23152 &_folder23_& is turned into an absolute path if a home directory is known to
23153 the router. In particular, this is the case if &%check_local_user%& is set. If
23154 you want to prevent this happening at routing time, you can set
23155 &%router_home_directory%& empty. This forces the router to pass the relative
23156 path to the transport.
23157
23158 &*Note 2*&: An absolute path in &$address_file$& is not treated specially;
23159 the &%file%& or &%directory%& option is still used if it is set.
23160
23161
23162
23163
23164 .section "Private options for appendfile" "SECID134"
23165 .cindex "options" "&(appendfile)& transport"
23166
23167
23168
23169 .option allow_fifo appendfile boolean false
23170 .cindex "fifo (named pipe)"
23171 .cindex "named pipe (fifo)"
23172 .cindex "pipe" "named (fifo)"
23173 Setting this option permits delivery to named pipes (FIFOs) as well as to
23174 regular files. If no process is reading the named pipe at delivery time, the
23175 delivery is deferred.
23176
23177
23178 .option allow_symlink appendfile boolean false
23179 .cindex "symbolic link" "to mailbox"
23180 .cindex "mailbox" "symbolic link"
23181 By default, &(appendfile)& will not deliver if the path name for the file is
23182 that of a symbolic link. Setting this option relaxes that constraint, but there
23183 are security issues involved in the use of symbolic links. Be sure you know
23184 what you are doing if you set this. Details of exactly what this option affects
23185 are included in the discussion which follows this list of options.
23186
23187
23188 .option batch_id appendfile string&!! unset
23189 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
23190 However, batching is automatically disabled for &(appendfile)& deliveries that
23191 happen as a result of forwarding or aliasing or other redirection directly to a
23192 file.
23193
23194
23195 .option batch_max appendfile integer 1
23196 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
23197
23198
23199 .option check_group appendfile boolean false
23200 When this option is set, the group owner of the file defined by the &%file%&
23201 option is checked to see that it is the same as the group under which the
23202 delivery process is running. The default setting is false because the default
23203 file mode is 0600, which means that the group is irrelevant.
23204
23205
23206 .option check_owner appendfile boolean true
23207 When this option is set, the owner of the file defined by the &%file%& option
23208 is checked to ensure that it is the same as the user under which the delivery
23209 process is running.
23210
23211
23212 .option check_string appendfile string "see below"
23213 .cindex "&""From""& line"
23214 As &(appendfile)& writes the message, the start of each line is tested for
23215 matching &%check_string%&, and if it does, the initial matching characters are
23216 replaced by the contents of &%escape_string%&. The value of &%check_string%& is
23217 a literal string, not a regular expression, and the case of any letters it
23218 contains is significant.
23219
23220 If &%use_bsmtp%& is set the values of &%check_string%& and &%escape_string%&
23221 are forced to &"."& and &".."& respectively, and any settings in the
23222 configuration are ignored. Otherwise, they default to &"From&~"& and
23223 &">From&~"& when the &%file%& option is set, and unset when any of the
23224 &%directory%&, &%maildir%&, or &%mailstore%& options are set.
23225
23226 The default settings, along with &%message_prefix%& and &%message_suffix%&, are
23227 suitable for traditional &"BSD"& mailboxes, where a line beginning with
23228 &"From&~"& indicates the start of a new message. All four options need changing
23229 if another format is used. For example, to deliver to mailboxes in MMDF format:
23230 .cindex "MMDF format mailbox"
23231 .cindex "mailbox" "MMDF format"
23232 .code
23233 check_string = "\1\1\1\1\n"
23234 escape_string = "\1\1\1\1 \n"
23235 message_prefix = "\1\1\1\1\n"
23236 message_suffix = "\1\1\1\1\n"
23237 .endd
23238 .option create_directory appendfile boolean true
23239 .cindex "directory creation"
23240 When this option is true, Exim attempts to create any missing superior
23241 directories for the file that it is about to write. A created directory's mode
23242 is given by the &%directory_mode%& option.
23243
23244 The group ownership of a newly created directory is highly dependent on the
23245 operating system (and possibly the file system) that is being used. For
23246 example, in Solaris, if the parent directory has the setgid bit set, its group
23247 is propagated to the child; if not, the currently set group is used. However,
23248 in FreeBSD, the parent's group is always used.
23249
23250
23251
23252 .option create_file appendfile string anywhere
23253 This option constrains the location of files and directories that are created
23254 by this transport. It applies to files defined by the &%file%& option and
23255 directories defined by the &%directory%& option. In the case of maildir
23256 delivery, it applies to the top level directory, not the maildir directories
23257 beneath.
23258
23259 .new
23260 The option must be set to one of the words &"anywhere"&, &"inhome"&, or
23261 &"belowhome"&, or to an absolute path.
23262 .wen
23263
23264 In the second and third cases, a home directory must have been
23265 set for the transport, and the file or directory being created must
23266 reside within it.
23267 The "belowhome" checking additionally checks for attempts to use "../"
23268 to evade the testing.
23269 This option is not useful when an explicit filename is
23270 given for normal mailbox deliveries. It is intended for the case when filenames
23271 are generated from users' &_.forward_& files. These are usually handled
23272 by an &(appendfile)& transport called &%address_file%&. See also
23273 &%file_must_exist%&.
23274
23275 .new
23276 In the fourth case,
23277 the value given for this option must be an absolute path for an
23278 existing directory.
23279 The value is used for checking instead of a home directory;
23280 checking is done in "belowhome" mode.
23281
23282 .cindex "tainted data" "de-tainting"
23283 If "belowhome" checking is used, the file or directory path
23284 becomes de-tainted.
23285 .wen
23286
23287
23288 .option directory appendfile string&!! unset
23289 This option is mutually exclusive with the &%file%& option, but one of &%file%&
23290 or &%directory%& must be set, unless the delivery is the direct result of a
23291 redirection (see section &<<SECTfildiropt>>&).
23292
23293 When &%directory%& is set, the string is expanded, and the message is delivered
23294 into a new file or files in or below the given directory, instead of being
23295 appended to a single mailbox file. A number of different formats are provided
23296 (see &%maildir_format%& and &%mailstore_format%&), and see section
23297 &<<SECTopdir>>& for further details of this form of delivery.
23298
23299 .new
23300 The result of expansion must not be tainted, unless the &%create_file%& option
23301 specifies a path.
23302 .wen
23303
23304
23305 .option directory_file appendfile string&!! "see below"
23306 .cindex "base62"
23307 .vindex "&$inode$&"
23308 When &%directory%& is set, but neither &%maildir_format%& nor
23309 &%mailstore_format%& is set, &(appendfile)& delivers each message into a file
23310 whose name is obtained by expanding this string. The default value is:
23311 .code
23312 q${base62:$tod_epoch}-$inode
23313 .endd
23314 This generates a unique name from the current time, in base 62 form, and the
23315 inode of the file. The variable &$inode$& is available only when expanding this
23316 option.
23317
23318
23319 .option directory_mode appendfile "octal integer" 0700
23320 If &(appendfile)& creates any directories as a result of the
23321 &%create_directory%& option, their mode is specified by this option.
23322
23323
23324 .option escape_string appendfile string "see description"
23325 See &%check_string%& above.
23326
23327
23328 .option file appendfile string&!! unset
23329 This option is mutually exclusive with the &%directory%& option, but one of
23330 &%file%& or &%directory%& must be set, unless the delivery is the direct result
23331 of a redirection (see section &<<SECTfildiropt>>&). The &%file%& option
23332 specifies a single file, to which the message is appended. One or more of
23333 &%use_fcntl_lock%&, &%use_flock_lock%&, or &%use_lockfile%& must be set with
23334 &%file%&.
23335
23336 .new
23337 The result of expansion must not be tainted, unless the &%create_file%& option
23338 specifies a path.
23339 .wen
23340
23341 .cindex "NFS" "lock file"
23342 .cindex "locking files"
23343 .cindex "lock files"
23344 If you are using more than one host to deliver over NFS into the same
23345 mailboxes, you should always use lock files.
23346
23347 The string value is expanded for each delivery, and must yield an absolute
23348 path. The most common settings of this option are variations on one of these
23349 examples:
23350 .code
23351 file = /var/spool/mail/$local_part_data
23352 file = /home/$local_part_data/inbox
23353 file = $home/inbox
23354 .endd
23355 .cindex "&""sticky""& bit"
23356 In the first example, all deliveries are done into the same directory. If Exim
23357 is configured to use lock files (see &%use_lockfile%& below) it must be able to
23358 create a file in the directory, so the &"sticky"& bit must be turned on for
23359 deliveries to be possible, or alternatively the &%group%& option can be used to
23360 run the delivery under a group id which has write access to the directory.
23361
23362
23363
23364 .option file_format appendfile string unset
23365 .cindex "file" "mailbox; checking existing format"
23366 This option requests the transport to check the format of an existing file
23367 before adding to it. The check consists of matching a specific string at the
23368 start of the file. The value of the option consists of an even number of
23369 colon-separated strings. The first of each pair is the test string, and the
23370 second is the name of a transport. If the transport associated with a matched
23371 string is not the current transport, control is passed over to the other
23372 transport. For example, suppose the standard &(local_delivery)& transport has
23373 this added to it:
23374 .code
23375 file_format = "From       : local_delivery :\
23376                \1\1\1\1\n : local_mmdf_delivery"
23377 .endd
23378 Mailboxes that begin with &"From"& are still handled by this transport, but if
23379 a mailbox begins with four binary ones followed by a newline, control is passed
23380 to a transport called &%local_mmdf_delivery%&, which presumably is configured
23381 to do the delivery in MMDF format. If a mailbox does not exist or is empty, it
23382 is assumed to match the current transport. If the start of a mailbox doesn't
23383 match any string, or if the transport named for a given string is not defined,
23384 delivery is deferred.
23385
23386
23387 .option file_must_exist appendfile boolean false
23388 If this option is true, the file specified by the &%file%& option must exist.
23389 A temporary error occurs if it does not, causing delivery to be deferred.
23390 If this option is false, the file is created if it does not exist.
23391
23392
23393 .option lock_fcntl_timeout appendfile time 0s
23394 .cindex "timeout" "mailbox locking"
23395 .cindex "mailbox" "locking, blocking and non-blocking"
23396 .cindex "locking files"
23397 By default, the &(appendfile)& transport uses non-blocking calls to &[fcntl()]&
23398 when locking an open mailbox file. If the call fails, the delivery process
23399 sleeps for &%lock_interval%& and tries again, up to &%lock_retries%& times.
23400 Non-blocking calls are used so that the file is not kept open during the wait
23401 for the lock; the reason for this is to make it as safe as possible for
23402 deliveries over NFS in the case when processes might be accessing an NFS
23403 mailbox without using a lock file. This should not be done, but
23404 misunderstandings and hence misconfigurations are not unknown.
23405
23406 On a busy system, however, the performance of a non-blocking lock approach is
23407 not as good as using a blocking lock with a timeout. In this case, the waiting
23408 is done inside the system call, and Exim's delivery process acquires the lock
23409 and can proceed as soon as the previous lock holder releases it.
23410
23411 If &%lock_fcntl_timeout%& is set to a non-zero time, blocking locks, with that
23412 timeout, are used. There may still be some retrying: the maximum number of
23413 retries is
23414 .code
23415 (lock_retries * lock_interval) / lock_fcntl_timeout
23416 .endd
23417 rounded up to the next whole number. In other words, the total time during
23418 which &(appendfile)& is trying to get a lock is roughly the same, unless
23419 &%lock_fcntl_timeout%& is set very large.
23420
23421 You should consider setting this option if you are getting a lot of delayed
23422 local deliveries because of errors of the form
23423 .code
23424 failed to lock mailbox /some/file (fcntl)
23425 .endd
23426
23427 .option lock_flock_timeout appendfile time 0s
23428 This timeout applies to file locking when using &[flock()]& (see
23429 &%use_flock%&); the timeout operates in a similar manner to
23430 &%lock_fcntl_timeout%&.
23431
23432
23433 .option lock_interval appendfile time 3s
23434 This specifies the time to wait between attempts to lock the file. See below
23435 for details of locking.
23436
23437
23438 .option lock_retries appendfile integer 10
23439 This specifies the maximum number of attempts to lock the file. A value of zero
23440 is treated as 1. See below for details of locking.
23441
23442
23443 .option lockfile_mode appendfile "octal integer" 0600
23444 This specifies the mode of the created lock file, when a lock file is being
23445 used (see &%use_lockfile%& and &%use_mbx_lock%&).
23446
23447
23448 .option lockfile_timeout appendfile time 30m
23449 .cindex "timeout" "mailbox locking"
23450 When a lock file is being used (see &%use_lockfile%&), if a lock file already
23451 exists and is older than this value, it is assumed to have been left behind by
23452 accident, and Exim attempts to remove it.
23453
23454
23455 .option mailbox_filecount appendfile string&!! unset
23456 .cindex "mailbox" "specifying size of"
23457 .cindex "size" "of mailbox"
23458 If this option is set, it is expanded, and the result is taken as the current
23459 number of files in the mailbox. It must be a decimal number, optionally
23460 followed by K or M. This provides a way of obtaining this information from an
23461 external source that maintains the data.
23462
23463
23464 .option mailbox_size appendfile string&!! unset
23465 .cindex "mailbox" "specifying size of"
23466 .cindex "size" "of mailbox"
23467 If this option is set, it is expanded, and the result is taken as the current
23468 size the mailbox. It must be a decimal number, optionally followed by K or M.
23469 This provides a way of obtaining this information from an external source that
23470 maintains the data. This is likely to be helpful for maildir deliveries where
23471 it is computationally expensive to compute the size of a mailbox.
23472
23473
23474
23475 .option maildir_format appendfile boolean false
23476 .cindex "maildir format" "specifying"
23477 If this option is set with the &%directory%& option, the delivery is into a new
23478 file, in the &"maildir"& format that is used by other mail software. When the
23479 transport is activated directly from a &(redirect)& router (for example, the
23480 &(address_file)& transport in the default configuration), setting
23481 &%maildir_format%& causes the path received from the router to be treated as a
23482 directory, whether or not it ends with &`/`&. This option is available only if
23483 SUPPORT_MAILDIR is present in &_Local/Makefile_&. See section
23484 &<<SECTmaildirdelivery>>& below for further details.
23485
23486
23487 .option maildir_quota_directory_regex appendfile string "See below"
23488 .cindex "maildir format" "quota; directories included in"
23489 .cindex "quota" "maildir; directories included in"
23490 This option is relevant only when &%maildir_use_size_file%& is set. It defines
23491 a regular expression for specifying directories, relative to the quota
23492 directory (see &%quota_directory%&), that should be included in the quota
23493 calculation. The default value is:
23494 .code
23495 maildir_quota_directory_regex = ^(?:cur|new|\..*)$
23496 .endd
23497 This includes the &_cur_& and &_new_& directories, and any maildir++ folders
23498 (directories whose names begin with a dot). If you want to exclude the
23499 &_Trash_&
23500 folder from the count (as some sites do), you need to change this setting to
23501 .code
23502 maildir_quota_directory_regex = ^(?:cur|new|\.(?!Trash).*)$
23503 .endd
23504 This uses a negative lookahead in the regular expression to exclude the
23505 directory whose name is &_.Trash_&. When a directory is excluded from quota
23506 calculations, quota processing is bypassed for any messages that are delivered
23507 directly into that directory.
23508
23509
23510 .option maildir_retries appendfile integer 10
23511 This option specifies the number of times to retry when writing a file in
23512 &"maildir"& format. See section &<<SECTmaildirdelivery>>& below.
23513
23514
23515 .option maildir_tag appendfile string&!! unset
23516 This option applies only to deliveries in maildir format, and is described in
23517 section &<<SECTmaildirdelivery>>& below.
23518
23519
23520 .option maildir_use_size_file appendfile&!! boolean false
23521 .cindex "maildir format" "&_maildirsize_& file"
23522 The result of string expansion for this option must be a valid boolean value.
23523 If it is true, it enables support for &_maildirsize_& files. Exim
23524 creates a &_maildirsize_& file in a maildir if one does not exist, taking the
23525 quota from the &%quota%& option of the transport. If &%quota%& is unset, the
23526 value is zero. See &%maildir_quota_directory_regex%& above and section
23527 &<<SECTmaildirdelivery>>& below for further details.
23528
23529 .option maildirfolder_create_regex appendfile string unset
23530 .cindex "maildir format" "&_maildirfolder_& file"
23531 .cindex "&_maildirfolder_&, creating"
23532 The value of this option is a regular expression. If it is unset, it has no
23533 effect. Otherwise, before a maildir delivery takes place, the pattern is
23534 matched against the name of the maildir directory, that is, the directory
23535 containing the &_new_& and &_tmp_& subdirectories that will be used for the
23536 delivery. If there is a match, Exim checks for the existence of a file called
23537 &_maildirfolder_& in the directory, and creates it if it does not exist.
23538 See section &<<SECTmaildirdelivery>>& for more details.
23539
23540
23541 .option mailstore_format appendfile boolean false
23542 .cindex "mailstore format" "specifying"
23543 If this option is set with the &%directory%& option, the delivery is into two
23544 new files in  &"mailstore"& format. The option is available only if
23545 SUPPORT_MAILSTORE is present in &_Local/Makefile_&. See section &<<SECTopdir>>&
23546 below for further details.
23547
23548
23549 .option mailstore_prefix appendfile string&!! unset
23550 This option applies only to deliveries in mailstore format, and is described in
23551 section &<<SECTopdir>>& below.
23552
23553
23554 .option mailstore_suffix appendfile string&!! unset
23555 This option applies only to deliveries in mailstore format, and is described in
23556 section &<<SECTopdir>>& below.
23557
23558
23559 .option mbx_format appendfile boolean false
23560 .cindex "locking files"
23561 .cindex "file" "locking"
23562 .cindex "file" "MBX format"
23563 .cindex "MBX format, specifying"
23564 This option is available only if Exim has been compiled with SUPPORT_MBX
23565 set in &_Local/Makefile_&. If &%mbx_format%& is set with the &%file%& option,
23566 the message is appended to the mailbox file in MBX format instead of
23567 traditional Unix format. This format is supported by Pine4 and its associated
23568 IMAP and POP daemons, by means of the &'c-client'& library that they all use.
23569
23570 &*Note*&: The &%message_prefix%& and &%message_suffix%& options are not
23571 automatically changed by the use of &%mbx_format%&. They should normally be set
23572 empty when using MBX format, so this option almost always appears in this
23573 combination:
23574 .code
23575 mbx_format = true
23576 message_prefix =
23577 message_suffix =
23578 .endd
23579 If none of the locking options are mentioned in the configuration,
23580 &%use_mbx_lock%& is assumed and the other locking options default to false. It
23581 is possible to specify the other kinds of locking with &%mbx_format%&, but
23582 &%use_fcntl_lock%& and &%use_mbx_lock%& are mutually exclusive. MBX locking
23583 interworks with &'c-client'&, providing for shared access to the mailbox. It
23584 should not be used if any program that does not use this form of locking is
23585 going to access the mailbox, nor should it be used if the mailbox file is NFS
23586 mounted, because it works only when the mailbox is accessed from a single host.
23587
23588 If you set &%use_fcntl_lock%& with an MBX-format mailbox, you cannot use
23589 the standard version of &'c-client'&, because as long as it has a mailbox open
23590 (this means for the whole of a Pine or IMAP session), Exim will not be able to
23591 append messages to it.
23592
23593
23594 .option message_prefix appendfile string&!! "see below"
23595 .cindex "&""From""& line"
23596 The string specified here is expanded and output at the start of every message.
23597 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
23598 in which case it is:
23599 .code
23600 message_prefix = "From ${if def:return_path{$return_path}\
23601   {MAILER-DAEMON}} $tod_bsdinbox\n"
23602 .endd
23603 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
23604 &`\n`& to &`\r\n`& in &%message_prefix%&.
23605
23606 .option message_suffix appendfile string&!! "see below"
23607 The string specified here is expanded and output at the end of every message.
23608 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
23609 in which case it is a single newline character. The suffix can be suppressed by
23610 setting
23611 .code
23612 message_suffix =
23613 .endd
23614 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
23615 &`\n`& to &`\r\n`& in &%message_suffix%&.
23616
23617 .option mode appendfile "octal integer" 0600
23618 If the output file is created, it is given this mode. If it already exists and
23619 has wider permissions, they are reduced to this mode. If it has narrower
23620 permissions, an error occurs unless &%mode_fail_narrower%& is false. However,
23621 if the delivery is the result of a &%save%& command in a filter file specifying
23622 a particular mode, the mode of the output file is always forced to take that
23623 value, and this option is ignored.
23624
23625
23626 .option mode_fail_narrower appendfile boolean true
23627 This option applies in the case when an existing mailbox file has a narrower
23628 mode than that specified by the &%mode%& option. If &%mode_fail_narrower%& is
23629 true, the delivery is deferred (&"mailbox has the wrong mode"&); otherwise Exim
23630 continues with the delivery attempt, using the existing mode of the file.
23631
23632
23633 .option notify_comsat appendfile boolean false
23634 If this option is true, the &'comsat'& daemon is notified after every
23635 successful delivery to a user mailbox. This is the daemon that notifies logged
23636 on users about incoming mail.
23637
23638
23639 .option quota appendfile string&!! unset
23640 .cindex "quota" "imposed by Exim"
23641 This option imposes a limit on the size of the file to which Exim is appending,
23642 or to the total space used in the directory tree when the &%directory%& option
23643 is set. In the latter case, computation of the space used is expensive, because
23644 all the files in the directory (and any sub-directories) have to be
23645 individually inspected and their sizes summed. (See &%quota_size_regex%& and
23646 &%maildir_use_size_file%& for ways to avoid this in environments where users
23647 have no shell access to their mailboxes).
23648
23649 As there is no interlock against two simultaneous deliveries into a
23650 multi-file mailbox, it is possible for the quota to be overrun in this case.
23651 For single-file mailboxes, of course, an interlock is a necessity.
23652
23653 A file's size is taken as its &'used'& value. Because of blocking effects, this
23654 may be a lot less than the actual amount of disk space allocated to the file.
23655 If the sizes of a number of files are being added up, the rounding effect can
23656 become quite noticeable, especially on systems that have large block sizes.
23657 Nevertheless, it seems best to stick to the &'used'& figure, because this is
23658 the obvious value which users understand most easily.
23659
23660 The value of the option is expanded, and must then be a numerical value
23661 (decimal point allowed), optionally followed by one of the letters K, M, or G,
23662 for kilobytes, megabytes, or gigabytes, optionally followed by a slash
23663 and further option modifiers. If Exim is running on a system with
23664 large file support (Linux and FreeBSD have this), mailboxes larger than 2G can
23665 be handled.
23666
23667 The option modifier &%no_check%& can be used to force delivery even if the over
23668 quota condition is met. The quota gets updated as usual.
23669
23670 &*Note*&: A value of zero is interpreted as &"no quota"&.
23671
23672 The expansion happens while Exim is running as root, before it changes uid for
23673 the delivery. This means that files that are inaccessible to the end user can
23674 be used to hold quota values that are looked up in the expansion. When delivery
23675 fails because this quota is exceeded, the handling of the error is as for
23676 system quota failures.
23677
23678 By default, Exim's quota checking mimics system quotas, and restricts the
23679 mailbox to the specified maximum size, though the value is not accurate to the
23680 last byte, owing to separator lines and additional headers that may get added
23681 during message delivery. When a mailbox is nearly full, large messages may get
23682 refused even though small ones are accepted, because the size of the current
23683 message is added to the quota when the check is made. This behaviour can be
23684 changed by setting &%quota_is_inclusive%& false. When this is done, the check
23685 for exceeding the quota does not include the current message. Thus, deliveries
23686 continue until the quota has been exceeded; thereafter, no further messages are
23687 delivered. See also &%quota_warn_threshold%&.
23688
23689
23690 .option quota_directory appendfile string&!! unset
23691 This option defines the directory to check for quota purposes when delivering
23692 into individual files. The default is the delivery directory, or, if a file
23693 called &_maildirfolder_& exists in a maildir directory, the parent of the
23694 delivery directory.
23695
23696
23697 .option quota_filecount appendfile string&!! 0
23698 This option applies when the &%directory%& option is set. It limits the total
23699 number of files in the directory (compare the inode limit in system quotas). It
23700 can only be used if &%quota%& is also set. The value is expanded; an expansion
23701 failure causes delivery to be deferred. A value of zero is interpreted as
23702 &"no quota"&.
23703
23704 The option modifier &%no_check%& can be used to force delivery even if the over
23705 quota condition is met. The quota gets updated as usual.
23706
23707 .option quota_is_inclusive appendfile boolean true
23708 See &%quota%& above.
23709
23710
23711 .option quota_size_regex appendfile string unset
23712 This option applies when one of the delivery modes that writes a separate file
23713 for each message is being used. When Exim wants to find the size of one of
23714 these files in order to test the quota, it first checks &%quota_size_regex%&.
23715 If this is set to a regular expression that matches the filename, and it
23716 captures one string, that string is interpreted as a representation of the
23717 file's size. The value of &%quota_size_regex%& is not expanded.
23718
23719 This feature is useful only when users have no shell access to their mailboxes
23720 &-- otherwise they could defeat the quota simply by renaming the files. This
23721 facility can be used with maildir deliveries, by setting &%maildir_tag%& to add
23722 the file length to the filename. For example:
23723 .code
23724 maildir_tag = ,S=$message_size
23725 quota_size_regex = ,S=(\d+)
23726 .endd
23727 An alternative to &$message_size$& is &$message_linecount$&, which contains the
23728 number of lines in the message.
23729
23730 The regular expression should not assume that the length is at the end of the
23731 filename (even though &%maildir_tag%& puts it there) because maildir MUAs
23732 sometimes add other information onto the ends of message filenames.
23733
23734 Section &<<SECID136>>& contains further information.
23735
23736 This option should not be used when other message-handling software
23737 may duplicate messages by making hardlinks to the files.  When that is done Exim
23738 will count the message size once for each filename, in contrast with the actual
23739 disk usage.  When the option is not set, calculating total usage requires
23740 a system-call per file to get the size; the number of links is then available also
23741 as is used to adjust the effective size.
23742
23743
23744 .option quota_warn_message appendfile string&!! "see below"
23745 See below for the use of this option. If it is not set when
23746 &%quota_warn_threshold%& is set, it defaults to
23747 .code
23748 quota_warn_message = "\
23749   To: $local_part@$domain\n\
23750   Subject: Your mailbox\n\n\
23751   This message is automatically created \
23752   by mail delivery software.\n\n\
23753   The size of your mailbox has exceeded \
23754   a warning threshold that is\n\
23755   set by the system administrator.\n"
23756 .endd
23757
23758
23759 .option quota_warn_threshold appendfile string&!! 0
23760 .cindex "quota" "warning threshold"
23761 .cindex "mailbox" "size warning"
23762 .cindex "size" "of mailbox"
23763 This option is expanded in the same way as &%quota%& (see above). If the
23764 resulting value is greater than zero, and delivery of the message causes the
23765 size of the file or total space in the directory tree to cross the given
23766 threshold, a warning message is sent. If &%quota%& is also set, the threshold
23767 may be specified as a percentage of it by following the value with a percent
23768 sign. For example:
23769 .code
23770 quota = 10M
23771 quota_warn_threshold = 75%
23772 .endd
23773 If &%quota%& is not set, a setting of &%quota_warn_threshold%& that ends with a
23774 percent sign is ignored.
23775
23776 The warning message itself is specified by the &%quota_warn_message%& option,
23777 and it must start with a &'To:'& header line containing the recipient(s) of the
23778 warning message. These do not necessarily have to include the recipient(s) of
23779 the original message. A &'Subject:'& line should also normally be supplied. You
23780 can include any other header lines that you want. If you do not include a
23781 &'From:'& line, the default is:
23782 .code
23783 From: Mail Delivery System <mailer-daemon@$qualify_domain_sender>
23784 .endd
23785 .oindex &%errors_reply_to%&
23786 If you supply a &'Reply-To:'& line, it overrides the global &%errors_reply_to%&
23787 option.
23788
23789 The &%quota%& option does not have to be set in order to use this option; they
23790 are independent of one another except when the threshold is specified as a
23791 percentage.
23792
23793
23794 .option use_bsmtp appendfile boolean false
23795 .cindex "envelope from"
23796 .cindex "envelope sender"
23797 If this option is set true, &(appendfile)& writes messages in &"batch SMTP"&
23798 format, with the envelope sender and recipient(s) included as SMTP commands. If
23799 you want to include a leading HELO command with such messages, you can do
23800 so by setting the &%message_prefix%& option. See section &<<SECTbatchSMTP>>&
23801 for details of batch SMTP.
23802
23803
23804 .option use_crlf appendfile boolean false
23805 .cindex "carriage return"
23806 .cindex "linefeed"
23807 This option causes lines to be terminated with the two-character CRLF sequence
23808 (carriage return, linefeed) instead of just a linefeed character. In the case
23809 of batched SMTP, the byte sequence written to the file is then an exact image
23810 of what would be sent down a real SMTP connection.
23811
23812 &*Note:*& The contents of the &%message_prefix%& and &%message_suffix%& options
23813 (which are used to supply the traditional &"From&~"& and blank line separators
23814 in Berkeley-style mailboxes) are written verbatim, so must contain their own
23815 carriage return characters if these are needed. In cases where these options
23816 have non-empty defaults, the values end with a single linefeed, so they must be
23817 changed to end with &`\r\n`& if &%use_crlf%& is set.
23818
23819
23820 .option use_fcntl_lock appendfile boolean "see below"
23821 This option controls the use of the &[fcntl()]& function to lock a file for
23822 exclusive use when a message is being appended. It is set by default unless
23823 &%use_flock_lock%& is set. Otherwise, it should be turned off only if you know
23824 that all your MUAs use lock file locking. When both &%use_fcntl_lock%& and
23825 &%use_flock_lock%& are unset, &%use_lockfile%& must be set.
23826
23827
23828 .option use_flock_lock appendfile boolean false
23829 This option is provided to support the use of &[flock()]& for file locking, for
23830 the few situations where it is needed. Most modern operating systems support
23831 &[fcntl()]& and &[lockf()]& locking, and these two functions interwork with
23832 each other. Exim uses &[fcntl()]& locking by default.
23833
23834 This option is required only if you are using an operating system where
23835 &[flock()]& is used by programs that access mailboxes (typically MUAs), and
23836 where &[flock()]& does not correctly interwork with &[fcntl()]&. You can use
23837 both &[fcntl()]& and &[flock()]& locking simultaneously if you want.
23838
23839 .cindex "Solaris" "&[flock()]& support"
23840 Not all operating systems provide &[flock()]&. Some versions of Solaris do not
23841 have it (and some, I think, provide a not quite right version built on top of
23842 &[lockf()]&). If the OS does not have &[flock()]&, Exim will be built without
23843 the ability to use it, and any attempt to do so will cause a configuration
23844 error.
23845
23846 &*Warning*&: &[flock()]& locks do not work on NFS files (unless &[flock()]&
23847 is just being mapped onto &[fcntl()]& by the OS).
23848
23849
23850 .option use_lockfile appendfile boolean "see below"
23851 If this option is turned off, Exim does not attempt to create a lock file when
23852 appending to a mailbox file. In this situation, the only locking is by
23853 &[fcntl()]&. You should only turn &%use_lockfile%& off if you are absolutely
23854 sure that every MUA that is ever going to look at your users' mailboxes uses
23855 &[fcntl()]& rather than a lock file, and even then only when you are not
23856 delivering over NFS from more than one host.
23857
23858 .cindex "NFS" "lock file"
23859 In order to append to an NFS file safely from more than one host, it is
23860 necessary to take out a lock &'before'& opening the file, and the lock file
23861 achieves this. Otherwise, even with &[fcntl()]& locking, there is a risk of
23862 file corruption.
23863
23864 The &%use_lockfile%& option is set by default unless &%use_mbx_lock%& is set.
23865 It is not possible to turn both &%use_lockfile%& and &%use_fcntl_lock%& off,
23866 except when &%mbx_format%& is set.
23867
23868
23869 .option use_mbx_lock appendfile boolean "see below"
23870 This option is available only if Exim has been compiled with SUPPORT_MBX
23871 set in &_Local/Makefile_&. Setting the option specifies that special MBX
23872 locking rules be used. It is set by default if &%mbx_format%& is set and none
23873 of the locking options are mentioned in the configuration. The locking rules
23874 are the same as are used by the &'c-client'& library that underlies Pine and
23875 the IMAP4 and POP daemons that come with it (see the discussion below). The
23876 rules allow for shared access to the mailbox. However, this kind of locking
23877 does not work when the mailbox is NFS mounted.
23878
23879 You can set &%use_mbx_lock%& with either (or both) of &%use_fcntl_lock%& and
23880 &%use_flock_lock%& to control what kind of locking is used in implementing the
23881 MBX locking rules. The default is to use &[fcntl()]& if &%use_mbx_lock%& is set
23882 without &%use_fcntl_lock%& or &%use_flock_lock%&.
23883
23884
23885
23886
23887 .section "Operational details for appending" "SECTopappend"
23888 .cindex "appending to a file"
23889 .cindex "file" "appending"
23890 Before appending to a file, the following preparations are made:
23891
23892 .ilist
23893 If the name of the file is &_/dev/null_&, no action is taken, and a success
23894 return is given.
23895
23896 .next
23897 .cindex "directory creation"
23898 If any directories on the file's path are missing, Exim creates them if the
23899 &%create_directory%& option is set. A created directory's mode is given by the
23900 &%directory_mode%& option.
23901
23902 .next
23903 If &%file_format%& is set, the format of an existing file is checked. If this
23904 indicates that a different transport should be used, control is passed to that
23905 transport.
23906
23907 .next
23908 .cindex "file" "locking"
23909 .cindex "locking files"
23910 .cindex "NFS" "lock file"
23911 If &%use_lockfile%& is set, a lock file is built in a way that will work
23912 reliably over NFS, as follows:
23913
23914 .olist
23915 Create a &"hitching post"& file whose name is that of the lock file with the
23916 current time, primary host name, and process id added, by opening for writing
23917 as a new file. If this fails with an access error, delivery is deferred.
23918 .next
23919 Close the hitching post file, and hard link it to the lock filename.
23920 .next
23921 If the call to &[link()]& succeeds, creation of the lock file has succeeded.
23922 Unlink the hitching post name.
23923 .next
23924 Otherwise, use &[stat()]& to get information about the hitching post file, and
23925 then unlink hitching post name. If the number of links is exactly two, creation
23926 of the lock file succeeded but something (for example, an NFS server crash and
23927 restart) caused this fact not to be communicated to the &[link()]& call.
23928 .next
23929 If creation of the lock file failed, wait for &%lock_interval%& and try again,
23930 up to &%lock_retries%& times. However, since any program that writes to a
23931 mailbox should complete its task very quickly, it is reasonable to time out old
23932 lock files that are normally the result of user agent and system crashes. If an
23933 existing lock file is older than &%lockfile_timeout%& Exim attempts to unlink
23934 it before trying again.
23935 .endlist olist
23936
23937 .next
23938 A call is made to &[lstat()]& to discover whether the main file exists, and if
23939 so, what its characteristics are. If &[lstat()]& fails for any reason other
23940 than non-existence, delivery is deferred.
23941
23942 .next
23943 .cindex "symbolic link" "to mailbox"
23944 .cindex "mailbox" "symbolic link"
23945 If the file does exist and is a symbolic link, delivery is deferred, unless the
23946 &%allow_symlink%& option is set, in which case the ownership of the link is
23947 checked, and then &[stat()]& is called to find out about the real file, which
23948 is then subjected to the checks below. The check on the top-level link
23949 ownership prevents one user creating a link for another's mailbox in a sticky
23950 directory, though allowing symbolic links in this case is definitely not a good
23951 idea. If there is a chain of symbolic links, the intermediate ones are not
23952 checked.
23953
23954 .next
23955 If the file already exists but is not a regular file, or if the file's owner
23956 and group (if the group is being checked &-- see &%check_group%& above) are
23957 different from the user and group under which the delivery is running,
23958 delivery is deferred.
23959
23960 .next
23961 If the file's permissions are more generous than specified, they are reduced.
23962 If they are insufficient, delivery is deferred, unless &%mode_fail_narrower%&
23963 is set false, in which case the delivery is tried using the existing
23964 permissions.
23965
23966 .next
23967 The file's inode number is saved, and the file is then opened for appending.
23968 If this fails because the file has vanished, &(appendfile)& behaves as if it
23969 hadn't existed (see below). For any other failures, delivery is deferred.
23970
23971 .next
23972 If the file is opened successfully, check that the inode number hasn't
23973 changed, that it is still a regular file, and that the owner and permissions
23974 have not changed. If anything is wrong, defer delivery and freeze the message.
23975
23976 .next
23977 If the file did not exist originally, defer delivery if the &%file_must_exist%&
23978 option is set. Otherwise, check that the file is being created in a permitted
23979 directory if the &%create_file%& option is set (deferring on failure), and then
23980 open for writing as a new file, with the O_EXCL and O_CREAT options,
23981 except when dealing with a symbolic link (the &%allow_symlink%& option must be
23982 set). In this case, which can happen if the link points to a non-existent file,
23983 the file is opened for writing using O_CREAT but not O_EXCL, because
23984 that prevents link following.
23985
23986 .next
23987 .cindex "loop" "while file testing"
23988 If opening fails because the file exists, obey the tests given above for
23989 existing files. However, to avoid looping in a situation where the file is
23990 being continuously created and destroyed, the exists/not-exists loop is broken
23991 after 10 repetitions, and the message is then frozen.
23992
23993 .next
23994 If opening fails with any other error, defer delivery.
23995
23996 .next
23997 .cindex "file" "locking"
23998 .cindex "locking files"
23999 Once the file is open, unless both &%use_fcntl_lock%& and &%use_flock_lock%&
24000 are false, it is locked using &[fcntl()]& or &[flock()]& or both. If
24001 &%use_mbx_lock%& is false, an exclusive lock is requested in each case.
24002 However, if &%use_mbx_lock%& is true, Exim takes out a shared lock on the open
24003 file, and an exclusive lock on the file whose name is
24004 .code
24005 /tmp/.<device-number>.<inode-number>
24006 .endd
24007 using the device and inode numbers of the open mailbox file, in accordance with
24008 the MBX locking rules. This file is created with a mode that is specified by
24009 the &%lockfile_mode%& option.
24010
24011 If Exim fails to lock the file, there are two possible courses of action,
24012 depending on the value of the locking timeout. This is obtained from
24013 &%lock_fcntl_timeout%& or &%lock_flock_timeout%&, as appropriate.
24014
24015 If the timeout value is zero, the file is closed, Exim waits for
24016 &%lock_interval%&, and then goes back and re-opens the file as above and tries
24017 to lock it again. This happens up to &%lock_retries%& times, after which the
24018 delivery is deferred.
24019
24020 If the timeout has a value greater than zero, blocking calls to &[fcntl()]& or
24021 &[flock()]& are used (with the given timeout), so there has already been some
24022 waiting involved by the time locking fails. Nevertheless, Exim does not give up
24023 immediately. It retries up to
24024 .code
24025 (lock_retries * lock_interval) / <timeout>
24026 .endd
24027 times (rounded up).
24028 .endlist
24029
24030 At the end of delivery, Exim closes the file (which releases the &[fcntl()]&
24031 and/or &[flock()]& locks) and then deletes the lock file if one was created.
24032
24033
24034 .section "Operational details for delivery to a new file" "SECTopdir"
24035 .cindex "delivery" "to single file"
24036 .cindex "&""From""& line"
24037 When the &%directory%& option is set instead of &%file%&, each message is
24038 delivered into a newly-created file or set of files. When &(appendfile)& is
24039 activated directly from a &(redirect)& router, neither &%file%& nor
24040 &%directory%& is normally set, because the path for delivery is supplied by the
24041 router. (See for example, the &(address_file)& transport in the default
24042 configuration.) In this case, delivery is to a new file if either the path name
24043 ends in &`/`&, or the &%maildir_format%& or &%mailstore_format%& option is set.
24044
24045 No locking is required while writing the message to a new file, so the various
24046 locking options of the transport are ignored. The &"From"& line that by default
24047 separates messages in a single file is not normally needed, nor is the escaping
24048 of message lines that start with &"From"&, and there is no need to ensure a
24049 newline at the end of each message. Consequently, the default values for
24050 &%check_string%&, &%message_prefix%&, and &%message_suffix%& are all unset when
24051 any of &%directory%&, &%maildir_format%&, or &%mailstore_format%& is set.
24052
24053 If Exim is required to check a &%quota%& setting, it adds up the sizes of all
24054 the files in the delivery directory by default. However, you can specify a
24055 different directory by setting &%quota_directory%&. Also, for maildir
24056 deliveries (see below) the &_maildirfolder_& convention is honoured.
24057
24058
24059 .cindex "maildir format"
24060 .cindex "mailstore format"
24061 There are three different ways in which delivery to individual files can be
24062 done, controlled by the settings of the &%maildir_format%& and
24063 &%mailstore_format%& options. Note that code to support maildir or mailstore
24064 formats is not included in the binary unless SUPPORT_MAILDIR or
24065 SUPPORT_MAILSTORE, respectively, is set in &_Local/Makefile_&.
24066
24067 .cindex "directory creation"
24068 In all three cases an attempt is made to create the directory and any necessary
24069 sub-directories if they do not exist, provided that the &%create_directory%&
24070 option is set (the default). The location of a created directory can be
24071 constrained by setting &%create_file%&. A created directory's mode is given by
24072 the &%directory_mode%& option. If creation fails, or if the
24073 &%create_directory%& option is not set when creation is required, delivery is
24074 deferred.
24075
24076
24077
24078 .section "Maildir delivery" "SECTmaildirdelivery"
24079 .cindex "maildir format" "description of"
24080 If the &%maildir_format%& option is true, Exim delivers each message by writing
24081 it to a file whose name is &_tmp/<stime>.H<mtime>P<pid>.<host>_& in the
24082 directory that is defined by the &%directory%& option (the &"delivery
24083 directory"&). If the delivery is successful, the file is renamed into the
24084 &_new_& subdirectory.
24085
24086 In the filename, <&'stime'&> is the current time of day in seconds, and
24087 <&'mtime'&> is the microsecond fraction of the time. After a maildir delivery,
24088 Exim checks that the time-of-day clock has moved on by at least one microsecond
24089 before terminating the delivery process. This guarantees uniqueness for the
24090 filename. However, as a precaution, Exim calls &[stat()]& for the file before
24091 opening it. If any response other than ENOENT (does not exist) is given,
24092 Exim waits 2 seconds and tries again, up to &%maildir_retries%& times.
24093
24094 Before Exim carries out a maildir delivery, it ensures that subdirectories
24095 called &_new_&, &_cur_&, and &_tmp_& exist in the delivery directory. If they
24096 do not exist, Exim tries to create them and any superior directories in their
24097 path, subject to the &%create_directory%& and &%create_file%& options. If the
24098 &%maildirfolder_create_regex%& option is set, and the regular expression it
24099 contains matches the delivery directory, Exim also ensures that a file called
24100 &_maildirfolder_& exists in the delivery directory. If a missing directory or
24101 &_maildirfolder_& file cannot be created, delivery is deferred.
24102
24103 These features make it possible to use Exim to create all the necessary files
24104 and directories in a maildir mailbox, including subdirectories for maildir++
24105 folders. Consider this example:
24106 .code
24107 maildir_format = true
24108 directory = /var/mail/$local_part_data\
24109            ${if eq{$local_part_suffix}{}{}\
24110            {/.${substr_1:$local_part_suffix}}}
24111 maildirfolder_create_regex = /\.[^/]+$
24112 .endd
24113 If &$local_part_suffix$& is empty (there was no suffix for the local part),
24114 delivery is into a toplevel maildir with a name like &_/var/mail/pimbo_& (for
24115 the user called &'pimbo'&). The pattern in &%maildirfolder_create_regex%& does
24116 not match this name, so Exim will not look for or create the file
24117 &_/var/mail/pimbo/maildirfolder_&, though it will create
24118 &_/var/mail/pimbo/{cur,new,tmp}_& if necessary.
24119
24120 However, if &$local_part_suffix$& contains &`-eximusers`& (for example),
24121 delivery is into the maildir++ folder &_/var/mail/pimbo/.eximusers_&, which
24122 does match &%maildirfolder_create_regex%&. In this case, Exim will create
24123 &_/var/mail/pimbo/.eximusers/maildirfolder_& as well as the three maildir
24124 directories &_/var/mail/pimbo/.eximusers/{cur,new,tmp}_&.
24125
24126 &*Warning:*& Take care when setting &%maildirfolder_create_regex%& that it does
24127 not inadvertently match the toplevel maildir directory, because a
24128 &_maildirfolder_& file at top level would completely break quota calculations.
24129
24130 .cindex "quota" "in maildir delivery"
24131 .cindex "maildir++"
24132 If Exim is required to check a &%quota%& setting before a maildir delivery, and
24133 &%quota_directory%& is not set, it looks for a file called &_maildirfolder_& in
24134 the maildir directory (alongside &_new_&, &_cur_&, &_tmp_&). If this exists,
24135 Exim assumes the directory is a maildir++ folder directory, which is one level
24136 down from the user's top level mailbox directory. This causes it to start at
24137 the parent directory instead of the current directory when calculating the
24138 amount of space used.
24139
24140 One problem with delivering into a multi-file mailbox is that it is
24141 computationally expensive to compute the size of the mailbox for quota
24142 checking. Various approaches have been taken to reduce the amount of work
24143 needed. The next two sections describe two of them. A third alternative is to
24144 use some external process for maintaining the size data, and use the expansion
24145 of the &%mailbox_size%& option as a way of importing it into Exim.
24146
24147
24148
24149
24150 .section "Using tags to record message sizes" "SECID135"
24151 If &%maildir_tag%& is set, the string is expanded for each delivery.
24152 When the maildir file is renamed into the &_new_& sub-directory, the
24153 tag is added to its name. However, if adding the tag takes the length of the
24154 name to the point where the test &[stat()]& call fails with ENAMETOOLONG,
24155 the tag is dropped and the maildir file is created with no tag.
24156
24157
24158 .vindex "&$message_size$&"
24159 Tags can be used to encode the size of files in their names; see
24160 &%quota_size_regex%& above for an example. The expansion of &%maildir_tag%&
24161 happens after the message has been written. The value of the &$message_size$&
24162 variable is set to the number of bytes actually written. If the expansion is
24163 forced to fail, the tag is ignored, but a non-forced failure causes delivery to
24164 be deferred. The expanded tag may contain any printing characters except &"/"&.
24165 Non-printing characters in the string are ignored; if the resulting string is
24166 empty, it is ignored. If it starts with an alphanumeric character, a leading
24167 colon is inserted; this default has not proven to be the path that popular
24168 maildir implementations have chosen (but changing it in Exim would break
24169 backwards compatibility).
24170
24171 For one common implementation, you might set:
24172 .code
24173 maildir_tag = ,S=${message_size}
24174 .endd
24175 but you should check the documentation of the other software to be sure.
24176
24177 It is advisable to also set &%quota_size_regex%& when setting &%maildir_tag%&
24178 as this allows Exim to extract the size from your tag, instead of having to
24179 &[stat()]& each message file.
24180
24181
24182 .section "Using a maildirsize file" "SECID136"
24183 .cindex "quota" "in maildir delivery"
24184 .cindex "maildir format" "&_maildirsize_& file"
24185 If &%maildir_use_size_file%& is true, Exim implements the maildir++ rules for
24186 storing quota and message size information in a file called &_maildirsize_&
24187 within the toplevel maildir directory. If this file does not exist, Exim
24188 creates it, setting the quota from the &%quota%& option of the transport. If
24189 the maildir directory itself does not exist, it is created before any attempt
24190 to write a &_maildirsize_& file.
24191
24192 The &_maildirsize_& file is used to hold information about the sizes of
24193 messages in the maildir, thus speeding up quota calculations. The quota value
24194 in the file is just a cache; if the quota is changed in the transport, the new
24195 value overrides the cached value when the next message is delivered. The cache
24196 is maintained for the benefit of other programs that access the maildir and
24197 need to know the quota.
24198
24199 If the &%quota%& option in the transport is unset or zero, the &_maildirsize_&
24200 file is maintained (with a zero quota setting), but no quota is imposed.
24201
24202 A regular expression is available for controlling which directories in the
24203 maildir participate in quota calculations when a &_maildirsizefile_& is in use.
24204 See the description of the &%maildir_quota_directory_regex%& option above for
24205 details.
24206
24207
24208 .section "Mailstore delivery" "SECID137"
24209 .cindex "mailstore format" "description of"
24210 If the &%mailstore_format%& option is true, each message is written as two
24211 files in the given directory. A unique base name is constructed from the
24212 message id and the current delivery process, and the files that are written use
24213 this base name plus the suffixes &_.env_& and &_.msg_&. The &_.env_& file
24214 contains the message's envelope, and the &_.msg_& file contains the message
24215 itself. The base name is placed in the variable &$mailstore_basename$&.
24216
24217 During delivery, the envelope is first written to a file with the suffix
24218 &_.tmp_&. The &_.msg_& file is then written, and when it is complete, the
24219 &_.tmp_& file is renamed as the &_.env_& file. Programs that access messages in
24220 mailstore format should wait for the presence of both a &_.msg_& and a &_.env_&
24221 file before accessing either of them. An alternative approach is to wait for
24222 the absence of a &_.tmp_& file.
24223
24224 The envelope file starts with any text defined by the &%mailstore_prefix%&
24225 option, expanded and terminated by a newline if there isn't one. Then follows
24226 the sender address on one line, then all the recipient addresses, one per line.
24227 There can be more than one recipient only if the &%batch_max%& option is set
24228 greater than one. Finally, &%mailstore_suffix%& is expanded and the result
24229 appended to the file, followed by a newline if it does not end with one.
24230
24231 If expansion of &%mailstore_prefix%& or &%mailstore_suffix%& ends with a forced
24232 failure, it is ignored. Other expansion errors are treated as serious
24233 configuration errors, and delivery is deferred. The variable
24234 &$mailstore_basename$& is available for use during these expansions.
24235
24236
24237 .section "Non-special new file delivery" "SECID138"
24238 If neither &%maildir_format%& nor &%mailstore_format%& is set, a single new
24239 file is created directly in the named directory. For example, when delivering
24240 messages into files in batched SMTP format for later delivery to some host (see
24241 section &<<SECTbatchSMTP>>&), a setting such as
24242 .code
24243 directory = /var/bsmtp/$host
24244 .endd
24245 might be used. A message is written to a file with a temporary name, which is
24246 then renamed when the delivery is complete. The final name is obtained by
24247 expanding the contents of the &%directory_file%& option.
24248 .ecindex IIDapptra1
24249 .ecindex IIDapptra2
24250
24251
24252
24253
24254
24255
24256 . ////////////////////////////////////////////////////////////////////////////
24257 . ////////////////////////////////////////////////////////////////////////////
24258
24259 .chapter "The autoreply transport" "CHID8"
24260 .scindex IIDauttra1 "transports" "&(autoreply)&"
24261 .scindex IIDauttra2 "&(autoreply)& transport"
24262 The &(autoreply)& transport is not a true transport in that it does not cause
24263 the message to be transmitted. Instead, it generates a new mail message as an
24264 automatic reply to the incoming message. &'References:'& and
24265 &'Auto-Submitted:'& header lines are included. These are constructed according
24266 to the rules in RFCs 2822 and 3834, respectively.
24267
24268 If the router that passes the message to this transport does not have the
24269 &%unseen%& option set, the original message (for the current recipient) is not
24270 delivered anywhere. However, when the &%unseen%& option is set on the router
24271 that passes the message to this transport, routing of the address continues, so
24272 another router can set up a normal message delivery.
24273
24274
24275 The &(autoreply)& transport is usually run as the result of mail filtering, a
24276 &"vacation"& message being the standard example. However, it can also be run
24277 directly from a router like any other transport. To reduce the possibility of
24278 message cascades, messages created by the &(autoreply)& transport always have
24279 empty envelope sender addresses, like bounce messages.
24280
24281 The parameters of the message to be sent can be specified in the configuration
24282 by options described below. However, these are used only when the address
24283 passed to the transport does not contain its own reply information. When the
24284 transport is run as a consequence of a
24285 &%mail%&
24286 or &%vacation%& command in a filter file, the parameters of the message are
24287 supplied by the filter, and passed with the address. The transport's options
24288 that define the message are then ignored (so they are not usually set in this
24289 case). The message is specified entirely by the filter or by the transport; it
24290 is never built from a mixture of options. However, the &%file_optional%&,
24291 &%mode%&, and &%return_message%& options apply in all cases.
24292
24293 &(Autoreply)& is implemented as a local transport. When used as a result of a
24294 command in a user's filter file, &(autoreply)& normally runs under the uid and
24295 gid of the user, and with appropriate current and home directories (see chapter
24296 &<<CHAPenvironment>>&).
24297
24298 There is a subtle difference between routing a message to a &(pipe)& transport
24299 that generates some text to be returned to the sender, and routing it to an
24300 &(autoreply)& transport. This difference is noticeable only if more than one
24301 address from the same message is so handled. In the case of a pipe, the
24302 separate outputs from the different addresses are gathered up and returned to
24303 the sender in a single message, whereas if &(autoreply)& is used, a separate
24304 message is generated for each address that is passed to it.
24305
24306 Non-printing characters are not permitted in the header lines generated for the
24307 message that &(autoreply)& creates, with the exception of newlines that are
24308 immediately followed by white space. If any non-printing characters are found,
24309 the transport defers.
24310 Whether characters with the top bit set count as printing characters or not is
24311 controlled by the &%print_topbitchars%& global option.
24312
24313 If any of the generic options for manipulating headers (for example,
24314 &%headers_add%&) are set on an &(autoreply)& transport, they apply to the copy
24315 of the original message that is included in the generated message when
24316 &%return_message%& is set. They do not apply to the generated message itself.
24317
24318 .vindex "&$sender_address$&"
24319 If the &(autoreply)& transport receives return code 2 from Exim when it submits
24320 the message, indicating that there were no recipients, it does not treat this
24321 as an error. This means that autoreplies sent to &$sender_address$& when this
24322 is empty (because the incoming message is a bounce message) do not cause
24323 problems. They are just discarded.
24324
24325
24326
24327 .section "Private options for autoreply" "SECID139"
24328 .cindex "options" "&(autoreply)& transport"
24329
24330 .option bcc autoreply string&!! unset
24331 This specifies the addresses that are to receive &"blind carbon copies"& of the
24332 message when the message is specified by the transport.
24333
24334
24335 .option cc autoreply string&!! unset
24336 This specifies recipients of the message and the contents of the &'Cc:'& header
24337 when the message is specified by the transport.
24338
24339
24340 .option file autoreply string&!! unset
24341 The contents of the file are sent as the body of the message when the message
24342 is specified by the transport. If both &%file%& and &%text%& are set, the text
24343 string comes first.
24344
24345
24346 .option file_expand autoreply boolean false
24347 If this is set, the contents of the file named by the &%file%& option are
24348 subjected to string expansion as they are added to the message.
24349
24350
24351 .option file_optional autoreply boolean false
24352 If this option is true, no error is generated if the file named by the &%file%&
24353 option or passed with the address does not exist or cannot be read.
24354
24355
24356 .option from autoreply string&!! unset
24357 This specifies the contents of the &'From:'& header when the message is
24358 specified by the transport.
24359
24360
24361 .option headers autoreply string&!! unset
24362 This specifies additional RFC 2822 headers that are to be added to the message
24363 when the message is specified by the transport. Several can be given by using
24364 &"\n"& to separate them. There is no check on the format.
24365
24366
24367 .option log autoreply string&!! unset
24368 This option names a file in which a record of every message sent is logged when
24369 the message is specified by the transport.
24370
24371
24372 .option mode autoreply "octal integer" 0600
24373 If either the log file or the &"once"& file has to be created, this mode is
24374 used.
24375
24376
24377 .option never_mail autoreply "address list&!!" unset
24378 If any run of the transport creates a message with a recipient that matches any
24379 item in the list, that recipient is quietly discarded. If all recipients are
24380 discarded, no message is created. This applies both when the recipients are
24381 generated by a filter and when they are specified in the transport.
24382
24383
24384
24385 .option once autoreply string&!! unset
24386 This option names a file or DBM database in which a record of each &'To:'&
24387 recipient is kept when the message is specified by the transport. &*Note*&:
24388 This does not apply to &'Cc:'& or &'Bcc:'& recipients.
24389
24390 If &%once%& is unset, or is set to an empty string, the message is always sent.
24391 By default, if &%once%& is set to a non-empty filename, the message
24392 is not sent if a potential recipient is already listed in the database.
24393 However, if the &%once_repeat%& option specifies a time greater than zero, the
24394 message is sent if that much time has elapsed since a message was last sent to
24395 this recipient. A setting of zero time for &%once_repeat%& (the default)
24396 prevents a message from being sent a second time &-- in this case, zero means
24397 infinity.
24398
24399 If &%once_file_size%& is zero, a DBM database is used to remember recipients,
24400 and it is allowed to grow as large as necessary. If &%once_file_size%& is set
24401 greater than zero, it changes the way Exim implements the &%once%& option.
24402 Instead of using a DBM file to record every recipient it sends to, it uses a
24403 regular file, whose size will never get larger than the given value.
24404
24405 In the file, Exim keeps a linear list of recipient addresses and the times at
24406 which they were sent messages. If the file is full when a new address needs to
24407 be added, the oldest address is dropped. If &%once_repeat%& is not set, this
24408 means that a given recipient may receive multiple messages, but at
24409 unpredictable intervals that depend on the rate of turnover of addresses in the
24410 file. If &%once_repeat%& is set, it specifies a maximum time between repeats.
24411
24412
24413 .option once_file_size autoreply integer 0
24414 See &%once%& above.
24415
24416
24417 .option once_repeat autoreply time&!! 0s
24418 See &%once%& above.
24419 After expansion, the value of this option must be a valid time value.
24420
24421
24422 .option reply_to autoreply string&!! unset
24423 This specifies the contents of the &'Reply-To:'& header when the message is
24424 specified by the transport.
24425
24426
24427 .option return_message autoreply boolean false
24428 If this is set, a copy of the original message is returned with the new
24429 message, subject to the maximum size set in the &%return_size_limit%& global
24430 configuration option.
24431
24432
24433 .option subject autoreply string&!! unset
24434 This specifies the contents of the &'Subject:'& header when the message is
24435 specified by the transport. It is tempting to quote the original subject in
24436 automatic responses. For example:
24437 .code
24438 subject = Re: $h_subject:
24439 .endd
24440 There is a danger in doing this, however. It may allow a third party to
24441 subscribe your users to an opt-in mailing list, provided that the list accepts
24442 bounce messages as subscription confirmations. Well-managed lists require a
24443 non-bounce message to confirm a subscription, so the danger is relatively
24444 small.
24445
24446
24447
24448 .option text autoreply string&!! unset
24449 This specifies a single string to be used as the body of the message when the
24450 message is specified by the transport. If both &%text%& and &%file%& are set,
24451 the text comes first.
24452
24453
24454 .option to autoreply string&!! unset
24455 This specifies recipients of the message and the contents of the &'To:'& header
24456 when the message is specified by the transport.
24457 .ecindex IIDauttra1
24458 .ecindex IIDauttra2
24459
24460
24461
24462
24463 . ////////////////////////////////////////////////////////////////////////////
24464 . ////////////////////////////////////////////////////////////////////////////
24465
24466 .chapter "The lmtp transport" "CHAPLMTP"
24467 .cindex "transports" "&(lmtp)&"
24468 .cindex "&(lmtp)& transport"
24469 .cindex "LMTP" "over a pipe"
24470 .cindex "LMTP" "over a socket"
24471 The &(lmtp)& transport runs the LMTP protocol (RFC 2033) over a pipe to a
24472 specified command
24473 or by interacting with a Unix domain socket.
24474 This transport is something of a cross between the &(pipe)& and &(smtp)&
24475 transports. Exim also has support for using LMTP over TCP/IP; this is
24476 implemented as an option for the &(smtp)& transport. Because LMTP is expected
24477 to be of minority interest, the default build-time configure in &_src/EDITME_&
24478 has it commented out. You need to ensure that
24479 .code
24480 TRANSPORT_LMTP=yes
24481 .endd
24482 .cindex "options" "&(lmtp)& transport"
24483 is present in your &_Local/Makefile_& in order to have the &(lmtp)& transport
24484 included in the Exim binary. The private options of the &(lmtp)& transport are
24485 as follows:
24486
24487 .option batch_id lmtp string&!! unset
24488 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
24489
24490
24491 .option batch_max lmtp integer 1
24492 This limits the number of addresses that can be handled in a single delivery.
24493 Most LMTP servers can handle several addresses at once, so it is normally a
24494 good idea to increase this value. See the description of local delivery
24495 batching in chapter &<<CHAPbatching>>&.
24496
24497
24498 .option command lmtp string&!! unset
24499 This option must be set if &%socket%& is not set. The string is a command which
24500 is run in a separate process. It is split up into a command name and list of
24501 arguments, each of which is separately expanded (so expansion cannot change the
24502 number of arguments). The command is run directly, not via a shell. The message
24503 is passed to the new process using the standard input and output to operate the
24504 LMTP protocol.
24505
24506 .option ignore_quota lmtp boolean false
24507 .cindex "LMTP" "ignoring quota errors"
24508 If this option is set true, the string &`IGNOREQUOTA`& is added to RCPT
24509 commands, provided that the LMTP server has advertised support for IGNOREQUOTA
24510 in its response to the LHLO command.
24511
24512 .option socket lmtp string&!! unset
24513 This option must be set if &%command%& is not set. The result of expansion must
24514 be the name of a Unix domain socket. The transport connects to the socket and
24515 delivers the message to it using the LMTP protocol.
24516
24517
24518 .option timeout lmtp time 5m
24519 The transport is aborted if the created process or Unix domain socket does not
24520 respond to LMTP commands or message input within this timeout. Delivery
24521 is deferred, and will be tried again later. Here is an example of a typical
24522 LMTP transport:
24523 .code
24524 lmtp:
24525   driver = lmtp
24526   command = /some/local/lmtp/delivery/program
24527   batch_max = 20
24528   user = exim
24529 .endd
24530 This delivers up to 20 addresses at a time, in a mixture of domains if
24531 necessary, running as the user &'exim'&.
24532
24533
24534
24535 . ////////////////////////////////////////////////////////////////////////////
24536 . ////////////////////////////////////////////////////////////////////////////
24537
24538 .chapter "The pipe transport" "CHAPpipetransport"
24539 .scindex IIDpiptra1 "transports" "&(pipe)&"
24540 .scindex IIDpiptra2 "&(pipe)& transport"
24541 The &(pipe)& transport is used to deliver messages via a pipe to a command
24542 running in another process. One example is the use of &(pipe)& as a
24543 pseudo-remote transport for passing messages to some other delivery mechanism
24544 (such as UUCP). Another is the use by individual users to automatically process
24545 their incoming messages. The &(pipe)& transport can be used in one of the
24546 following ways:
24547
24548 .ilist
24549 .vindex "&$local_part$&"
24550 A router routes one address to a transport in the normal way, and the
24551 transport is configured as a &(pipe)& transport. In this case, &$local_part$&
24552 contains the local part of the address (as usual), and the command that is run
24553 is specified by the &%command%& option on the transport.
24554 .next
24555 .vindex "&$pipe_addresses$&"
24556 If the &%batch_max%& option is set greater than 1 (the default is 1), the
24557 transport can handle more than one address in a single run. In this case, when
24558 more than one address is routed to the transport, &$local_part$& is not set
24559 (because it is not unique). However, the pseudo-variable &$pipe_addresses$&
24560 (described in section &<<SECThowcommandrun>>& below) contains all the addresses
24561 that are routed to the transport.
24562 .next
24563 .vindex "&$address_pipe$&"
24564 A router redirects an address directly to a pipe command (for example, from an
24565 alias or forward file). In this case, &$address_pipe$& contains the text of the
24566 pipe command, and the &%command%& option on the transport is ignored unless
24567 &%force_command%& is set. If only one address is being transported
24568 (&%batch_max%& is not greater than one, or only one address was redirected to
24569 this pipe command), &$local_part$& contains the local part that was redirected.
24570 .endlist
24571
24572
24573 The &(pipe)& transport is a non-interactive delivery method. Exim can also
24574 deliver messages over pipes using the LMTP interactive protocol. This is
24575 implemented by the &(lmtp)& transport.
24576
24577 In the case when &(pipe)& is run as a consequence of an entry in a local user's
24578 &_.forward_& file, the command runs under the uid and gid of that user. In
24579 other cases, the uid and gid have to be specified explicitly, either on the
24580 transport or on the router that handles the address. Current and &"home"&
24581 directories are also controllable. See chapter &<<CHAPenvironment>>& for
24582 details of the local delivery environment and chapter &<<CHAPbatching>>&
24583 for a discussion of local delivery batching.
24584
24585 .cindex "tainted data" "in pipe command"
24586 .cindex pipe "tainted data"
24587 Tainted data may not be used for the command name.
24588
24589
24590 .section "Concurrent delivery" "SECID140"
24591 If two messages arrive at almost the same time, and both are routed to a pipe
24592 delivery, the two pipe transports may be run concurrently. You must ensure that
24593 any pipe commands you set up are robust against this happening. If the commands
24594 write to a file, the &%exim_lock%& utility might be of use.
24595 Alternatively the &%max_parallel%& option could be used with a value
24596 of "1" to enforce serialization.
24597
24598
24599
24600
24601 .section "Returned status and data" "SECID141"
24602 .cindex "&(pipe)& transport" "returned data"
24603 If the command exits with a non-zero return code, the delivery is deemed to
24604 have failed, unless either the &%ignore_status%& option is set (in which case
24605 the return code is treated as zero), or the return code is one of those listed
24606 in the &%temp_errors%& option, which are interpreted as meaning &"try again
24607 later"&. In this case, delivery is deferred. Details of a permanent failure are
24608 logged, but are not included in the bounce message, which merely contains
24609 &"local delivery failed"&.
24610
24611 If the command exits on a signal and the &%freeze_signal%& option is set then
24612 the message will be frozen in the queue. If that option is not set, a bounce
24613 will be sent as normal.
24614
24615 If the return code is greater than 128 and the command being run is a shell
24616 script, it normally means that the script was terminated by a signal whose
24617 value is the return code minus 128. The &%freeze_signal%& option does not
24618 apply in this case.
24619
24620 If Exim is unable to run the command (that is, if &[execve()]& fails), the
24621 return code is set to 127. This is the value that a shell returns if it is
24622 asked to run a non-existent command. The wording for the log line suggests that
24623 a non-existent command may be the problem.
24624
24625 The &%return_output%& option can affect the result of a pipe delivery. If it is
24626 set and the command produces any output on its standard output or standard
24627 error streams, the command is considered to have failed, even if it gave a zero
24628 return code or if &%ignore_status%& is set. The output from the command is
24629 included as part of the bounce message. The &%return_fail_output%& option is
24630 similar, except that output is returned only when the command exits with a
24631 failure return code, that is, a value other than zero or a code that matches
24632 &%temp_errors%&.
24633
24634
24635
24636 .section "How the command is run" "SECThowcommandrun"
24637 .cindex "&(pipe)& transport" "path for command"
24638 The command line is (by default) broken down into a command name and arguments
24639 by the &(pipe)& transport itself. The &%allow_commands%& and
24640 &%restrict_to_path%& options can be used to restrict the commands that may be
24641 run.
24642
24643 .cindex "quoting" "in pipe command"
24644 Unquoted arguments are delimited by white space. If an argument appears in
24645 double quotes, backslash is interpreted as an escape character in the usual
24646 way. If an argument appears in single quotes, no escaping is done.
24647
24648 String expansion is applied to the command line except when it comes from a
24649 traditional &_.forward_& file (commands from a filter file are expanded). The
24650 expansion is applied to each argument in turn rather than to the whole line.
24651 For this reason, any string expansion item that contains white space must be
24652 quoted so as to be contained within a single argument. A setting such as
24653 .code
24654 command = /some/path ${if eq{$local_part}{postmaster}{xx}{yy}}
24655 .endd
24656 will not work, because the expansion item gets split between several
24657 arguments. You have to write
24658 .code
24659 command = /some/path "${if eq{$local_part}{postmaster}{xx}{yy}}"
24660 .endd
24661 to ensure that it is all in one argument. The expansion is done in this way,
24662 argument by argument, so that the number of arguments cannot be changed as a
24663 result of expansion, and quotes or backslashes in inserted variables do not
24664 interact with external quoting. However, this leads to problems if you want to
24665 generate multiple arguments (or the command name plus arguments) from a single
24666 expansion. In this situation, the simplest solution is to use a shell. For
24667 example:
24668 .code
24669 command = /bin/sh -c ${lookup{$local_part}lsearch{/some/file}}
24670 .endd
24671
24672 .cindex "transport" "filter"
24673 .cindex "filter" "transport filter"
24674 .vindex "&$pipe_addresses$&"
24675 Special handling takes place when an argument consists of precisely the text
24676 &`$pipe_addresses`& (no quotes).
24677 This is not a general expansion variable; the only
24678 place this string is recognized is when it appears as an argument for a pipe or
24679 transport filter command. It causes each address that is being handled to be
24680 inserted in the argument list at that point &'as a separate argument'&. This
24681 avoids any problems with spaces or shell metacharacters, and is of use when a
24682 &(pipe)& transport is handling groups of addresses in a batch.
24683
24684 If &%force_command%& is enabled on the transport, special handling takes place
24685 for an argument that consists of precisely the text &`$address_pipe`&.  It
24686 is handled similarly to &$pipe_addresses$& above.  It is expanded and each
24687 argument is inserted in the argument list at that point
24688 &'as a separate argument'&.  The &`$address_pipe`& item does not need to be
24689 the only item in the argument; in fact, if it were then &%force_command%&
24690 should behave as a no-op.  Rather, it should be used to adjust the command
24691 run while preserving the argument vector separation.
24692
24693 After splitting up into arguments and expansion, the resulting command is run
24694 in a subprocess directly from the transport, &'not'& under a shell. The
24695 message that is being delivered is supplied on the standard input, and the
24696 standard output and standard error are both connected to a single pipe that is
24697 read by Exim. The &%max_output%& option controls how much output the command
24698 may produce, and the &%return_output%& and &%return_fail_output%& options
24699 control what is done with it.
24700
24701 Not running the command under a shell (by default) lessens the security risks
24702 in cases when a command from a user's filter file is built out of data that was
24703 taken from an incoming message. If a shell is required, it can of course be
24704 explicitly specified as the command to be run. However, there are circumstances
24705 where existing commands (for example, in &_.forward_& files) expect to be run
24706 under a shell and cannot easily be modified. To allow for these cases, there is
24707 an option called &%use_shell%&, which changes the way the &(pipe)& transport
24708 works. Instead of breaking up the command line as just described, it expands it
24709 as a single string and passes the result to &_/bin/sh_&. The
24710 &%restrict_to_path%& option and the &$pipe_addresses$& facility cannot be used
24711 with &%use_shell%&, and the whole mechanism is inherently less secure.
24712
24713
24714
24715 .section "Environment variables" "SECTpipeenv"
24716 .cindex "&(pipe)& transport" "environment for command"
24717 .cindex "environment" "&(pipe)& transport"
24718 The environment variables listed below are set up when the command is invoked.
24719 This list is a compromise for maximum compatibility with other MTAs. Note that
24720 the &%environment%& option can be used to add additional variables to this
24721 environment. The environment for the &(pipe)& transport is not subject
24722 to the &%add_environment%& and &%keep_environment%& main config options.
24723 .display
24724 &`DOMAIN            `&   the domain of the address
24725 &`HOME              `&   the home directory, if set
24726 &`HOST              `&   the host name when called from a router (see below)
24727 &`LOCAL_PART        `&   see below
24728 &`LOCAL_PART_PREFIX `&   see below
24729 &`LOCAL_PART_SUFFIX `&   see below
24730 &`LOGNAME           `&   see below
24731 &`MESSAGE_ID        `&   Exim's local ID for the message
24732 &`PATH              `&   as specified by the &%path%& option below
24733 &`QUALIFY_DOMAIN    `&   the sender qualification domain
24734 &`RECIPIENT         `&   the complete recipient address
24735 &`SENDER            `&   the sender of the message (empty if a bounce)
24736 &`SHELL             `&   &`/bin/sh`&
24737 &`TZ                `&   the value of the &%timezone%& option, if set
24738 &`USER              `&   see below
24739 .endd
24740 When a &(pipe)& transport is called directly from (for example) an &(accept)&
24741 router, LOCAL_PART is set to the local part of the address. When it is
24742 called as a result of a forward or alias expansion, LOCAL_PART is set to
24743 the local part of the address that was expanded. In both cases, any affixes are
24744 removed from the local part, and made available in LOCAL_PART_PREFIX and
24745 LOCAL_PART_SUFFIX, respectively. LOGNAME and USER are set to the
24746 same value as LOCAL_PART for compatibility with other MTAs.
24747
24748 .cindex "HOST"
24749 HOST is set only when a &(pipe)& transport is called from a router that
24750 associates hosts with an address, typically when using &(pipe)& as a
24751 pseudo-remote transport. HOST is set to the first host name specified by
24752 the router.
24753
24754 .cindex "HOME"
24755 If the transport's generic &%home_directory%& option is set, its value is used
24756 for the HOME environment variable. Otherwise, a home directory may be set
24757 by the router's &%transport_home_directory%& option, which defaults to the
24758 user's home directory if &%check_local_user%& is set.
24759
24760
24761 .section "Private options for pipe" "SECID142"
24762 .cindex "options" "&(pipe)& transport"
24763
24764
24765
24766 .option allow_commands pipe "string list&!!" unset
24767 .cindex "&(pipe)& transport" "permitted commands"
24768 The string is expanded, and is then interpreted as a colon-separated list of
24769 permitted commands. If &%restrict_to_path%& is not set, the only commands
24770 permitted are those in the &%allow_commands%& list. They need not be absolute
24771 paths; the &%path%& option is still used for relative paths. If
24772 &%restrict_to_path%& is set with &%allow_commands%&, the command must either be
24773 in the &%allow_commands%& list, or a name without any slashes that is found on
24774 the path. In other words, if neither &%allow_commands%& nor
24775 &%restrict_to_path%& is set, there is no restriction on the command, but
24776 otherwise only commands that are permitted by one or the other are allowed. For
24777 example, if
24778 .code
24779 allow_commands = /usr/bin/vacation
24780 .endd
24781 and &%restrict_to_path%& is not set, the only permitted command is
24782 &_/usr/bin/vacation_&. The &%allow_commands%& option may not be set if
24783 &%use_shell%& is set.
24784
24785
24786 .option batch_id pipe string&!! unset
24787 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
24788
24789
24790 .option batch_max pipe integer 1
24791 This limits the number of addresses that can be handled in a single delivery.
24792 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
24793
24794
24795 .option check_string pipe string unset
24796 As &(pipe)& writes the message, the start of each line is tested for matching
24797 &%check_string%&, and if it does, the initial matching characters are replaced
24798 by the contents of &%escape_string%&, provided both are set. The value of
24799 &%check_string%& is a literal string, not a regular expression, and the case of
24800 any letters it contains is significant. When &%use_bsmtp%& is set, the contents
24801 of &%check_string%& and &%escape_string%& are forced to values that implement
24802 the SMTP escaping protocol. Any settings made in the configuration file are
24803 ignored.
24804
24805
24806 .option command pipe string&!! unset
24807 This option need not be set when &(pipe)& is being used to deliver to pipes
24808 obtained directly from address redirections. In other cases, the option must be
24809 set, to provide a command to be run. It need not yield an absolute path (see
24810 the &%path%& option below). The command is split up into separate arguments by
24811 Exim, and each argument is separately expanded, as described in section
24812 &<<SECThowcommandrun>>& above.
24813
24814
24815 .option environment pipe string&!! unset
24816 .cindex "&(pipe)& transport" "environment for command"
24817 .cindex "environment" "&(pipe)& transport"
24818 This option is used to add additional variables to the environment in which the
24819 command runs (see section &<<SECTpipeenv>>& for the default list). Its value is
24820 a string which is expanded, and then interpreted as a colon-separated list of
24821 environment settings of the form <&'name'&>=<&'value'&>.
24822
24823
24824 .option escape_string pipe string unset
24825 See &%check_string%& above.
24826
24827
24828 .option freeze_exec_fail pipe boolean false
24829 .cindex "exec failure"
24830 .cindex "failure of exec"
24831 .cindex "&(pipe)& transport" "failure of exec"
24832 Failure to exec the command in a pipe transport is by default treated like
24833 any other failure while running the command. However, if &%freeze_exec_fail%&
24834 is set, failure to exec is treated specially, and causes the message to be
24835 frozen, whatever the setting of &%ignore_status%&.
24836
24837
24838 .option freeze_signal pipe boolean false
24839 .cindex "signal exit"
24840 .cindex "&(pipe)& transport", "signal exit"
24841 Normally if the process run by a command in a pipe transport exits on a signal,
24842 a bounce message is sent. If &%freeze_signal%& is set, the message will be
24843 frozen in Exim's queue instead.
24844
24845
24846 .option force_command pipe boolean false
24847 .cindex "force command"
24848 .cindex "&(pipe)& transport", "force command"
24849 Normally when a router redirects an address directly to a pipe command
24850 the &%command%& option on the transport is ignored.  If &%force_command%&
24851 is set, the &%command%& option will used. This is especially
24852 useful for forcing a wrapper or additional argument to be added to the
24853 command. For example:
24854 .code
24855 command = /usr/bin/remote_exec myhost -- $address_pipe
24856 force_command
24857 .endd
24858
24859 Note that &$address_pipe$& is handled specially in &%command%& when
24860 &%force_command%& is set, expanding out to the original argument vector as
24861 separate items, similarly to a Unix shell &`"$@"`& construct.
24862
24863
24864 .option ignore_status pipe boolean false
24865 If this option is true, the status returned by the subprocess that is set up to
24866 run the command is ignored, and Exim behaves as if zero had been returned.
24867 Otherwise, a non-zero status or termination by signal causes an error return
24868 from the transport unless the status value is one of those listed in
24869 &%temp_errors%&; these cause the delivery to be deferred and tried again later.
24870
24871 &*Note*&: This option does not apply to timeouts, which do not return a status.
24872 See the &%timeout_defer%& option for how timeouts are handled.
24873
24874
24875 .option log_defer_output pipe boolean false
24876 .cindex "&(pipe)& transport" "logging output"
24877 If this option is set, and the status returned by the command is
24878 one of the codes listed in &%temp_errors%& (that is, delivery was deferred),
24879 and any output was produced on stdout or stderr, the first line of it is
24880 written to the main log.
24881
24882
24883 .option log_fail_output pipe boolean false
24884 If this option is set, and the command returns any output on stdout or
24885 stderr, and also ends with a return code that is neither zero nor one of
24886 the return codes listed in &%temp_errors%& (that is, the delivery
24887 failed), the first line of output is written to the main log. This
24888 option and &%log_output%& are mutually exclusive.  Only one of them may
24889 be set.
24890
24891
24892 .option log_output pipe boolean false
24893 If this option is set and the command returns any output on stdout or
24894 stderr, the first line of output is written to the main log, whatever
24895 the return code. This option and &%log_fail_output%& are mutually
24896 exclusive. Only one of them may be set.
24897
24898
24899 .option max_output pipe integer 20K
24900 This specifies the maximum amount of output that the command may produce on its
24901 standard output and standard error file combined. If the limit is exceeded, the
24902 process running the command is killed. This is intended as a safety measure to
24903 catch runaway processes. The limit is applied independently of the settings of
24904 the options that control what is done with such output (for example,
24905 &%return_output%&). Because of buffering effects, the amount of output may
24906 exceed the limit by a small amount before Exim notices.
24907
24908
24909 .option message_prefix pipe string&!! "see below"
24910 The string specified here is expanded and output at the start of every message.
24911 The default is unset if &%use_bsmtp%& is set. Otherwise it is
24912 .code
24913 message_prefix = \
24914   From ${if def:return_path{$return_path}{MAILER-DAEMON}}\
24915   ${tod_bsdinbox}\n
24916 .endd
24917 .cindex "Cyrus"
24918 .cindex "&%tmail%&"
24919 .cindex "&""From""& line"
24920 This is required by the commonly used &_/usr/bin/vacation_& program.
24921 However, it must &'not'& be present if delivery is to the Cyrus IMAP server,
24922 or to the &%tmail%& local delivery agent. The prefix can be suppressed by
24923 setting
24924 .code
24925 message_prefix =
24926 .endd
24927 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
24928 &`\n`& to &`\r\n`& in &%message_prefix%&.
24929
24930
24931 .option message_suffix pipe string&!! "see below"
24932 The string specified here is expanded and output at the end of every message.
24933 The default is unset if &%use_bsmtp%& is set. Otherwise it is a single newline.
24934 The suffix can be suppressed by setting
24935 .code
24936 message_suffix =
24937 .endd
24938 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
24939 &`\n`& to &`\r\n`& in &%message_suffix%&.
24940
24941
24942 .option path pipe string&!! "/bin:/usr/bin"
24943 This option is expanded and
24944 specifies the string that is set up in the PATH environment
24945 variable of the subprocess.
24946 If the &%command%& option does not yield an absolute path name, the command is
24947 sought in the PATH directories, in the usual way. &*Warning*&: This does not
24948 apply to a command specified as a transport filter.
24949
24950
24951 .option permit_coredump pipe boolean false
24952 Normally Exim inhibits core-dumps during delivery.  If you have a need to get
24953 a core-dump of a pipe command, enable this command.  This enables core-dumps
24954 during delivery and affects both the Exim binary and the pipe command run.
24955 It is recommended that this option remain off unless and until you have a need
24956 for it and that this only be enabled when needed, as the risk of excessive
24957 resource consumption can be quite high.  Note also that Exim is typically
24958 installed as a setuid binary and most operating systems will inhibit coredumps
24959 of these by default, so further OS-specific action may be required.
24960
24961
24962 .option pipe_as_creator pipe boolean false
24963 .cindex "uid (user id)" "local delivery"
24964 If the generic &%user%& option is not set and this option is true, the delivery
24965 process is run under the uid that was in force when Exim was originally called
24966 to accept the message. If the group id is not otherwise set (via the generic
24967 &%group%& option), the gid that was in force when Exim was originally called to
24968 accept the message is used.
24969
24970
24971 .option restrict_to_path pipe boolean false
24972 When this option is set, any command name not listed in &%allow_commands%& must
24973 contain no slashes. The command is searched for only in the directories listed
24974 in the &%path%& option. This option is intended for use in the case when a pipe
24975 command has been generated from a user's &_.forward_& file. This is usually
24976 handled by a &(pipe)& transport called &%address_pipe%&.
24977
24978
24979 .option return_fail_output pipe boolean false
24980 If this option is true, and the command produced any output and ended with a
24981 return code other than zero or one of the codes listed in &%temp_errors%& (that
24982 is, the delivery failed), the output is returned in the bounce message.
24983 However, if the message has a null sender (that is, it is itself a bounce
24984 message), output from the command is discarded. This option and
24985 &%return_output%& are mutually exclusive. Only one of them may be set.
24986
24987
24988
24989 .option return_output pipe boolean false
24990 If this option is true, and the command produced any output, the delivery is
24991 deemed to have failed whatever the return code from the command, and the output
24992 is returned in the bounce message. Otherwise, the output is just discarded.
24993 However, if the message has a null sender (that is, it is a bounce message),
24994 output from the command is always discarded, whatever the setting of this
24995 option. This option and &%return_fail_output%& are mutually exclusive. Only one
24996 of them may be set.
24997
24998
24999
25000 .option temp_errors pipe "string list" "see below"
25001 .cindex "&(pipe)& transport" "temporary failure"
25002 This option contains either a colon-separated list of numbers, or a single
25003 asterisk. If &%ignore_status%& is false
25004 and &%return_output%& is not set,
25005 and the command exits with a non-zero return code, the failure is treated as
25006 temporary and the delivery is deferred if the return code matches one of the
25007 numbers, or if the setting is a single asterisk. Otherwise, non-zero return
25008 codes are treated as permanent errors. The default setting contains the codes
25009 defined by EX_TEMPFAIL and EX_CANTCREAT in &_sysexits.h_&. If Exim is
25010 compiled on a system that does not define these macros, it assumes values of 75
25011 and 73, respectively.
25012
25013
25014 .option timeout pipe time 1h
25015 If the command fails to complete within this time, it is killed. This normally
25016 causes the delivery to fail (but see &%timeout_defer%&). A zero time interval
25017 specifies no timeout. In order to ensure that any subprocesses created by the
25018 command are also killed, Exim makes the initial process a process group leader,
25019 and kills the whole process group on a timeout. However, this can be defeated
25020 if one of the processes starts a new process group.
25021
25022 .option timeout_defer pipe boolean false
25023 A timeout in a &(pipe)& transport, either in the command that the transport
25024 runs, or in a transport filter that is associated with it, is by default
25025 treated as a hard error, and the delivery fails. However, if &%timeout_defer%&
25026 is set true, both kinds of timeout become temporary errors, causing the
25027 delivery to be deferred.
25028
25029 .option umask pipe "octal integer" 022
25030 This specifies the umask setting for the subprocess that runs the command.
25031
25032
25033 .option use_bsmtp pipe boolean false
25034 .cindex "envelope sender"
25035 If this option is set true, the &(pipe)& transport writes messages in &"batch
25036 SMTP"& format, with the envelope sender and recipient(s) included as SMTP
25037 commands. If you want to include a leading HELO command with such messages,
25038 you can do so by setting the &%message_prefix%& option. See section
25039 &<<SECTbatchSMTP>>& for details of batch SMTP.
25040
25041 .option use_classresources pipe boolean false
25042 .cindex "class resources (BSD)"
25043 This option is available only when Exim is running on FreeBSD, NetBSD, or
25044 BSD/OS. If it is set true, the &[setclassresources()]& function is used to set
25045 resource limits when a &(pipe)& transport is run to perform a delivery. The
25046 limits for the uid under which the pipe is to run are obtained from the login
25047 class database.
25048
25049
25050 .option use_crlf pipe boolean false
25051 .cindex "carriage return"
25052 .cindex "linefeed"
25053 This option causes lines to be terminated with the two-character CRLF sequence
25054 (carriage return, linefeed) instead of just a linefeed character. In the case
25055 of batched SMTP, the byte sequence written to the pipe is then an exact image
25056 of what would be sent down a real SMTP connection.
25057
25058 The contents of the &%message_prefix%& and &%message_suffix%& options are
25059 written verbatim, so must contain their own carriage return characters if these
25060 are needed. When &%use_bsmtp%& is not set, the default values for both
25061 &%message_prefix%& and &%message_suffix%& end with a single linefeed, so their
25062 values must be changed to end with &`\r\n`& if &%use_crlf%& is set.
25063
25064
25065 .option use_shell pipe boolean false
25066 .vindex "&$pipe_addresses$&"
25067 If this option is set, it causes the command to be passed to &_/bin/sh_&
25068 instead of being run directly from the transport, as described in section
25069 &<<SECThowcommandrun>>&. This is less secure, but is needed in some situations
25070 where the command is expected to be run under a shell and cannot easily be
25071 modified. The &%allow_commands%& and &%restrict_to_path%& options, and the
25072 &`$pipe_addresses`& facility are incompatible with &%use_shell%&. The
25073 command is expanded as a single string, and handed to &_/bin/sh_& as data for
25074 its &%-c%& option.
25075
25076
25077
25078 .section "Using an external local delivery agent" "SECID143"
25079 .cindex "local delivery" "using an external agent"
25080 .cindex "&'procmail'&"
25081 .cindex "external local delivery"
25082 .cindex "delivery" "&'procmail'&"
25083 .cindex "delivery" "by external agent"
25084 The &(pipe)& transport can be used to pass all messages that require local
25085 delivery to a separate local delivery agent such as &%procmail%&. When doing
25086 this, care must be taken to ensure that the pipe is run under an appropriate
25087 uid and gid. In some configurations one wants this to be a uid that is trusted
25088 by the delivery agent to supply the correct sender of the message. It may be
25089 necessary to recompile or reconfigure the delivery agent so that it trusts an
25090 appropriate user. The following is an example transport and router
25091 configuration for &%procmail%&:
25092 .code
25093 # transport
25094 procmail_pipe:
25095   driver = pipe
25096   command = /usr/local/bin/procmail -d $local_part_data
25097   return_path_add
25098   delivery_date_add
25099   envelope_to_add
25100   check_string = "From "
25101   escape_string = ">From "
25102   umask = 077
25103   user = $local_part_data
25104   group = mail
25105
25106 # router
25107 procmail:
25108   driver = accept
25109   check_local_user
25110   transport = procmail_pipe
25111 .endd
25112 In this example, the pipe is run as the local user, but with the group set to
25113 &'mail'&. An alternative is to run the pipe as a specific user such as &'mail'&
25114 or &'exim'&, but in this case you must arrange for &%procmail%& to trust that
25115 user to supply a correct sender address. If you do not specify either a
25116 &%group%& or a &%user%& option, the pipe command is run as the local user. The
25117 home directory is the user's home directory by default.
25118
25119 &*Note*&: The command that the pipe transport runs does &'not'& begin with
25120 .code
25121 IFS=" "
25122 .endd
25123 as shown in some &%procmail%& documentation, because Exim does not by default
25124 use a shell to run pipe commands.
25125
25126 .cindex "Cyrus"
25127 The next example shows a transport and a router for a system where local
25128 deliveries are handled by the Cyrus IMAP server.
25129 .code
25130 # transport
25131 local_delivery_cyrus:
25132   driver = pipe
25133   command = /usr/cyrus/bin/deliver \
25134             -m ${substr_1:$local_part_suffix} -- $local_part
25135   user = cyrus
25136   group = mail
25137   return_output
25138   log_output
25139   message_prefix =
25140   message_suffix =
25141
25142 # router
25143 local_user_cyrus:
25144   driver = accept
25145   check_local_user
25146   local_part_suffix = .*
25147   transport = local_delivery_cyrus
25148 .endd
25149 Note the unsetting of &%message_prefix%& and &%message_suffix%&, and the use of
25150 &%return_output%& to cause any text written by Cyrus to be returned to the
25151 sender.
25152 .ecindex IIDpiptra1
25153 .ecindex IIDpiptra2
25154
25155
25156 . ////////////////////////////////////////////////////////////////////////////
25157 . ////////////////////////////////////////////////////////////////////////////
25158
25159 .chapter "The smtp transport" "CHAPsmtptrans"
25160 .scindex IIDsmttra1 "transports" "&(smtp)&"
25161 .scindex IIDsmttra2 "&(smtp)& transport"
25162 The &(smtp)& transport delivers messages over TCP/IP connections using the SMTP
25163 or LMTP protocol. The list of hosts to try can either be taken from the address
25164 that is being processed (having been set up by the router), or specified
25165 explicitly for the transport. Timeout and retry processing (see chapter
25166 &<<CHAPretry>>&) is applied to each IP address independently.
25167
25168
25169 .section "Multiple messages on a single connection" "SECID144"
25170 The sending of multiple messages over a single TCP/IP connection can arise in
25171 two ways:
25172
25173 .ilist
25174 If a message contains more than &%max_rcpt%& (see below) addresses that are
25175 routed to the same host, more than one copy of the message has to be sent to
25176 that host. In this situation, multiple copies may be sent in a single run of
25177 the &(smtp)& transport over a single TCP/IP connection. (What Exim actually
25178 does when it has too many addresses to send in one message also depends on the
25179 value of the global &%remote_max_parallel%& option. Details are given in
25180 section &<<SECToutSMTPTCP>>&.)
25181 .next
25182 .cindex "hints database" "remembering routing"
25183 When a message has been successfully delivered over a TCP/IP connection, Exim
25184 looks in its hints database to see if there are any other messages awaiting a
25185 connection to the same host. If there are, a new delivery process is started
25186 for one of them, and the current TCP/IP connection is passed on to it. The new
25187 process may in turn send multiple copies and possibly create yet another
25188 process.
25189 .endlist
25190
25191
25192 For each copy sent over the same TCP/IP connection, a sequence counter is
25193 incremented, and if it ever gets to the value of &%connection_max_messages%&,
25194 no further messages are sent over that connection.
25195
25196
25197
25198 .section "Use of the $host and $host_address variables" "SECID145"
25199 .vindex "&$host$&"
25200 .vindex "&$host_address$&"
25201 At the start of a run of the &(smtp)& transport, the values of &$host$& and
25202 &$host_address$& are the name and IP address of the first host on the host list
25203 passed by the router. However, when the transport is about to connect to a
25204 specific host, and while it is connected to that host, &$host$& and
25205 &$host_address$& are set to the values for that host. These are the values
25206 that are in force when the &%helo_data%&, &%hosts_try_auth%&, &%interface%&,
25207 &%serialize_hosts%&, and the various TLS options are expanded.
25208
25209
25210 .section "Use of $tls_cipher and $tls_peerdn" "usecippeer"
25211 .vindex &$tls_bits$&
25212 .vindex &$tls_cipher$&
25213 .vindex &$tls_peerdn$&
25214 .vindex &$tls_sni$&
25215 At the start of a run of the &(smtp)& transport, the values of &$tls_bits$&,
25216 &$tls_cipher$&, &$tls_peerdn$& and &$tls_sni$&
25217 are the values that were set when the message was received.
25218 These are the values that are used for options that are expanded before any
25219 SMTP connections are made. Just before each connection is made, these four
25220 variables are emptied. If TLS is subsequently started, they are set to the
25221 appropriate values for the outgoing connection, and these are the values that
25222 are in force when any authenticators are run and when the
25223 &%authenticated_sender%& option is expanded.
25224
25225 These variables are deprecated in favour of &$tls_in_cipher$& et. al.
25226 and will be removed in a future release.
25227
25228
25229 .section "Private options for smtp" "SECID146"
25230 .cindex "options" "&(smtp)& transport"
25231 The private options of the &(smtp)& transport are as follows:
25232
25233
25234 .option address_retry_include_sender smtp boolean true
25235 .cindex "4&'xx'& responses" "retrying after"
25236 When an address is delayed because of a 4&'xx'& response to a RCPT command, it
25237 is the combination of sender and recipient that is delayed in subsequent queue
25238 runs until the retry time is reached. You can delay the recipient without
25239 reference to the sender (which is what earlier versions of Exim did), by
25240 setting &%address_retry_include_sender%& false. However, this can lead to
25241 problems with servers that regularly issue 4&'xx'& responses to RCPT commands.
25242
25243 .option allow_localhost smtp boolean false
25244 .cindex "local host" "sending to"
25245 .cindex "fallback" "hosts specified on transport"
25246 When a host specified in &%hosts%& or &%fallback_hosts%& (see below) turns out
25247 to be the local host, or is listed in &%hosts_treat_as_local%&, delivery is
25248 deferred by default. However, if &%allow_localhost%& is set, Exim goes on to do
25249 the delivery anyway. This should be used only in special cases when the
25250 configuration ensures that no looping will result (for example, a differently
25251 configured Exim is listening on the port to which the message is sent).
25252
25253
25254 .option authenticated_sender smtp string&!! unset
25255 .cindex "Cyrus"
25256 When Exim has authenticated as a client, or if &%authenticated_sender_force%&
25257 is true, this option sets a value for the AUTH= item on outgoing MAIL commands,
25258 overriding any existing authenticated sender value. If the string expansion is
25259 forced to fail, the option is ignored. Other expansion failures cause delivery
25260 to be deferred. If the result of expansion is an empty string, that is also
25261 ignored.
25262
25263 The expansion happens after the outgoing connection has been made and TLS
25264 started, if required. This means that the &$host$&, &$host_address$&,
25265 &$tls_out_cipher$&, and &$tls_out_peerdn$& variables are set according to the
25266 particular connection.
25267
25268 If the SMTP session is not authenticated, the expansion of
25269 &%authenticated_sender%& still happens (and can cause the delivery to be
25270 deferred if it fails), but no AUTH= item is added to MAIL commands
25271 unless &%authenticated_sender_force%& is true.
25272
25273 This option allows you to use the &(smtp)& transport in LMTP mode to
25274 deliver mail to Cyrus IMAP and provide the proper local part as the
25275 &"authenticated sender"&, via a setting such as:
25276 .code
25277 authenticated_sender = $local_part
25278 .endd
25279 This removes the need for IMAP subfolders to be assigned special ACLs to
25280 allow direct delivery to those subfolders.
25281
25282 Because of expected uses such as that just described for Cyrus (when no
25283 domain is involved), there is no checking on the syntax of the provided
25284 value.
25285
25286
25287 .option authenticated_sender_force smtp boolean false
25288 If this option is set true, the &%authenticated_sender%& option's value
25289 is used for the AUTH= item on outgoing MAIL commands, even if Exim has not
25290 authenticated as a client.
25291
25292
25293 .option command_timeout smtp time 5m
25294 .cindex timeout "smtp transport command"
25295 This sets a timeout for receiving a response to an SMTP command that has been
25296 sent out. It is also used when waiting for the initial banner line from the
25297 remote host. Its value must not be zero.
25298
25299
25300 .option connect_timeout smtp time 5m
25301 .cindex timeout "smtp transport connect"
25302 This sets a timeout for the &[connect()]& function, which sets up a TCP/IP call
25303 to a remote host. A setting of zero allows the system timeout (typically
25304 several minutes) to act. To have any effect, the value of this option must be
25305 less than the system timeout. However, it has been observed that on some
25306 systems there is no system timeout, which is why the default value for this
25307 option is 5 minutes, a value recommended by RFC 1123.
25308
25309
25310 .option connection_max_messages smtp integer 500
25311 .cindex "SMTP" "passed connection"
25312 .cindex "SMTP" "multiple deliveries"
25313 .cindex "multiple SMTP deliveries"
25314 This controls the maximum number of separate message deliveries that are sent
25315 over a single TCP/IP connection. If the value is zero, there is no limit.
25316 For testing purposes, this value can be overridden by the &%-oB%& command line
25317 option.
25318
25319
25320 .option dane_require_tls_ciphers smtp string&!! unset
25321 .cindex "TLS" "requiring specific ciphers for DANE"
25322 .cindex "cipher" "requiring specific"
25323 .cindex DANE "TLS ciphers"
25324 This option may be used to override &%tls_require_ciphers%& for connections
25325 where DANE has been determined to be in effect.
25326 If not set, then &%tls_require_ciphers%& will be used.
25327 Normal SMTP delivery is not able to make strong demands of TLS cipher
25328 configuration, because delivery will fall back to plaintext.  Once DANE has
25329 been determined to be in effect, there is no plaintext fallback and making the
25330 TLS cipherlist configuration stronger will increase security, rather than
25331 counter-intuitively decreasing it.
25332 If the option expands to be empty or is forced to fail, then it will
25333 be treated as unset and &%tls_require_ciphers%& will be used instead.
25334
25335
25336 .option data_timeout smtp time 5m
25337 .cindex timeout "for transmitted SMTP data blocks"
25338 This sets a timeout for the transmission of each block in the data portion of
25339 the message. As a result, the overall timeout for a message depends on the size
25340 of the message. Its value must not be zero. See also &%final_timeout%&.
25341
25342
25343 .option dkim_canon smtp string&!! unset
25344 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25345 .option dkim_domain smtp "string list&!!" unset
25346 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25347 .option dkim_hash smtp string&!! sha256
25348 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25349 .option dkim_identity smtp string&!! unset
25350 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25351 .option dkim_private_key smtp string&!! unset
25352 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25353 .option dkim_selector smtp string&!! unset
25354 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25355 .option dkim_strict smtp string&!! unset
25356 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25357 .option dkim_sign_headers smtp string&!! "per RFC"
25358 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25359 .option dkim_timestamps smtp string&!! unset
25360 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25361
25362
25363 .option delay_after_cutoff smtp boolean true
25364 .cindex "final cutoff" "retries, controlling"
25365 .cindex retry "final cutoff"
25366 This option controls what happens when all remote IP addresses for a given
25367 domain have been inaccessible for so long that they have passed their retry
25368 cutoff times.
25369
25370 In the default state, if the next retry time has not been reached for any of
25371 them, the address is bounced without trying any deliveries. In other words,
25372 Exim delays retrying an IP address after the final cutoff time until a new
25373 retry time is reached, and can therefore bounce an address without ever trying
25374 a delivery, when machines have been down for a long time. Some people are
25375 unhappy at this prospect, so...
25376
25377 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
25378 addresses are past their final cutoff time, Exim tries to deliver to those
25379 IP addresses that have not been tried since the message arrived. If there are
25380 none, of if they all fail, the address is bounced. In other words, it does not
25381 delay when a new message arrives, but immediately tries those expired IP
25382 addresses that haven't been tried since the message arrived. If there is a
25383 continuous stream of messages for the dead hosts, unsetting
25384 &%delay_after_cutoff%& means that there will be many more attempts to deliver
25385 to them.
25386
25387
25388 .option dns_qualify_single smtp boolean true
25389 If the &%hosts%& or &%fallback_hosts%& option is being used,
25390 and the &%gethostbyname%& option is false,
25391 the RES_DEFNAMES resolver option is set. See the &%qualify_single%& option
25392 in chapter &<<CHAPdnslookup>>& for more details.
25393
25394
25395 .option dns_search_parents smtp boolean false
25396 If the &%hosts%& or &%fallback_hosts%& option is being used, and the
25397 &%gethostbyname%& option is false, the RES_DNSRCH resolver option is set.
25398 See the &%search_parents%& option in chapter &<<CHAPdnslookup>>& for more
25399 details.
25400
25401
25402 .option dnssec_request_domains smtp "domain list&!!" *
25403 .cindex "MX record" "security"
25404 .cindex "DNSSEC" "MX lookup"
25405 .cindex "security" "MX lookup"
25406 .cindex "DNS" "DNSSEC"
25407 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
25408 the DNSSEC request bit set. Setting this transport option is only useful if the
25409 transport overrides or sets the host names. See the &%dnssec_request_domains%&
25410 router option.
25411
25412
25413
25414 .option dnssec_require_domains smtp "domain list&!!" unset
25415 .cindex "MX record" "security"
25416 .cindex "DNSSEC" "MX lookup"
25417 .cindex "security" "MX lookup"
25418 .cindex "DNS" "DNSSEC"
25419 DNS lookups for domains matching &%dnssec_require_domains%& will be done with
25420 the DNSSEC request bit set.  Setting this transport option is only
25421 useful if the transport overrides or sets the host names. See the
25422 &%dnssec_require_domains%& router option.
25423
25424
25425
25426 .option dscp smtp string&!! unset
25427 .cindex "DCSP" "outbound"
25428 This option causes the DSCP value associated with a socket to be set to one
25429 of a number of fixed strings or to numeric value.
25430 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
25431 Common values include &`throughput`&, &`mincost`&, and on newer systems
25432 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
25433
25434 The outbound packets from Exim will be marked with this value in the header
25435 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
25436 that these values will have any effect, not be stripped by networking
25437 equipment, or do much of anything without cooperation with your Network
25438 Engineer and those of all network operators between the source and destination.
25439
25440
25441 .option fallback_hosts smtp "string list" unset
25442 .cindex "fallback" "hosts specified on transport"
25443 String expansion is not applied to this option. The argument must be a
25444 colon-separated list of host names or IP addresses, optionally also including
25445 port numbers, though the separator can be changed, as described in section
25446 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
25447 item in a &%route_list%& setting for the &(manualroute)& router, as described
25448 in section &<<SECTformatonehostitem>>&.
25449
25450 Fallback hosts can also be specified on routers, which associate them with the
25451 addresses they process. As for the &%hosts%& option without &%hosts_override%&,
25452 &%fallback_hosts%& specified on the transport is used only if the address does
25453 not have its own associated fallback host list. Unlike &%hosts%&, a setting of
25454 &%fallback_hosts%& on an address is not overridden by &%hosts_override%&.
25455 However, &%hosts_randomize%& does apply to fallback host lists.
25456
25457 If Exim is unable to deliver to any of the hosts for a particular address, and
25458 the errors are not permanent rejections, the address is put on a separate
25459 transport queue with its host list replaced by the fallback hosts, unless the
25460 address was routed via MX records and the current host was in the original MX
25461 list. In that situation, the fallback host list is not used.
25462
25463 Once normal deliveries are complete, the fallback queue is delivered by
25464 re-running the same transports with the new host lists. If several failing
25465 addresses have the same fallback hosts (and &%max_rcpt%& permits it), a single
25466 copy of the message is sent.
25467
25468 The resolution of the host names on the fallback list is controlled by the
25469 &%gethostbyname%& option, as for the &%hosts%& option. Fallback hosts apply
25470 both to cases when the host list comes with the address and when it is taken
25471 from &%hosts%&. This option provides a &"use a smart host only if delivery
25472 fails"& facility.
25473
25474
25475 .option final_timeout smtp time 10m
25476 .cindex timeout "for transmitted SMTP data accept"
25477 This is the timeout that applies while waiting for the response to the final
25478 line containing just &"."& that terminates a message. Its value must not be
25479 zero.
25480
25481 .option gethostbyname smtp boolean false
25482 If this option is true when the &%hosts%& and/or &%fallback_hosts%& options are
25483 being used, names are looked up using &[gethostbyname()]&
25484 (or &[getipnodebyname()]& when available)
25485 instead of using the DNS. Of course, that function may in fact use the DNS, but
25486 it may also consult other sources of information such as &_/etc/hosts_&.
25487
25488 .option gnutls_compat_mode smtp boolean unset
25489 This option controls whether GnuTLS is used in compatibility mode in an Exim
25490 server. This reduces security slightly, but improves interworking with older
25491 implementations of TLS.
25492
25493 .option helo_data smtp string&!! "see below"
25494 .cindex "HELO" "argument, setting"
25495 .cindex "EHLO" "argument, setting"
25496 .cindex "LHLO argument setting"
25497 The value of this option is expanded after a connection to a another host has
25498 been set up. The result is used as the argument for the EHLO, HELO, or LHLO
25499 command that starts the outgoing SMTP or LMTP session. The default value of the
25500 option is:
25501 .code
25502 $primary_hostname
25503 .endd
25504 During the expansion, the variables &$host$& and &$host_address$& are set to
25505 the identity of the remote host, and the variables &$sending_ip_address$& and
25506 &$sending_port$& are set to the local IP address and port number that are being
25507 used. These variables can be used to generate different values for different
25508 servers or different local IP addresses. For example, if you want the string
25509 that is used for &%helo_data%& to be obtained by a DNS lookup of the outgoing
25510 interface address, you could use this:
25511 .code
25512 helo_data = ${lookup dnsdb{ptr=$sending_ip_address}{$value}\
25513   {$primary_hostname}}
25514 .endd
25515 The use of &%helo_data%& applies both to sending messages and when doing
25516 callouts.
25517
25518 .option hosts smtp "string list&!!" unset
25519 Hosts are associated with an address by a router such as &(dnslookup)&, which
25520 finds the hosts by looking up the address domain in the DNS, or by
25521 &(manualroute)&, which has lists of hosts in its configuration. However,
25522 email addresses can be passed to the &(smtp)& transport by any router, and not
25523 all of them can provide an associated list of hosts.
25524
25525 The &%hosts%& option specifies a list of hosts to be used if the address being
25526 processed does not have any hosts associated with it. The hosts specified by
25527 &%hosts%& are also used, whether or not the address has its own hosts, if
25528 &%hosts_override%& is set.
25529
25530 The string is first expanded, before being interpreted as a colon-separated
25531 list of host names or IP addresses, possibly including port numbers. The
25532 separator may be changed to something other than colon, as described in section
25533 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
25534 item in a &%route_list%& setting for the &(manualroute)& router, as described
25535 in section &<<SECTformatonehostitem>>&. However, note that the &`/MX`& facility
25536 of the &(manualroute)& router is not available here.
25537
25538 If the expansion fails, delivery is deferred. Unless the failure was caused by
25539 the inability to complete a lookup, the error is logged to the panic log as
25540 well as the main log. Host names are looked up either by searching directly for
25541 address records in the DNS or by calling &[gethostbyname()]& (or
25542 &[getipnodebyname()]& when available), depending on the setting of the
25543 &%gethostbyname%& option. When Exim is compiled with IPv6 support, if a host
25544 that is looked up in the DNS has both IPv4 and IPv6 addresses, both types of
25545 address are used.
25546
25547 During delivery, the hosts are tried in order, subject to their retry status,
25548 unless &%hosts_randomize%& is set.
25549
25550
25551 .option hosts_avoid_esmtp smtp "host list&!!" unset
25552 .cindex "ESMTP, avoiding use of"
25553 .cindex "HELO" "forcing use of"
25554 .cindex "EHLO" "avoiding use of"
25555 .cindex "PIPELINING" "avoiding the use of"
25556 This option is for use with broken hosts that announce ESMTP facilities (for
25557 example, PIPELINING) and then fail to implement them properly. When a host
25558 matches &%hosts_avoid_esmtp%&, Exim sends HELO rather than EHLO at the
25559 start of the SMTP session. This means that it cannot use any of the ESMTP
25560 facilities such as AUTH, PIPELINING, SIZE, and STARTTLS.
25561
25562
25563 .option hosts_avoid_pipelining smtp "host list&!!" unset
25564 .cindex "PIPELINING" "avoiding the use of"
25565 .cindex "ESMTP extensions" PIPELINING
25566 Exim will not use the ESMTP PIPELINING extension when delivering to any host
25567 that matches this list, even if the server host advertises PIPELINING support.
25568
25569 .option hosts_pipe_connect smtp "host list&!!" unset
25570 .cindex "pipelining" "early connection"
25571 .cindex "pipelining" PIPE_CONNECT
25572 If Exim is built with the SUPPORT_PIPE_CONNECT build option
25573 this option controls which to hosts the facility watched for
25574 and recorded, and used for subsequent connections.
25575
25576 The retry hints database is used for the record,
25577 and records are subject to the &%retry_data_expire%& option.
25578 When used, the pipelining saves on roundtrip times.
25579 It also turns SMTP into a client-first protocol
25580 so combines well with TCP Fast Open.
25581
25582 See also the &%pipelining_connect_advertise_hosts%& main option.
25583
25584 Note:
25585 When the facility is used, the transport &%helo_data%& option
25586 will be expanded before the &$sending_ip_address$& variable
25587 is filled in.
25588 A check is made for the use of that variable, without the
25589 presence of a &"def:"& test on it, but suitably complex coding
25590 can avoid the check and produce unexpected results.
25591 You have been warned.
25592
25593
25594 .option hosts_avoid_tls smtp "host list&!!" unset
25595 .cindex "TLS" "avoiding for certain hosts"
25596 Exim will not try to start a TLS session when delivering to any host that
25597 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
25598
25599 .option hosts_verify_avoid_tls smtp "host list&!!" unset
25600 .cindex "TLS" "avoiding for certain hosts"
25601 Exim will not try to start a TLS session for a verify callout,
25602 or when delivering in cutthrough mode,
25603 to any host that matches this list.
25604
25605
25606 .option hosts_max_try smtp integer 5
25607 .cindex "host" "maximum number to try"
25608 .cindex "limit" "number of hosts tried"
25609 .cindex "limit" "number of MX tried"
25610 .cindex "MX record" "maximum tried"
25611 This option limits the number of IP addresses that are tried for any one
25612 delivery in cases where there are temporary delivery errors. Section
25613 &<<SECTvalhosmax>>& describes in detail how the value of this option is used.
25614
25615
25616 .option hosts_max_try_hardlimit smtp integer 50
25617 This is an additional check on the maximum number of IP addresses that Exim
25618 tries for any one delivery. Section &<<SECTvalhosmax>>& describes its use and
25619 why it exists.
25620
25621
25622
25623 .option hosts_nopass_tls smtp "host list&!!" unset
25624 .cindex "TLS" "passing connection"
25625 .cindex "multiple SMTP deliveries"
25626 .cindex "TLS" "multiple message deliveries"
25627 For any host that matches this list, a connection on which a TLS session has
25628 been started will not be passed to a new delivery process for sending another
25629 message on the same connection. See section &<<SECTmulmessam>>& for an
25630 explanation of when this might be needed.
25631
25632 .option hosts_noproxy_tls smtp "host list&!!" unset
25633 .cindex "TLS" "passing connection"
25634 .cindex "multiple SMTP deliveries"
25635 .cindex "TLS" "multiple message deliveries"
25636 For any host that matches this list, a TLS session which has
25637 been started will not be passed to a new delivery process for sending another
25638 message on the same session.
25639
25640 The traditional implementation closes down TLS and re-starts it in the new
25641 process, on the same open TCP connection, for each successive message
25642 sent.  If permitted by this option a pipe to to the new process is set up
25643 instead, and the original process maintains the TLS connection and proxies
25644 the SMTP connection from and to the new process and any subsequents.
25645 The new process has no access to TLS information, so cannot include it in
25646 logging.
25647
25648
25649
25650 .option hosts_override smtp boolean false
25651 If this option is set and the &%hosts%& option is also set, any hosts that are
25652 attached to the address are ignored, and instead the hosts specified by the
25653 &%hosts%& option are always used. This option does not apply to
25654 &%fallback_hosts%&.
25655
25656
25657 .option hosts_randomize smtp boolean false
25658 .cindex "randomized host list"
25659 .cindex "host" "list of; randomized"
25660 .cindex "fallback" "randomized hosts"
25661 If this option is set, and either the list of hosts is taken from the
25662 &%hosts%& or the &%fallback_hosts%& option, or the hosts supplied by the router
25663 were not obtained from MX records (this includes fallback hosts from the
25664 router), and were not randomized by the router, the order of trying the hosts
25665 is randomized each time the transport runs. Randomizing the order of a host
25666 list can be used to do crude load sharing.
25667
25668 When &%hosts_randomize%& is true, a host list may be split into groups whose
25669 order is separately randomized. This makes it possible to set up MX-like
25670 behaviour. The boundaries between groups are indicated by an item that is just
25671 &`+`& in the host list. For example:
25672 .code
25673 hosts = host1:host2:host3:+:host4:host5
25674 .endd
25675 The order of the first three hosts and the order of the last two hosts is
25676 randomized for each use, but the first three always end up before the last two.
25677 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored.
25678
25679 .option hosts_require_auth smtp "host list&!!" unset
25680 .cindex "authentication" "required by client"
25681 This option provides a list of servers for which authentication must succeed
25682 before Exim will try to transfer a message. If authentication fails for
25683 servers which are not in this list, Exim tries to send unauthenticated. If
25684 authentication fails for one of these servers, delivery is deferred. This
25685 temporary error is detectable in the retry rules, so it can be turned into a
25686 hard failure if required. See also &%hosts_try_auth%&, and chapter
25687 &<<CHAPSMTPAUTH>>& for details of authentication.
25688
25689
25690 .option hosts_request_ocsp smtp "host list&!!" *
25691 .cindex "TLS" "requiring for certain servers"
25692 Exim will request a Certificate Status on a
25693 TLS session for any host that matches this list.
25694 &%tls_verify_certificates%& should also be set for the transport.
25695
25696 .new
25697 .option hosts_require_alpn smtp "host list&!!" unset
25698 .cindex ALPN "require negotiation in client"
25699 .cindex TLS ALPN
25700 .cindex TLS "Application Layer Protocol Names"
25701 If the TLS library supports ALPN
25702 then a successful negotiation of ALPN will be required for any host
25703 matching the list, for TLS to be used.
25704 See also the &%tls_alpn%& option.
25705
25706 &*Note*&: prevention of fallback to in-clear connection is not
25707 managed by this option; see &%hosts_require_tls%&.
25708 .wen
25709
25710 .option hosts_require_dane smtp "host list&!!" unset
25711 .cindex DANE "transport options"
25712 .cindex DANE "requiring for certain servers"
25713 If built with DANE support, Exim  will require that a DNSSEC-validated
25714 TLSA record is present for any host matching the list,
25715 and that a DANE-verified TLS connection is made.
25716 There will be no fallback to in-clear communication.
25717 See the &%dnssec_request_domains%& router and transport options.
25718 See section &<<SECDANE>>&.
25719
25720 .option hosts_require_helo smtp "host list&!!" *
25721 .cindex "HELO/EHLO" requiring
25722 Exim will require an accepted HELO or EHLO command from a host matching
25723 this list, before accepting a MAIL command.
25724
25725 .option hosts_require_ocsp smtp "host list&!!" unset
25726 .cindex "TLS" "requiring for certain servers"
25727 Exim will request, and check for a valid Certificate Status being given, on a
25728 TLS session for any host that matches this list.
25729 &%tls_verify_certificates%& should also be set for the transport.
25730
25731 .option hosts_require_tls smtp "host list&!!" unset
25732 .cindex "TLS" "requiring for certain servers"
25733 Exim will insist on using a TLS session when delivering to any host that
25734 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
25735 &*Note*&: This option affects outgoing mail only. To insist on TLS for
25736 incoming messages, use an appropriate ACL.
25737
25738 .option hosts_try_auth smtp "host list&!!" unset
25739 .cindex "authentication" "optional in client"
25740 This option provides a list of servers to which, provided they announce
25741 authentication support, Exim will attempt to authenticate as a client when it
25742 connects. If authentication fails
25743 .new
25744 and &%hosts_require_auth%& permits,
25745 .wen
25746 Exim will try to transfer the message unauthenticated.
25747 See also chapter &<<CHAPSMTPAUTH>>& for details of authentication.
25748
25749 .option hosts_try_chunking smtp "host list&!!" *
25750 .cindex CHUNKING "enabling, in client"
25751 .cindex BDAT "SMTP command"
25752 .cindex "RFC 3030" "CHUNKING"
25753 This option provides a list of servers to which, provided they announce
25754 CHUNKING support, Exim will attempt to use BDAT commands rather than DATA.
25755 Unless DKIM signing is being done,
25756 BDAT will not be used in conjunction with a transport filter.
25757
25758 .option hosts_try_dane smtp "host list&!!" *
25759 .cindex DANE "transport options"
25760 .cindex DANE "attempting for certain servers"
25761 .new
25762 If built with DANE support, Exim  will look up a
25763 TLSA record for any host matching the list,
25764 If one is found and that lookup was DNSSEC-validated,
25765 then Exim requires that a DANE-verified TLS connection is made for that host;
25766 there will be no fallback to in-clear communication.
25767 .wen
25768 See the &%dnssec_request_domains%& router and transport options.
25769 See section &<<SECDANE>>&.
25770
25771 .option hosts_try_fastopen smtp "host list&!!" *
25772 .cindex "fast open, TCP" "enabling, in client"
25773 .cindex "TCP Fast Open" "enabling, in client"
25774 .cindex "RFC 7413" "TCP Fast Open"
25775 This option provides a list of servers to which, provided
25776 the facility is supported by this system, Exim will attempt to
25777 perform a TCP Fast Open.
25778 No data is sent on the SYN segment but, if the remote server also
25779 supports the facility, it can send its SMTP banner immediately after
25780 the SYN,ACK segment.  This can save up to one round-trip time.
25781
25782 The facility is only active for previously-contacted servers,
25783 as the initiator must present a cookie in the SYN segment.
25784
25785 On (at least some) current Linux distributions the facility must be enabled
25786 in the kernel by the sysadmin before the support is usable.
25787 There is no option for control of the server side; if the system supports
25788 it it is always enabled.  Note that lengthy operations in the connect ACL,
25789 such as DNSBL lookups, will still delay the emission of the SMTP banner.
25790
25791 .option hosts_try_prdr smtp "host list&!!" *
25792 .cindex "PRDR" "enabling, optional in client"
25793 .cindex "ESMTP extensions" PRDR
25794 This option provides a list of servers to which, provided they announce
25795 PRDR support, Exim will attempt to negotiate PRDR
25796 for multi-recipient messages.
25797 The option can usually be left as default.
25798
25799 .option interface smtp "string list&!!" unset
25800 .cindex "bind IP address"
25801 .cindex "IP address" "binding"
25802 .vindex "&$host$&"
25803 .vindex "&$host_address$&"
25804 This option specifies which interface to bind to when making an outgoing SMTP
25805 call. The value is an IP address, not an interface name such as
25806 &`eth0`&. Do not confuse this with the interface address that was used when a
25807 message was received, which is in &$received_ip_address$&, formerly known as
25808 &$interface_address$&. The name was changed to minimize confusion with the
25809 outgoing interface address. There is no variable that contains an outgoing
25810 interface address because, unless it is set by this option, its value is
25811 unknown.
25812
25813 During the expansion of the &%interface%& option the variables &$host$& and
25814 &$host_address$& refer to the host to which a connection is about to be made
25815 during the expansion of the string. Forced expansion failure, or an empty
25816 string result causes the option to be ignored. Otherwise, after expansion, the
25817 string must be a list of IP addresses, colon-separated by default, but the
25818 separator can be changed in the usual way (&<<SECTlistsepchange>>&).
25819 For example:
25820 .code
25821 interface = <; 192.168.123.123 ; 3ffe:ffff:836f::fe86:a061
25822 .endd
25823 The first interface of the correct type (IPv4 or IPv6) is used for the outgoing
25824 connection. If none of them are the correct type, the option is ignored. If
25825 &%interface%& is not set, or is ignored, the system's IP functions choose which
25826 interface to use if the host has more than one.
25827
25828
25829 .option keepalive smtp boolean true
25830 .cindex "keepalive" "on outgoing connection"
25831 This option controls the setting of SO_KEEPALIVE on outgoing TCP/IP socket
25832 connections. When set, it causes the kernel to probe idle connections
25833 periodically, by sending packets with &"old"& sequence numbers. The other end
25834 of the connection should send a acknowledgment if the connection is still okay
25835 or a reset if the connection has been aborted. The reason for doing this is
25836 that it has the beneficial effect of freeing up certain types of connection
25837 that can get stuck when the remote host is disconnected without tidying up the
25838 TCP/IP call properly. The keepalive mechanism takes several hours to detect
25839 unreachable hosts.
25840
25841
25842 .option lmtp_ignore_quota smtp boolean false
25843 .cindex "LMTP" "ignoring quota errors"
25844 If this option is set true when the &%protocol%& option is set to &"lmtp"&, the
25845 string &`IGNOREQUOTA`& is added to RCPT commands, provided that the LMTP server
25846 has advertised support for IGNOREQUOTA in its response to the LHLO command.
25847
25848 .option max_rcpt smtp integer 100
25849 .cindex "RCPT" "maximum number of outgoing"
25850 This option limits the number of RCPT commands that are sent in a single
25851 SMTP message transaction. Each set of addresses is treated independently, and
25852 so can cause parallel connections to the same host if &%remote_max_parallel%&
25853 permits this. A value setting of zero disables the limit.
25854
25855
25856 .new
25857 .option message_linelength_limit smtp integer 998
25858 .cindex "line length" limit
25859 This option sets the maximum line length, in bytes, that the transport
25860 will send.  Any messages with lines exceeding the given value
25861 will fail and a failure-DSN ("bounce") message will if possible be returned
25862 to the sender.
25863 The default value is that defined by the SMTP standards.
25864
25865 It is generally wise to also check in the data ACL so that messages
25866 received via SMTP can be refused without producing a bounce.
25867 .wen
25868
25869
25870 .option multi_domain smtp boolean&!! true
25871 .vindex "&$domain$&"
25872 When this option is set, the &(smtp)& transport can handle a number of
25873 addresses containing a mixture of different domains provided they all resolve
25874 to the same list of hosts. Turning the option off restricts the transport to
25875 handling only one domain at a time. This is useful if you want to use
25876 &$domain$& in an expansion for the transport, because it is set only when there
25877 is a single domain involved in a remote delivery.
25878
25879 It is expanded per-address and can depend on any of
25880 &$address_data$&, &$domain_data$&, &$local_part_data$&,
25881 &$host$&, &$host_address$& and &$host_port$&.
25882
25883 .new
25884 If the connection is DANE-enabled then this option is ignored;
25885 only messages having the domain used for the DANE TLSA lookup are
25886 sent on the connection.
25887 .wen
25888
25889 .option port smtp string&!! "see below"
25890 .cindex "port" "sending TCP/IP"
25891 .cindex "TCP/IP" "setting outgoing port"
25892 This option specifies the TCP/IP port on the server to which Exim connects.
25893 &*Note:*& Do not confuse this with the port that was used when a message was
25894 received, which is in &$received_port$&, formerly known as &$interface_port$&.
25895 The name was changed to minimize confusion with the outgoing port. There is no
25896 variable that contains an outgoing port.
25897
25898 If the value of this option begins with a digit it is taken as a port number;
25899 otherwise it is looked up using &[getservbyname()]&. The default value is
25900 normally &"smtp"&,
25901 but if &%protocol%& is set to &"lmtp"& the default is &"lmtp"&
25902 and if &%protocol%& is set to &"smtps"& the default is &"smtps"&.
25903 If the expansion fails, or if a port number cannot be found, delivery
25904 is deferred.
25905
25906 Note that at least one Linux distribution has been seen failing
25907 to put &"smtps"& in its &"/etc/services"& file, resulting is such deferrals.
25908
25909
25910
25911 .option protocol smtp string smtp
25912 .cindex "LMTP" "over TCP/IP"
25913 .cindex "ssmtp protocol" "outbound"
25914 .cindex "TLS" "SSL-on-connect outbound"
25915 .vindex "&$port$&"
25916 If this option is set to &"lmtp"& instead of &"smtp"&, the default value for
25917 the &%port%& option changes to &"lmtp"&, and the transport operates the LMTP
25918 protocol (RFC 2033) instead of SMTP. This protocol is sometimes used for local
25919 deliveries into closed message stores. Exim also has support for running LMTP
25920 over a pipe to a local process &-- see chapter &<<CHAPLMTP>>&.
25921
25922 If this option is set to &"smtps"&, the default value for the &%port%& option
25923 changes to &"smtps"&, and the transport initiates TLS immediately after
25924 connecting, as an outbound SSL-on-connect, instead of using STARTTLS to upgrade.
25925 The Internet standards bodies used to strongly discourage use of this mode,
25926 but as of RFC 8314 it is preferred over STARTTLS for message submission
25927 (as distinct from MTA-MTA communication).
25928
25929
25930 .option retry_include_ip_address smtp boolean&!! true
25931 Exim normally includes both the host name and the IP address in the key it
25932 constructs for indexing retry data after a temporary delivery failure. This
25933 means that when one of several IP addresses for a host is failing, it gets
25934 tried periodically (controlled by the retry rules), but use of the other IP
25935 addresses is not affected.
25936
25937 However, in some dialup environments hosts are assigned a different IP address
25938 each time they connect. In this situation the use of the IP address as part of
25939 the retry key leads to undesirable behaviour. Setting this option false causes
25940 Exim to use only the host name.
25941 Since it is expanded it can be made to depend on the host or domain.
25942
25943
25944 .option serialize_hosts smtp "host list&!!" unset
25945 .cindex "serializing connections"
25946 .cindex "host" "serializing connections"
25947 Because Exim operates in a distributed manner, if several messages for the same
25948 host arrive at around the same time, more than one simultaneous connection to
25949 the remote host can occur. This is not usually a problem except when there is a
25950 slow link between the hosts. In that situation it may be helpful to restrict
25951 Exim to one connection at a time. This can be done by setting
25952 &%serialize_hosts%& to match the relevant hosts.
25953
25954 .cindex "hints database" "serializing deliveries to a host"
25955 Exim implements serialization by means of a hints database in which a record is
25956 written whenever a process connects to one of the restricted hosts. The record
25957 is deleted when the connection is completed. Obviously there is scope for
25958 records to get left lying around if there is a system or program crash. To
25959 guard against this, Exim ignores any records that are more than six hours old.
25960
25961 If you set up this kind of serialization, you should also arrange to delete the
25962 relevant hints database whenever your system reboots. The names of the files
25963 start with &_misc_& and they are kept in the &_spool/db_& directory. There
25964 may be one or two files, depending on the type of DBM in use. The same files
25965 are used for ETRN serialization.
25966
25967 See also the &%max_parallel%& generic transport option.
25968
25969
25970 .option size_addition smtp integer 1024
25971 .cindex "SIZE" "ESMTP extension"
25972 .cindex "message" "size issue for transport filter"
25973 .cindex "size" "of message"
25974 .cindex "transport" "filter"
25975 .cindex "filter" "transport filter"
25976 If a remote SMTP server indicates that it supports the SIZE option of the
25977 MAIL command, Exim uses this to pass over the message size at the start of
25978 an SMTP transaction. It adds the value of &%size_addition%& to the value it
25979 sends, to allow for headers and other text that may be added during delivery by
25980 configuration options or in a transport filter. It may be necessary to increase
25981 this if a lot of text is added to messages.
25982
25983 Alternatively, if the value of &%size_addition%& is set negative, it disables
25984 the use of the SIZE option altogether.
25985
25986
25987 .option socks_proxy smtp string&!! unset
25988 .cindex proxy SOCKS
25989 This option enables use of SOCKS proxies for connections made by the
25990 transport.  For details see section &<<SECTproxySOCKS>>&.
25991
25992
25993 .new
25994 .option tls_alpn smtp string&!! unset
25995 .cindex TLS "Application Layer Protocol Names"
25996 .cindex TLS ALPN
25997 .cindex ALPN "set name in client"
25998 If this option is set
25999 and the TLS library supports ALPN,
26000 the value given is used.
26001
26002 As of writing no value has been standardised for email use.
26003 The authors suggest using &"smtp"&.
26004 .wen
26005
26006
26007
26008 .option tls_certificate smtp string&!! unset
26009 .cindex "TLS" "client certificate, location of"
26010 .cindex "certificate" "client, location of"
26011 .vindex "&$host$&"
26012 .vindex "&$host_address$&"
26013 The value of this option must be the absolute path to a file which contains the
26014 client's certificate, for possible use when sending a message over an encrypted
26015 connection. The values of &$host$& and &$host_address$& are set to the name and
26016 address of the server during the expansion. See chapter &<<CHAPTLS>>& for
26017 details of TLS.
26018
26019 &*Note*&: This option must be set if you want Exim to be able to use a TLS
26020 certificate when sending messages as a client. The global option of the same
26021 name specifies the certificate for Exim as a server; it is not automatically
26022 assumed that the same certificate should be used when Exim is operating as a
26023 client.
26024
26025
26026 .option tls_crl smtp string&!! unset
26027 .cindex "TLS" "client certificate revocation list"
26028 .cindex "certificate" "revocation list for client"
26029 This option specifies a certificate revocation list. The expanded value must
26030 be the name of a file that contains a CRL in PEM format.
26031
26032
26033 .option tls_dh_min_bits smtp integer 1024
26034 .cindex "TLS" "Diffie-Hellman minimum acceptable size"
26035 When establishing a TLS session, if a ciphersuite which uses Diffie-Hellman
26036 key agreement is negotiated, the server will provide a large prime number
26037 for use.  This option establishes the minimum acceptable size of that number.
26038 If the parameter offered by the server is too small, then the TLS handshake
26039 will fail.
26040
26041 Only supported when using GnuTLS.
26042
26043
26044 .option tls_privatekey smtp string&!! unset
26045 .cindex "TLS" "client private key, location of"
26046 .vindex "&$host$&"
26047 .vindex "&$host_address$&"
26048 The value of this option must be the absolute path to a file which contains the
26049 client's private key. This is used when sending a message over an encrypted
26050 connection using a client certificate. The values of &$host$& and
26051 &$host_address$& are set to the name and address of the server during the
26052 expansion. If this option is unset, or the expansion is forced to fail, or the
26053 result is an empty string, the private key is assumed to be in the same file as
26054 the certificate. See chapter &<<CHAPTLS>>& for details of TLS.
26055
26056
26057 .option tls_require_ciphers smtp string&!! unset
26058 .cindex "TLS" "requiring specific ciphers"
26059 .cindex "cipher" "requiring specific"
26060 .vindex "&$host$&"
26061 .vindex "&$host_address$&"
26062 The value of this option must be a list of permitted cipher suites, for use
26063 when setting up an outgoing encrypted connection. (There is a global option of
26064 the same name for controlling incoming connections.) The values of &$host$& and
26065 &$host_address$& are set to the name and address of the server during the
26066 expansion. See chapter &<<CHAPTLS>>& for details of TLS; note that this option
26067 is used in different ways by OpenSSL and GnuTLS (see sections
26068 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&). For GnuTLS, the order of the
26069 ciphers is a preference order.
26070
26071
26072 .new
26073 .option tls_resumption_hosts smtp "host list&!!" unset
26074 .cindex TLS resumption
26075 This option controls which connections to use the TLS resumption feature.
26076 See &<<SECTresumption>>& for details.
26077 .wen
26078
26079
26080
26081 .option tls_sni smtp string&!! unset
26082 .cindex "TLS" "Server Name Indication"
26083 .cindex "TLS" SNI
26084 .cindex SNI "setting in client"
26085 .vindex "&$tls_sni$&"
26086 If this option is set
26087 .new
26088 and the connection is not DANE-validated
26089 .wen
26090 then it sets the $tls_out_sni variable and causes any
26091 TLS session to pass this value as the Server Name Indication extension to
26092 the remote side, which can be used by the remote side to select an appropriate
26093 certificate and private key for the session.
26094
26095 See &<<SECTtlssni>>& for more information.
26096
26097 Note that for OpenSSL, this feature requires a build of OpenSSL that supports
26098 TLS extensions.
26099
26100
26101
26102
26103 .option tls_tempfail_tryclear smtp boolean true
26104 .cindex "4&'xx'& responses" "to STARTTLS"
26105 When the server host is not in &%hosts_require_tls%&, and there is a problem in
26106 setting up a TLS session, this option determines whether or not Exim should try
26107 to deliver the message unencrypted. If it is set false, delivery to the
26108 current host is deferred; if there are other hosts, they are tried. If this
26109 option is set true, Exim attempts to deliver unencrypted after a 4&'xx'&
26110 response to STARTTLS. Also, if STARTTLS is accepted, but the subsequent
26111 TLS negotiation fails, Exim closes the current connection (because it is in an
26112 unknown state), opens a new one to the same host, and then tries the delivery
26113 in clear.
26114
26115
26116 .option tls_try_verify_hosts smtp "host list&!!" *
26117 .cindex "TLS" "server certificate verification"
26118 .cindex "certificate" "verification of server"
26119 This option gives a list of hosts for which, on encrypted connections,
26120 certificate verification will be tried but need not succeed.
26121 The &%tls_verify_certificates%& option must also be set.
26122 Note that unless the host is in this list
26123 TLS connections will be denied to hosts using self-signed certificates
26124 when &%tls_verify_certificates%& is matched.
26125 The &$tls_out_certificate_verified$& variable is set when
26126 certificate verification succeeds.
26127
26128
26129 .option tls_verify_cert_hostnames smtp "host list&!!" *
26130 .cindex "TLS" "server certificate hostname verification"
26131 .cindex "certificate" "verification of server"
26132 This option give a list of hosts for which,
26133 while verifying the server certificate,
26134 checks will be included on the host name
26135 (note that this will generally be the result of a DNS MX lookup)
26136 versus Subject and Subject-Alternate-Name fields.  Wildcard names are permitted
26137 limited to being the initial component of a 3-or-more component FQDN.
26138
26139 There is no equivalent checking on client certificates.
26140
26141
26142 .option tls_verify_certificates smtp string&!! system
26143 .cindex "TLS" "server certificate verification"
26144 .cindex "certificate" "verification of server"
26145 .vindex "&$host$&"
26146 .vindex "&$host_address$&"
26147 The value of this option must be either the
26148 word "system"
26149 or the absolute path to
26150 a file or directory containing permitted certificates for servers,
26151 for use when setting up an encrypted connection.
26152
26153 The "system" value for the option will use a location compiled into the SSL library.
26154 This is not available for GnuTLS versions preceding 3.0.20; a value of "system"
26155 is taken as empty and an explicit location
26156 must be specified.
26157
26158 The use of a directory for the option value is not available for GnuTLS versions
26159 preceding 3.3.6 and a single file must be used.
26160
26161 With OpenSSL the certificates specified
26162 explicitly
26163 either by file or directory
26164 are added to those given by the system default location.
26165
26166 The values of &$host$& and
26167 &$host_address$& are set to the name and address of the server during the
26168 expansion of this option. See chapter &<<CHAPTLS>>& for details of TLS.
26169
26170 For back-compatibility,
26171 if neither tls_verify_hosts nor tls_try_verify_hosts are set
26172 (a single-colon empty list counts as being set)
26173 and certificate verification fails the TLS connection is closed.
26174
26175
26176 .option tls_verify_hosts smtp "host list&!!" unset
26177 .cindex "TLS" "server certificate verification"
26178 .cindex "certificate" "verification of server"
26179 This option gives a list of hosts for which, on encrypted connections,
26180 certificate verification must succeed.
26181 The &%tls_verify_certificates%& option must also be set.
26182 If both this option and &%tls_try_verify_hosts%& are unset
26183 operation is as if this option selected all hosts.
26184
26185 .option utf8_downconvert smtp integer&!! -1
26186 .cindex utf8 "address downconversion"
26187 .cindex i18n "utf8 address downconversion"
26188 If built with internationalization support,
26189 this option controls conversion of UTF-8 in message envelope addresses
26190 to a-label form.
26191 If, after expansion, the value is 1, 0, or -1 then this value overrides
26192 any value previously set for the message.  Otherwise, any previously
26193 set value is used.  To permit use of a previous value,
26194 set this option to an empty string.
26195 For details on the values see section &<<SECTi18nMTA>>&.
26196
26197
26198
26199
26200 .section "How the limits for the number of hosts to try are used" &&&
26201          "SECTvalhosmax"
26202 .cindex "host" "maximum number to try"
26203 .cindex "limit" "hosts; maximum number tried"
26204 There are two options that are concerned with the number of hosts that are
26205 tried when an SMTP delivery takes place. They are &%hosts_max_try%& and
26206 &%hosts_max_try_hardlimit%&.
26207
26208
26209 The &%hosts_max_try%& option limits the number of hosts that are tried
26210 for a single delivery. However, despite the term &"host"& in its name, the
26211 option actually applies to each IP address independently. In other words, a
26212 multihomed host is treated as several independent hosts, just as it is for
26213 retrying.
26214
26215 Many of the larger ISPs have multiple MX records which often point to
26216 multihomed hosts. As a result, a list of a dozen or more IP addresses may be
26217 created as a result of routing one of these domains.
26218
26219 Trying every single IP address on such a long list does not seem sensible; if
26220 several at the top of the list fail, it is reasonable to assume there is some
26221 problem that is likely to affect all of them. Roughly speaking, the value of
26222 &%hosts_max_try%& is the maximum number that are tried before deferring the
26223 delivery. However, the logic cannot be quite that simple.
26224
26225 Firstly, IP addresses that are skipped because their retry times have not
26226 arrived do not count, and in addition, addresses that are past their retry
26227 limits are also not counted, even when they are tried. This means that when
26228 some IP addresses are past their retry limits, more than the value of
26229 &%hosts_max_retry%& may be tried. The reason for this behaviour is to ensure
26230 that all IP addresses are considered before timing out an email address (but
26231 see below for an exception).
26232
26233 Secondly, when the &%hosts_max_try%& limit is reached, Exim looks down the host
26234 list to see if there is a subsequent host with a different (higher valued) MX.
26235 If there is, that host is considered next, and the current IP address is used
26236 but not counted. This behaviour helps in the case of a domain with a retry rule
26237 that hardly ever delays any hosts, as is now explained:
26238
26239 Consider the case of a long list of hosts with one MX value, and a few with a
26240 higher MX value. If &%hosts_max_try%& is small (the default is 5) only a few
26241 hosts at the top of the list are tried at first. With the default retry rule,
26242 which specifies increasing retry times, the higher MX hosts are eventually
26243 tried when those at the top of the list are skipped because they have not
26244 reached their retry times.
26245
26246 However, it is common practice to put a fixed short retry time on domains for
26247 large ISPs, on the grounds that their servers are rarely down for very long.
26248 Unfortunately, these are exactly the domains that tend to resolve to long lists
26249 of hosts. The short retry time means that the lowest MX hosts are tried every
26250 time. The attempts may be in a different order because of random sorting, but
26251 without the special MX check, the higher MX hosts would never be tried until
26252 all the lower MX hosts had timed out (which might be several days), because
26253 there are always some lower MX hosts that have reached their retry times. With
26254 the special check, Exim considers at least one IP address from each MX value at
26255 every delivery attempt, even if the &%hosts_max_try%& limit has already been
26256 reached.
26257
26258 The above logic means that &%hosts_max_try%& is not a hard limit, and in
26259 particular, Exim normally eventually tries all the IP addresses before timing
26260 out an email address. When &%hosts_max_try%& was implemented, this seemed a
26261 reasonable thing to do. Recently, however, some lunatic DNS configurations have
26262 been set up with hundreds of IP addresses for some domains. It can
26263 take a very long time indeed for an address to time out in these cases.
26264
26265 The &%hosts_max_try_hardlimit%& option was added to help with this problem.
26266 Exim never tries more than this number of IP addresses; if it hits this limit
26267 and they are all timed out, the email address is bounced, even though not all
26268 possible IP addresses have been tried.
26269 .ecindex IIDsmttra1
26270 .ecindex IIDsmttra2
26271
26272
26273
26274
26275
26276 . ////////////////////////////////////////////////////////////////////////////
26277 . ////////////////////////////////////////////////////////////////////////////
26278
26279 .chapter "Address rewriting" "CHAPrewrite"
26280 .scindex IIDaddrew "rewriting" "addresses"
26281 There are some circumstances in which Exim automatically rewrites domains in
26282 addresses. The two most common are when an address is given without a domain
26283 (referred to as an &"unqualified address"&) or when an address contains an
26284 abbreviated domain that is expanded by DNS lookup.
26285
26286 Unqualified envelope addresses are accepted only for locally submitted
26287 messages, or for messages that are received from hosts matching
26288 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
26289 appropriate. Unqualified addresses in header lines are qualified if they are in
26290 locally submitted messages, or messages from hosts that are permitted to send
26291 unqualified envelope addresses. Otherwise, unqualified addresses in header
26292 lines are neither qualified nor rewritten.
26293
26294 One situation in which Exim does &'not'& automatically rewrite a domain is
26295 when it is the name of a CNAME record in the DNS. The older RFCs suggest that
26296 such a domain should be rewritten using the &"canonical"& name, and some MTAs
26297 do this. The new RFCs do not contain this suggestion.
26298
26299
26300 .section "Explicitly configured address rewriting" "SECID147"
26301 This chapter describes the rewriting rules that can be used in the
26302 main rewrite section of the configuration file, and also in the generic
26303 &%headers_rewrite%& option that can be set on any transport.
26304
26305 Some people believe that configured address rewriting is a Mortal Sin.
26306 Others believe that life is not possible without it. Exim provides the
26307 facility; you do not have to use it.
26308
26309 The main rewriting rules that appear in the &"rewrite"& section of the
26310 configuration file are applied to addresses in incoming messages, both envelope
26311 addresses and addresses in header lines. Each rule specifies the types of
26312 address to which it applies.
26313
26314 Whether or not addresses in header lines are rewritten depends on the origin of
26315 the headers and the type of rewriting. Global rewriting, that is, rewriting
26316 rules from the rewrite section of the configuration file, is applied only to
26317 those headers that were received with the message. Header lines that are added
26318 by ACLs or by a system filter or by individual routers or transports (which
26319 are specific to individual recipient addresses) are not rewritten by the global
26320 rules.
26321
26322 Rewriting at transport time, by means of the &%headers_rewrite%& option,
26323 applies all headers except those added by routers and transports. That is, as
26324 well as the headers that were received with the message, it also applies to
26325 headers that were added by an ACL or a system filter.
26326
26327
26328 In general, rewriting addresses from your own system or domain has some
26329 legitimacy. Rewriting other addresses should be done only with great care and
26330 in special circumstances. The author of Exim believes that rewriting should be
26331 used sparingly, and mainly for &"regularizing"& addresses in your own domains.
26332 Although it can sometimes be used as a routing tool, this is very strongly
26333 discouraged.
26334
26335 There are two commonly encountered circumstances where rewriting is used, as
26336 illustrated by these examples:
26337
26338 .ilist
26339 The company whose domain is &'hitch.fict.example'& has a number of hosts that
26340 exchange mail with each other behind a firewall, but there is only a single
26341 gateway to the outer world. The gateway rewrites &'*.hitch.fict.example'& as
26342 &'hitch.fict.example'& when sending mail off-site.
26343 .next
26344 A host rewrites the local parts of its own users so that, for example,
26345 &'fp42@hitch.fict.example'& becomes &'Ford.Prefect@hitch.fict.example'&.
26346 .endlist
26347
26348
26349
26350 .section "When does rewriting happen?" "SECID148"
26351 .cindex "rewriting" "timing of"
26352 .cindex "&ACL;" "rewriting addresses in"
26353 Configured address rewriting can take place at several different stages of a
26354 message's processing.
26355
26356 .vindex "&$sender_address$&"
26357 At the start of an ACL for MAIL, the sender address may have been rewritten
26358 by a special SMTP-time rewrite rule (see section &<<SECTrewriteS>>&), but no
26359 ordinary rewrite rules have yet been applied. If, however, the sender address
26360 is verified in the ACL, it is rewritten before verification, and remains
26361 rewritten thereafter. The subsequent value of &$sender_address$& is the
26362 rewritten address. This also applies if sender verification happens in a
26363 RCPT ACL. Otherwise, when the sender address is not verified, it is
26364 rewritten as soon as a message's header lines have been received.
26365
26366 .vindex "&$domain$&"
26367 .vindex "&$local_part$&"
26368 Similarly, at the start of an ACL for RCPT, the current recipient's address
26369 may have been rewritten by a special SMTP-time rewrite rule, but no ordinary
26370 rewrite rules have yet been applied to it. However, the behaviour is different
26371 from the sender address when a recipient is verified. The address is rewritten
26372 for the verification, but the rewriting is not remembered at this stage. The
26373 value of &$local_part$& and &$domain$& after verification are always the same
26374 as they were before (that is, they contain the unrewritten &-- except for
26375 SMTP-time rewriting &-- address).
26376
26377 As soon as a message's header lines have been received, all the envelope
26378 recipient addresses are permanently rewritten, and rewriting is also applied to
26379 the addresses in the header lines (if configured). This happens before adding
26380 any header lines that were specified in MAIL or RCPT ACLs, and
26381 .cindex "&[local_scan()]& function" "address rewriting; timing of"
26382 before the DATA ACL and &[local_scan()]& functions are run.
26383
26384 When an address is being routed, either for delivery or for verification,
26385 rewriting is applied immediately to child addresses that are generated by
26386 redirection, unless &%no_rewrite%& is set on the router.
26387
26388 .cindex "envelope from"
26389 .cindex "envelope sender" "rewriting at transport time"
26390 .cindex "rewriting" "at transport time"
26391 .cindex "header lines" "rewriting at transport time"
26392 At transport time, additional rewriting of addresses in header lines can be
26393 specified by setting the generic &%headers_rewrite%& option on a transport.
26394 This option contains rules that are identical in form to those in the rewrite
26395 section of the configuration file. They are applied to the original message
26396 header lines and any that were added by ACLs or a system filter. They are not
26397 applied to header lines that are added by routers or the transport.
26398
26399 The outgoing envelope sender can be rewritten by means of the &%return_path%&
26400 transport option. However, it is not possible to rewrite envelope recipients at
26401 transport time.
26402
26403
26404
26405
26406 .section "Testing the rewriting rules that apply on input" "SECID149"
26407 .cindex "rewriting" "testing"
26408 .cindex "testing" "rewriting"
26409 Exim's input rewriting configuration appears in a part of the runtime
26410 configuration file headed by &"begin rewrite"&. It can be tested by the
26411 &%-brw%& command line option. This takes an address (which can be a full RFC
26412 2822 address) as its argument. The output is a list of how the address would be
26413 transformed by the rewriting rules for each of the different places it might
26414 appear in an incoming message, that is, for each different header and for the
26415 envelope sender and recipient fields. For example,
26416 .code
26417 exim -brw ph10@exim.workshop.example
26418 .endd
26419 might produce the output
26420 .code
26421 sender: Philip.Hazel@exim.workshop.example
26422 from: Philip.Hazel@exim.workshop.example
26423 to: ph10@exim.workshop.example
26424 cc: ph10@exim.workshop.example
26425 bcc: ph10@exim.workshop.example
26426 reply-to: Philip.Hazel@exim.workshop.example
26427 env-from: Philip.Hazel@exim.workshop.example
26428 env-to: ph10@exim.workshop.example
26429 .endd
26430 which shows that rewriting has been set up for that address when used in any of
26431 the source fields, but not when it appears as a recipient address. At the
26432 present time, there is no equivalent way of testing rewriting rules that are
26433 set for a particular transport.
26434
26435
26436 .section "Rewriting rules" "SECID150"
26437 .cindex "rewriting" "rules"
26438 The rewrite section of the configuration file consists of lines of rewriting
26439 rules in the form
26440 .display
26441 <&'source pattern'&>  <&'replacement'&>  <&'flags'&>
26442 .endd
26443 Rewriting rules that are specified for the &%headers_rewrite%& generic
26444 transport option are given as a colon-separated list. Each item in the list
26445 takes the same form as a line in the main rewriting configuration (except that
26446 any colons must be doubled, of course).
26447
26448 The formats of source patterns and replacement strings are described below.
26449 Each is terminated by white space, unless enclosed in double quotes, in which
26450 case normal quoting conventions apply inside the quotes. The flags are single
26451 characters which may appear in any order. Spaces and tabs between them are
26452 ignored.
26453
26454 For each address that could potentially be rewritten, the rules are scanned in
26455 order, and replacements for the address from earlier rules can themselves be
26456 replaced by later rules (but see the &"q"& and &"R"& flags).
26457
26458 The order in which addresses are rewritten is undefined, may change between
26459 releases, and must not be relied on, with one exception: when a message is
26460 received, the envelope sender is always rewritten first, before any header
26461 lines are rewritten. For example, the replacement string for a rewrite of an
26462 address in &'To:'& must not assume that the message's address in &'From:'& has
26463 (or has not) already been rewritten. However, a rewrite of &'From:'& may assume
26464 that the envelope sender has already been rewritten.
26465
26466 .vindex "&$domain$&"
26467 .vindex "&$local_part$&"
26468 The variables &$local_part$& and &$domain$& can be used in the replacement
26469 string to refer to the address that is being rewritten. Note that lookup-driven
26470 rewriting can be done by a rule of the form
26471 .code
26472 *@*   ${lookup ...
26473 .endd
26474 where the lookup key uses &$1$& and &$2$& or &$local_part$& and &$domain$& to
26475 refer to the address that is being rewritten.
26476
26477
26478 .section "Rewriting patterns" "SECID151"
26479 .cindex "rewriting" "patterns"
26480 .cindex "address list" "in a rewriting pattern"
26481 The source pattern in a rewriting rule is any item which may appear in an
26482 address list (see section &<<SECTaddresslist>>&). It is in fact processed as a
26483 single-item address list, which means that it is expanded before being tested
26484 against the address. As always, if you use a regular expression as a pattern,
26485 you must take care to escape dollar and backslash characters, or use the &`\N`&
26486 facility to suppress string expansion within the regular expression.
26487
26488 Domains in patterns should be given in lower case. Local parts in patterns are
26489 case-sensitive. If you want to do case-insensitive matching of local parts, you
26490 can use a regular expression that starts with &`^(?i)`&.
26491
26492 .cindex "numerical variables (&$1$& &$2$& etc)" "in rewriting rules"
26493 After matching, the numerical variables &$1$&, &$2$&, etc. may be set,
26494 depending on the type of match which occurred. These can be used in the
26495 replacement string to insert portions of the incoming address. &$0$& always
26496 refers to the complete incoming address. When a regular expression is used, the
26497 numerical variables are set from its capturing subexpressions. For other types
26498 of pattern they are set as follows:
26499
26500 .ilist
26501 If a local part or domain starts with an asterisk, the numerical variables
26502 refer to the character strings matched by asterisks, with &$1$& associated with
26503 the first asterisk, and &$2$& with the second, if present. For example, if the
26504 pattern
26505 .code
26506 *queen@*.fict.example
26507 .endd
26508 is matched against the address &'hearts-queen@wonderland.fict.example'& then
26509 .code
26510 $0 = hearts-queen@wonderland.fict.example
26511 $1 = hearts-
26512 $2 = wonderland
26513 .endd
26514 Note that if the local part does not start with an asterisk, but the domain
26515 does, it is &$1$& that contains the wild part of the domain.
26516
26517 .next
26518 If the domain part of the pattern is a partial lookup, the wild and fixed parts
26519 of the domain are placed in the next available numerical variables. Suppose,
26520 for example, that the address &'foo@bar.baz.example'& is processed by a
26521 rewriting rule of the form
26522 .display
26523 &`*@partial-dbm;/some/dbm/file`&    <&'replacement string'&>
26524 .endd
26525 and the key in the file that matches the domain is &`*.baz.example`&. Then
26526 .code
26527 $1 = foo
26528 $2 = bar
26529 $3 = baz.example
26530 .endd
26531 If the address &'foo@baz.example'& is looked up, this matches the same
26532 wildcard file entry, and in this case &$2$& is set to the empty string, but
26533 &$3$& is still set to &'baz.example'&. If a non-wild key is matched in a
26534 partial lookup, &$2$& is again set to the empty string and &$3$& is set to the
26535 whole domain. For non-partial domain lookups, no numerical variables are set.
26536 .endlist
26537
26538
26539 .section "Rewriting replacements" "SECID152"
26540 .cindex "rewriting" "replacements"
26541 If the replacement string for a rule is a single asterisk, addresses that
26542 match the pattern and the flags are &'not'& rewritten, and no subsequent
26543 rewriting rules are scanned. For example,
26544 .code
26545 hatta@lookingglass.fict.example  *  f
26546 .endd
26547 specifies that &'hatta@lookingglass.fict.example'& is never to be rewritten in
26548 &'From:'& headers.
26549
26550 .vindex "&$domain$&"
26551 .vindex "&$local_part$&"
26552 If the replacement string is not a single asterisk, it is expanded, and must
26553 yield a fully qualified address. Within the expansion, the variables
26554 &$local_part$& and &$domain$& refer to the address that is being rewritten.
26555 Any letters they contain retain their original case &-- they are not lower
26556 cased. The numerical variables are set up according to the type of pattern that
26557 matched the address, as described above. If the expansion is forced to fail by
26558 the presence of &"fail"& in a conditional or lookup item, rewriting by the
26559 current rule is abandoned, but subsequent rules may take effect. Any other
26560 expansion failure causes the entire rewriting operation to be abandoned, and an
26561 entry written to the panic log.
26562
26563
26564
26565 .section "Rewriting flags" "SECID153"
26566 There are three different kinds of flag that may appear on rewriting rules:
26567
26568 .ilist
26569 Flags that specify which headers and envelope addresses to rewrite: E, F, T, b,
26570 c, f, h, r, s, t.
26571 .next
26572 A flag that specifies rewriting at SMTP time: S.
26573 .next
26574 Flags that control the rewriting process: Q, q, R, w.
26575 .endlist
26576
26577 For rules that are part of the &%headers_rewrite%& generic transport option,
26578 E, F, T, and S are not permitted.
26579
26580
26581
26582 .section "Flags specifying which headers and envelope addresses to rewrite" &&&
26583          "SECID154"
26584 .cindex "rewriting" "flags"
26585 If none of the following flag letters, nor the &"S"& flag (see section
26586 &<<SECTrewriteS>>&) are present, a main rewriting rule applies to all headers
26587 and to both the sender and recipient fields of the envelope, whereas a
26588 transport-time rewriting rule just applies to all headers. Otherwise, the
26589 rewriting rule is skipped unless the relevant addresses are being processed.
26590 .display
26591 &`E`&       rewrite all envelope fields
26592 &`F`&       rewrite the envelope From field
26593 &`T`&       rewrite the envelope To field
26594 &`b`&       rewrite the &'Bcc:'& header
26595 &`c`&       rewrite the &'Cc:'& header
26596 &`f`&       rewrite the &'From:'& header
26597 &`h`&       rewrite all headers
26598 &`r`&       rewrite the &'Reply-To:'& header
26599 &`s`&       rewrite the &'Sender:'& header
26600 &`t`&       rewrite the &'To:'& header
26601 .endd
26602 "All headers" means all of the headers listed above that can be selected
26603 individually, plus their &'Resent-'& versions. It does not include
26604 other headers such as &'Subject:'& etc.
26605
26606 You should be particularly careful about rewriting &'Sender:'& headers, and
26607 restrict this to special known cases in your own domains.
26608
26609
26610 .section "The SMTP-time rewriting flag" "SECTrewriteS"
26611 .cindex "SMTP" "rewriting malformed addresses"
26612 .cindex "RCPT" "rewriting argument of"
26613 .cindex "MAIL" "rewriting argument of"
26614 The rewrite flag &"S"& specifies a rewrite of incoming envelope addresses at
26615 SMTP time, as soon as an address is received in a MAIL or RCPT command, and
26616 before any other processing; even before syntax checking. The pattern is
26617 required to be a regular expression, and it is matched against the whole of the
26618 data for the command, including any surrounding angle brackets.
26619
26620 .vindex "&$domain$&"
26621 .vindex "&$local_part$&"
26622 This form of rewrite rule allows for the handling of addresses that are not
26623 compliant with RFCs 2821 and 2822 (for example, &"bang paths"& in batched SMTP
26624 input). Because the input is not required to be a syntactically valid address,
26625 the variables &$local_part$& and &$domain$& are not available during the
26626 expansion of the replacement string. The result of rewriting replaces the
26627 original address in the MAIL or RCPT command.
26628
26629
26630 .section "Flags controlling the rewriting process" "SECID155"
26631 There are four flags which control the way the rewriting process works. These
26632 take effect only when a rule is invoked, that is, when the address is of the
26633 correct type (matches the flags) and matches the pattern:
26634
26635 .ilist
26636 If the &"Q"& flag is set on a rule, the rewritten address is permitted to be an
26637 unqualified local part. It is qualified with &%qualify_recipient%&. In the
26638 absence of &"Q"& the rewritten address must always include a domain.
26639 .next
26640 If the &"q"& flag is set on a rule, no further rewriting rules are considered,
26641 even if no rewriting actually takes place because of a &"fail"& in the
26642 expansion. The &"q"& flag is not effective if the address is of the wrong type
26643 (does not match the flags) or does not match the pattern.
26644 .next
26645 The &"R"& flag causes a successful rewriting rule to be re-applied to the new
26646 address, up to ten times. It can be combined with the &"q"& flag, to stop
26647 rewriting once it fails to match (after at least one successful rewrite).
26648 .next
26649 .cindex "rewriting" "whole addresses"
26650 When an address in a header is rewritten, the rewriting normally applies only
26651 to the working part of the address, with any comments and RFC 2822 &"phrase"&
26652 left unchanged. For example, rewriting might change
26653 .code
26654 From: Ford Prefect <fp42@restaurant.hitch.fict.example>
26655 .endd
26656 into
26657 .code
26658 From: Ford Prefect <prefectf@hitch.fict.example>
26659 .endd
26660 .cindex "RFC 2047"
26661 Sometimes there is a need to replace the whole address item, and this can be
26662 done by adding the flag letter &"w"& to a rule. If this is set on a rule that
26663 causes an address in a header line to be rewritten, the entire address is
26664 replaced, not just the working part. The replacement must be a complete RFC
26665 2822 address, including the angle brackets if necessary. If text outside angle
26666 brackets contains a character whose value is greater than 126 or less than 32
26667 (except for tab), the text is encoded according to RFC 2047. The character set
26668 is taken from &%headers_charset%&, which gets its default at build time.
26669
26670 When the &"w"& flag is set on a rule that causes an envelope address to be
26671 rewritten, all but the working part of the replacement address is discarded.
26672 .endlist
26673
26674
26675 .section "Rewriting examples" "SECID156"
26676 Here is an example of the two common rewriting paradigms:
26677 .code
26678 *@*.hitch.fict.example  $1@hitch.fict.example
26679 *@hitch.fict.example    ${lookup{$1}dbm{/etc/realnames}\
26680                      {$value}fail}@hitch.fict.example bctfrF
26681 .endd
26682 Note the use of &"fail"& in the lookup expansion in the second rule, forcing
26683 the string expansion to fail if the lookup does not succeed. In this context it
26684 has the effect of leaving the original address unchanged, but Exim goes on to
26685 consider subsequent rewriting rules, if any, because the &"q"& flag is not
26686 present in that rule. An alternative to &"fail"& would be to supply &$1$&
26687 explicitly, which would cause the rewritten address to be the same as before,
26688 at the cost of a small bit of processing. Not supplying either of these is an
26689 error, since the rewritten address would then contain no local part.
26690
26691 The first example above replaces the domain with a superior, more general
26692 domain. This may not be desirable for certain local parts. If the rule
26693 .code
26694 root@*.hitch.fict.example  *
26695 .endd
26696 were inserted before the first rule, rewriting would be suppressed for the
26697 local part &'root'& at any domain ending in &'hitch.fict.example'&.
26698
26699 Rewriting can be made conditional on a number of tests, by making use of
26700 &${if$& in the expansion item. For example, to apply a rewriting rule only to
26701 messages that originate outside the local host:
26702 .code
26703 *@*.hitch.fict.example  "${if !eq {$sender_host_address}{}\
26704                          {$1@hitch.fict.example}fail}"
26705 .endd
26706 The replacement string is quoted in this example because it contains white
26707 space.
26708
26709 .cindex "rewriting" "bang paths"
26710 .cindex "bang paths" "rewriting"
26711 Exim does not handle addresses in the form of &"bang paths"&. If it sees such
26712 an address it treats it as an unqualified local part which it qualifies with
26713 the local qualification domain (if the source of the message is local or if the
26714 remote host is permitted to send unqualified addresses). Rewriting can
26715 sometimes be used to handle simple bang paths with a fixed number of
26716 components. For example, the rule
26717 .code
26718 \N^([^!]+)!(.*)@your.domain.example$\N   $2@$1
26719 .endd
26720 rewrites a two-component bang path &'host.name!user'& as the domain address
26721 &'user@host.name'&. However, there is a security implication in using this as
26722 a global rewriting rule for envelope addresses. It can provide a backdoor
26723 method for using your system as a relay, because the incoming addresses appear
26724 to be local. If the bang path addresses are received via SMTP, it is safer to
26725 use the &"S"& flag to rewrite them as they are received, so that relay checking
26726 can be done on the rewritten addresses.
26727 .ecindex IIDaddrew
26728
26729
26730
26731
26732
26733 . ////////////////////////////////////////////////////////////////////////////
26734 . ////////////////////////////////////////////////////////////////////////////
26735
26736 .chapter "Retry configuration" "CHAPretry"
26737 .scindex IIDretconf1 "retry" "configuration, description of"
26738 .scindex IIDregconf2 "configuration file" "retry section"
26739 The &"retry"& section of the runtime configuration file contains a list of
26740 retry rules that control how often Exim tries to deliver messages that cannot
26741 be delivered at the first attempt. If there are no retry rules (the section is
26742 empty or not present), there are no retries. In this situation, temporary
26743 errors are treated as permanent. The default configuration contains a single,
26744 general-purpose retry rule (see section &<<SECID57>>&). The &%-brt%& command
26745 line option can be used to test which retry rule will be used for a given
26746 address, domain and error.
26747
26748 The most common cause of retries is temporary failure to deliver to a remote
26749 host because the host is down, or inaccessible because of a network problem.
26750 Exim's retry processing in this case is applied on a per-host (strictly, per IP
26751 address) basis, not on a per-message basis. Thus, if one message has recently
26752 been delayed, delivery of a new message to the same host is not immediately
26753 tried, but waits for the host's retry time to arrive. If the &%retry_defer%&
26754 log selector is set, the message
26755 .cindex "retry" "time not reached"
26756 &"retry time not reached"& is written to the main log whenever a delivery is
26757 skipped for this reason. Section &<<SECToutSMTPerr>>& contains more details of
26758 the handling of errors during remote deliveries.
26759
26760 Retry processing applies to routing as well as to delivering, except as covered
26761 in the next paragraph. The retry rules do not distinguish between these
26762 actions. It is not possible, for example, to specify different behaviour for
26763 failures to route the domain &'snark.fict.example'& and failures to deliver to
26764 the host &'snark.fict.example'&. I didn't think anyone would ever need this
26765 added complication, so did not implement it. However, although they share the
26766 same retry rule, the actual retry times for routing and transporting a given
26767 domain are maintained independently.
26768
26769 When a delivery is not part of a queue run (typically an immediate delivery on
26770 receipt of a message), the routers are always run, and local deliveries are
26771 always attempted, even if retry times are set for them. This makes for better
26772 behaviour if one particular message is causing problems (for example, causing
26773 quota overflow, or provoking an error in a filter file). If such a delivery
26774 suffers a temporary failure, the retry data is updated as normal, and
26775 subsequent delivery attempts from queue runs occur only when the retry time for
26776 the local address is reached.
26777
26778 .section "Changing retry rules" "SECID157"
26779 If you change the retry rules in your configuration, you should consider
26780 whether or not to delete the retry data that is stored in Exim's spool area in
26781 files with names like &_db/retry_&. Deleting any of Exim's hints files is
26782 always safe; that is why they are called &"hints"&.
26783
26784 The hints retry data contains suggested retry times based on the previous
26785 rules. In the case of a long-running problem with a remote host, it might
26786 record the fact that the host has timed out. If your new rules increase the
26787 timeout time for such a host, you should definitely remove the old retry data
26788 and let Exim recreate it, based on the new rules. Otherwise Exim might bounce
26789 messages that it should now be retaining.
26790
26791
26792
26793 .section "Format of retry rules" "SECID158"
26794 .cindex "retry" "rules"
26795 Each retry rule occupies one line and consists of three or four parts,
26796 separated by white space: a pattern, an error name, an optional list of sender
26797 addresses, and a list of retry parameters. The pattern and sender lists must be
26798 enclosed in double quotes if they contain white space. The rules are searched
26799 in order until one is found where the pattern, error name, and sender list (if
26800 present) match the failing host or address, the error that occurred, and the
26801 message's sender, respectively.
26802
26803
26804 The pattern is any single item that may appear in an address list (see section
26805 &<<SECTaddresslist>>&). It is in fact processed as a one-item address list,
26806 which means that it is expanded before being tested against the address that
26807 has been delayed. A negated address list item is permitted. Address
26808 list processing treats a plain domain name as if it were preceded by &"*@"&,
26809 which makes it possible for many retry rules to start with just a domain. For
26810 example,
26811 .code
26812 lookingglass.fict.example        *  F,24h,30m;
26813 .endd
26814 provides a rule for any address in the &'lookingglass.fict.example'& domain,
26815 whereas
26816 .code
26817 alice@lookingglass.fict.example  *  F,24h,30m;
26818 .endd
26819 applies only to temporary failures involving the local part &%alice%&.
26820 In practice, almost all rules start with a domain name pattern without a local
26821 part.
26822
26823 .cindex "regular expressions" "in retry rules"
26824 &*Warning*&: If you use a regular expression in a retry rule pattern, it
26825 must match a complete address, not just a domain, because that is how regular
26826 expressions work in address lists.
26827 .display
26828 &`^\Nxyz\d+\.abc\.example$\N        *  G,1h,10m,2`&     &%Wrong%&
26829 &`^\N[^@]+@xyz\d+\.abc\.example$\N  *  G,1h,10m,2`&     &%Right%&
26830 .endd
26831
26832
26833 .section "Choosing which retry rule to use for address errors" "SECID159"
26834 When Exim is looking for a retry rule after a routing attempt has failed (for
26835 example, after a DNS timeout), each line in the retry configuration is tested
26836 against the complete address only if &%retry_use_local_part%& is set for the
26837 router. Otherwise, only the domain is used, except when matching against a
26838 regular expression, when the local part of the address is replaced with &"*"&.
26839 A domain on its own can match a domain pattern, or a pattern that starts with
26840 &"*@"&. By default, &%retry_use_local_part%& is true for routers where
26841 &%check_local_user%& is true, and false for other routers.
26842
26843 Similarly, when Exim is looking for a retry rule after a local delivery has
26844 failed (for example, after a mailbox full error), each line in the retry
26845 configuration is tested against the complete address only if
26846 &%retry_use_local_part%& is set for the transport (it defaults true for all
26847 local transports).
26848
26849 .cindex "4&'xx'& responses" "retry rules for"
26850 However, when Exim is looking for a retry rule after a remote delivery attempt
26851 suffers an address error (a 4&'xx'& SMTP response for a recipient address), the
26852 whole address is always used as the key when searching the retry rules. The
26853 rule that is found is used to create a retry time for the combination of the
26854 failing address and the message's sender. It is the combination of sender and
26855 recipient that is delayed in subsequent queue runs until its retry time is
26856 reached. You can delay the recipient without regard to the sender by setting
26857 &%address_retry_include_sender%& false in the &(smtp)& transport but this can
26858 lead to problems with servers that regularly issue 4&'xx'& responses to RCPT
26859 commands.
26860
26861
26862
26863 .section "Choosing which retry rule to use for host and message errors" &&&
26864          "SECID160"
26865 For a temporary error that is not related to an individual address (for
26866 example, a connection timeout), each line in the retry configuration is checked
26867 twice. First, the name of the remote host is used as a domain name (preceded by
26868 &"*@"& when matching a regular expression). If this does not match the line,
26869 the domain from the email address is tried in a similar fashion. For example,
26870 suppose the MX records for &'a.b.c.example'& are
26871 .code
26872 a.b.c.example  MX  5  x.y.z.example
26873                MX  6  p.q.r.example
26874                MX  7  m.n.o.example
26875 .endd
26876 and the retry rules are
26877 .code
26878 p.q.r.example    *      F,24h,30m;
26879 a.b.c.example    *      F,4d,45m;
26880 .endd
26881 and a delivery to the host &'x.y.z.example'& suffers a connection failure. The
26882 first rule matches neither the host nor the domain, so Exim looks at the second
26883 rule. This does not match the host, but it does match the domain, so it is used
26884 to calculate the retry time for the host &'x.y.z.example'&. Meanwhile, Exim
26885 tries to deliver to &'p.q.r.example'&. If this also suffers a host error, the
26886 first retry rule is used, because it matches the host.
26887
26888 In other words, temporary failures to deliver to host &'p.q.r.example'& use the
26889 first rule to determine retry times, but for all the other hosts for the domain
26890 &'a.b.c.example'&, the second rule is used. The second rule is also used if
26891 routing to &'a.b.c.example'& suffers a temporary failure.
26892
26893 &*Note*&: The host name is used when matching the patterns, not its IP address.
26894 However, if a message is routed directly to an IP address without the use of a
26895 host name, for example, if a &(manualroute)& router contains a setting such as:
26896 .code
26897 route_list = *.a.example  192.168.34.23
26898 .endd
26899 then the &"host name"& that is used when searching for a retry rule is the
26900 textual form of the IP address.
26901
26902 .section "Retry rules for specific errors" "SECID161"
26903 .cindex "retry" "specific errors; specifying"
26904 The second field in a retry rule is the name of a particular error, or an
26905 asterisk, which matches any error. The errors that can be tested for are:
26906
26907 .vlist
26908 .vitem &%auth_failed%&
26909 Authentication failed when trying to send to a host in the
26910 &%hosts_require_auth%& list in an &(smtp)& transport.
26911
26912 .vitem &%data_4xx%&
26913 A 4&'xx'& error was received for an outgoing DATA command, either immediately
26914 after the command, or after sending the message's data.
26915
26916 .vitem &%mail_4xx%&
26917 A 4&'xx'& error was received for an outgoing MAIL command.
26918
26919 .vitem &%rcpt_4xx%&
26920 A 4&'xx'& error was received for an outgoing RCPT command.
26921 .endlist
26922
26923 For the three 4&'xx'& errors, either the first or both of the x's can be given
26924 as specific digits, for example: &`mail_45x`& or &`rcpt_436`&. For example, to
26925 recognize 452 errors given to RCPT commands for addresses in a certain domain,
26926 and have retries every ten minutes with a one-hour timeout, you could set up a
26927 retry rule of this form:
26928 .code
26929 the.domain.name  rcpt_452   F,1h,10m
26930 .endd
26931 These errors apply to both outgoing SMTP (the &(smtp)& transport) and outgoing
26932 LMTP (either the &(lmtp)& transport, or the &(smtp)& transport in LMTP mode).
26933
26934 .vlist
26935 .vitem &%lost_connection%&
26936 A server unexpectedly closed the SMTP connection. There may, of course,
26937 legitimate reasons for this (host died, network died), but if it repeats a lot
26938 for the same host, it indicates something odd.
26939
26940 .vitem &%lookup%&
26941 A DNS lookup for a host failed.
26942 Note that a &%dnslookup%& router will need to have matched
26943 its &%fail_defer_domains%& option for this retry type to be usable.
26944 Also note that a &%manualroute%& router will probably need
26945 its &%host_find_failed%& option set to &%defer%&.
26946
26947 .vitem &%refused_MX%&
26948 A connection to a host obtained from an MX record was refused.
26949
26950 .vitem &%refused_A%&
26951 A connection to a host not obtained from an MX record was refused.
26952
26953 .vitem &%refused%&
26954 A connection was refused.
26955
26956 .vitem &%timeout_connect_MX%&
26957 A connection attempt to a host obtained from an MX record timed out.
26958
26959 .vitem &%timeout_connect_A%&
26960 A connection attempt to a host not obtained from an MX record timed out.
26961
26962 .vitem &%timeout_connect%&
26963 A connection attempt timed out.
26964
26965 .vitem &%timeout_MX%&
26966 There was a timeout while connecting or during an SMTP session with a host
26967 obtained from an MX record.
26968
26969 .vitem &%timeout_A%&
26970 There was a timeout while connecting or during an SMTP session with a host not
26971 obtained from an MX record.
26972
26973 .vitem &%timeout%&
26974 There was a timeout while connecting or during an SMTP session.
26975
26976 .vitem &%tls_required%&
26977 The server was required to use TLS (it matched &%hosts_require_tls%& in the
26978 &(smtp)& transport), but either did not offer TLS, or it responded with 4&'xx'&
26979 to STARTTLS, or there was a problem setting up the TLS connection.
26980
26981 .vitem &%quota%&
26982 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
26983 transport.
26984
26985 .vitem &%quota_%&<&'time'&>
26986 .cindex "quota" "error testing in retry rule"
26987 .cindex "retry" "quota error testing"
26988 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
26989 transport, and the mailbox has not been accessed for <&'time'&>. For example,
26990 &'quota_4d'& applies to a quota error when the mailbox has not been accessed
26991 for four days.
26992 .endlist
26993
26994 .cindex "mailbox" "time of last read"
26995 The idea of &%quota_%&<&'time'&> is to make it possible to have shorter
26996 timeouts when the mailbox is full and is not being read by its owner. Ideally,
26997 it should be based on the last time that the user accessed the mailbox.
26998 However, it is not always possible to determine this. Exim uses the following
26999 heuristic rules:
27000
27001 .ilist
27002 If the mailbox is a single file, the time of last access (the &"atime"&) is
27003 used. As no new messages are being delivered (because the mailbox is over
27004 quota), Exim does not access the file, so this is the time of last user access.
27005 .next
27006 .cindex "maildir format" "time of last read"
27007 For a maildir delivery, the time of last modification of the &_new_&
27008 subdirectory is used. As the mailbox is over quota, no new files are created in
27009 the &_new_& subdirectory, because no new messages are being delivered. Any
27010 change to the &_new_& subdirectory is therefore assumed to be the result of an
27011 MUA moving a new message to the &_cur_& directory when it is first read. The
27012 time that is used is therefore the last time that the user read a new message.
27013 .next
27014 For other kinds of multi-file mailbox, the time of last access cannot be
27015 obtained, so a retry rule that uses this type of error field is never matched.
27016 .endlist
27017
27018 The quota errors apply both to system-enforced quotas and to Exim's own quota
27019 mechanism in the &(appendfile)& transport. The &'quota'& error also applies
27020 when a local delivery is deferred because a partition is full (the ENOSPC
27021 error).
27022
27023
27024
27025 .section "Retry rules for specified senders" "SECID162"
27026 .cindex "retry" "rules; sender-specific"
27027 You can specify retry rules that apply only when the failing message has a
27028 specific sender. In particular, this can be used to define retry rules that
27029 apply only to bounce messages. The third item in a retry rule can be of this
27030 form:
27031 .display
27032 &`senders=`&<&'address list'&>
27033 .endd
27034 The retry timings themselves are then the fourth item. For example:
27035 .code
27036 *   rcpt_4xx   senders=:   F,1h,30m
27037 .endd
27038 matches recipient 4&'xx'& errors for bounce messages sent to any address at any
27039 host. If the address list contains white space, it must be enclosed in quotes.
27040 For example:
27041 .code
27042 a.domain  rcpt_452  senders="xb.dom : yc.dom"  G,8h,10m,1.5
27043 .endd
27044 &*Warning*&: This facility can be unhelpful if it is used for host errors
27045 (which do not depend on the recipient). The reason is that the sender is used
27046 only to match the retry rule. Once the rule has been found for a host error,
27047 its contents are used to set a retry time for the host, and this will apply to
27048 all messages, not just those with specific senders.
27049
27050 When testing retry rules using &%-brt%&, you can supply a sender using the
27051 &%-f%& command line option, like this:
27052 .code
27053 exim -f "" -brt user@dom.ain
27054 .endd
27055 If you do not set &%-f%& with &%-brt%&, a retry rule that contains a senders
27056 list is never matched.
27057
27058
27059
27060
27061
27062 .section "Retry parameters" "SECID163"
27063 .cindex "retry" "parameters in rules"
27064 The third (or fourth, if a senders list is present) field in a retry rule is a
27065 sequence of retry parameter sets, separated by semicolons. Each set consists of
27066 .display
27067 <&'letter'&>,<&'cutoff time'&>,<&'arguments'&>
27068 .endd
27069 The letter identifies the algorithm for computing a new retry time; the cutoff
27070 time is the time beyond which this algorithm no longer applies, and the
27071 arguments vary the algorithm's action. The cutoff time is measured from the
27072 time that the first failure for the domain (combined with the local part if
27073 relevant) was detected, not from the time the message was received.
27074
27075 .cindex "retry" "algorithms"
27076 .cindex "retry" "fixed intervals"
27077 .cindex "retry" "increasing intervals"
27078 .cindex "retry" "random intervals"
27079 The available algorithms are:
27080
27081 .ilist
27082 &'F'&: retry at fixed intervals. There is a single time parameter specifying
27083 the interval.
27084 .next
27085 &'G'&: retry at geometrically increasing intervals. The first argument
27086 specifies a starting value for the interval, and the second a multiplier, which
27087 is used to increase the size of the interval at each retry.
27088 .next
27089 &'H'&: retry at randomized intervals. The arguments are as for &'G'&. For each
27090 retry, the previous interval is multiplied by the factor in order to get a
27091 maximum for the next interval. The minimum interval is the first argument of
27092 the parameter, and an actual interval is chosen randomly between them. Such a
27093 rule has been found to be helpful in cluster configurations when all the
27094 members of the cluster restart at once, and may therefore synchronize their
27095 queue processing times.
27096 .endlist
27097
27098 When computing the next retry time, the algorithm definitions are scanned in
27099 order until one whose cutoff time has not yet passed is reached. This is then
27100 used to compute a new retry time that is later than the current time. In the
27101 case of fixed interval retries, this simply means adding the interval to the
27102 current time. For geometrically increasing intervals, retry intervals are
27103 computed from the rule's parameters until one that is greater than the previous
27104 interval is found. The main configuration variable
27105 .cindex "limit" "retry interval"
27106 .cindex "retry" "interval, maximum"
27107 .oindex "&%retry_interval_max%&"
27108 &%retry_interval_max%& limits the maximum interval between retries. It
27109 cannot be set greater than &`24h`&, which is its default value.
27110
27111 A single remote domain may have a number of hosts associated with it, and each
27112 host may have more than one IP address. Retry algorithms are selected on the
27113 basis of the domain name, but are applied to each IP address independently. If,
27114 for example, a host has two IP addresses and one is unusable, Exim will
27115 generate retry times for it and will not try to use it until its next retry
27116 time comes. Thus the good IP address is likely to be tried first most of the
27117 time.
27118
27119 .cindex "hints database" "use for retrying"
27120 Retry times are hints rather than promises. Exim does not make any attempt to
27121 run deliveries exactly at the computed times. Instead, a queue runner process
27122 starts delivery processes for delayed messages periodically, and these attempt
27123 new deliveries only for those addresses that have passed their next retry time.
27124 If a new message arrives for a deferred address, an immediate delivery attempt
27125 occurs only if the address has passed its retry time. In the absence of new
27126 messages, the minimum time between retries is the interval between queue runner
27127 processes. There is not much point in setting retry times of five minutes if
27128 your queue runners happen only once an hour, unless there are a significant
27129 number of incoming messages (which might be the case on a system that is
27130 sending everything to a smart host, for example).
27131
27132 The data in the retry hints database can be inspected by using the
27133 &'exim_dumpdb'& or &'exim_fixdb'& utility programs (see chapter
27134 &<<CHAPutils>>&). The latter utility can also be used to change the data. The
27135 &'exinext'& utility script can be used to find out what the next retry times
27136 are for the hosts associated with a particular mail domain, and also for local
27137 deliveries that have been deferred.
27138
27139
27140 .section "Retry rule examples" "SECID164"
27141 Here are some example retry rules:
27142 .code
27143 alice@wonderland.fict.example quota_5d  F,7d,3h
27144 wonderland.fict.example       quota_5d
27145 wonderland.fict.example       *         F,1h,15m; G,2d,1h,2;
27146 lookingglass.fict.example     *         F,24h,30m;
27147 *                 refused_A   F,2h,20m;
27148 *                 *           F,2h,15m; G,16h,1h,1.5; F,5d,8h
27149 .endd
27150 The first rule sets up special handling for mail to
27151 &'alice@wonderland.fict.example'& when there is an over-quota error and the
27152 mailbox has not been read for at least 5 days. Retries continue every three
27153 hours for 7 days. The second rule handles over-quota errors for all other local
27154 parts at &'wonderland.fict.example'&; the absence of a local part has the same
27155 effect as supplying &"*@"&. As no retry algorithms are supplied, messages that
27156 fail are bounced immediately if the mailbox has not been read for at least 5
27157 days.
27158
27159 The third rule handles all other errors at &'wonderland.fict.example'&; retries
27160 happen every 15 minutes for an hour, then with geometrically increasing
27161 intervals until two days have passed since a delivery first failed. After the
27162 first hour there is a delay of one hour, then two hours, then four hours, and
27163 so on (this is a rather extreme example).
27164
27165 The fourth rule controls retries for the domain &'lookingglass.fict.example'&.
27166 They happen every 30 minutes for 24 hours only. The remaining two rules handle
27167 all other domains, with special action for connection refusal from hosts that
27168 were not obtained from an MX record.
27169
27170 The final rule in a retry configuration should always have asterisks in the
27171 first two fields so as to provide a general catch-all for any addresses that do
27172 not have their own special handling. This example tries every 15 minutes for 2
27173 hours, then with intervals starting at one hour and increasing by a factor of
27174 1.5 up to 16 hours, then every 8 hours up to 5 days.
27175
27176
27177
27178 .section "Timeout of retry data" "SECID165"
27179 .cindex "timeout" "of retry data"
27180 .oindex "&%retry_data_expire%&"
27181 .cindex "hints database" "data expiry"
27182 .cindex "retry" "timeout of data"
27183 Exim timestamps the data that it writes to its retry hints database. When it
27184 consults the data during a delivery it ignores any that is older than the value
27185 set in &%retry_data_expire%& (default 7 days). If, for example, a host hasn't
27186 been tried for 7 days, Exim will try to deliver to it immediately a message
27187 arrives, and if that fails, it will calculate a retry time as if it were
27188 failing for the first time.
27189
27190 This improves the behaviour for messages routed to rarely-used hosts such as MX
27191 backups. If such a host was down at one time, and happens to be down again when
27192 Exim tries a month later, using the old retry data would imply that it had been
27193 down all the time, which is not a justified assumption.
27194
27195 If a host really is permanently dead, this behaviour causes a burst of retries
27196 every now and again, but only if messages routed to it are rare. If there is a
27197 message at least once every 7 days the retry data never expires.
27198
27199
27200
27201
27202 .section "Long-term failures" "SECID166"
27203 .cindex "delivery failure, long-term"
27204 .cindex "retry" "after long-term failure"
27205 Special processing happens when an email address has been failing for so long
27206 that the cutoff time for the last algorithm is reached. For example, using the
27207 default retry rule:
27208 .code
27209 * * F,2h,15m; G,16h,1h,1.5; F,4d,6h
27210 .endd
27211 the cutoff time is four days. Reaching the retry cutoff is independent of how
27212 long any specific message has been failing; it is the length of continuous
27213 failure for the recipient address that counts.
27214
27215 When the cutoff time is reached for a local delivery, or for all the IP
27216 addresses associated with a remote delivery, a subsequent delivery failure
27217 causes Exim to give up on the address, and a bounce message is generated.
27218 In order to cater for new messages that use the failing address, a next retry
27219 time is still computed from the final algorithm, and is used as follows:
27220
27221 For local deliveries, one delivery attempt is always made for any subsequent
27222 messages. If this delivery fails, the address fails immediately. The
27223 post-cutoff retry time is not used.
27224
27225 .cindex "final cutoff" "retries, controlling"
27226 .cindex retry "final cutoff"
27227 If the delivery is remote, there are two possibilities, controlled by the
27228 .oindex "&%delay_after_cutoff%&"
27229 &%delay_after_cutoff%& option of the &(smtp)& transport. The option is true by
27230 default. Until the post-cutoff retry time for one of the IP addresses,
27231 as set by the &%retry_data_expire%& option, is
27232 reached, the failing email address is bounced immediately, without a delivery
27233 attempt taking place. After that time, one new delivery attempt is made to
27234 those IP addresses that are past their retry times, and if that still fails,
27235 the address is bounced and new retry times are computed.
27236
27237 In other words, when all the hosts for a given email address have been failing
27238 for a long time, Exim bounces rather then defers until one of the hosts' retry
27239 times is reached. Then it tries once, and bounces if that attempt fails. This
27240 behaviour ensures that few resources are wasted in repeatedly trying to deliver
27241 to a broken destination, but if the host does recover, Exim will eventually
27242 notice.
27243
27244 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
27245 addresses are past their final cutoff time, Exim tries to deliver to those IP
27246 addresses that have not been tried since the message arrived. If there are
27247 no suitable IP addresses, or if they all fail, the address is bounced. In other
27248 words, it does not delay when a new message arrives, but tries the expired
27249 addresses immediately, unless they have been tried since the message arrived.
27250 If there is a continuous stream of messages for the failing domains, setting
27251 &%delay_after_cutoff%& false means that there will be many more attempts to
27252 deliver to permanently failing IP addresses than when &%delay_after_cutoff%& is
27253 true.
27254
27255 .section "Deliveries that work intermittently" "SECID167"
27256 .cindex "retry" "intermittently working deliveries"
27257 Some additional logic is needed to cope with cases where a host is
27258 intermittently available, or when a message has some attribute that prevents
27259 its delivery when others to the same address get through. In this situation,
27260 because some messages are successfully delivered, the &"retry clock"& for the
27261 host or address keeps getting reset by the successful deliveries, and so
27262 failing messages remain in the queue for ever because the cutoff time is never
27263 reached.
27264
27265 Two exceptional actions are applied to prevent this happening. The first
27266 applies to errors that are related to a message rather than a remote host.
27267 Section &<<SECToutSMTPerr>>& has a discussion of the different kinds of error;
27268 examples of message-related errors are 4&'xx'& responses to MAIL or DATA
27269 commands, and quota failures. For this type of error, if a message's arrival
27270 time is earlier than the &"first failed"& time for the error, the earlier time
27271 is used when scanning the retry rules to decide when to try next and when to
27272 time out the address.
27273
27274 The exceptional second action applies in all cases. If a message has been on
27275 the queue for longer than the cutoff time of any applicable retry rule for a
27276 given address, a delivery is attempted for that address, even if it is not yet
27277 time, and if this delivery fails, the address is timed out. A new retry time is
27278 not computed in this case, so that other messages for the same address are
27279 considered immediately.
27280 .ecindex IIDretconf1
27281 .ecindex IIDregconf2
27282
27283
27284
27285
27286
27287
27288 . ////////////////////////////////////////////////////////////////////////////
27289 . ////////////////////////////////////////////////////////////////////////////
27290
27291 .chapter "SMTP authentication" "CHAPSMTPAUTH"
27292 .scindex IIDauthconf1 "SMTP" "authentication configuration"
27293 .scindex IIDauthconf2 "authentication"
27294 The &"authenticators"& section of Exim's runtime configuration is concerned
27295 with SMTP authentication. This facility is an extension to the SMTP protocol,
27296 described in RFC 2554, which allows a client SMTP host to authenticate itself
27297 to a server. This is a common way for a server to recognize clients that are
27298 permitted to use it as a relay. SMTP authentication is not of relevance to the
27299 transfer of mail between servers that have no managerial connection with each
27300 other.
27301
27302 .new
27303 The name of an authenticator is limited to be &drivernamemax; ASCII characters long;
27304 prior to Exim 4.95 names would be silently truncated at this length, but now
27305 it is enforced.
27306 .wen
27307
27308 .cindex "AUTH" "description of"
27309 .cindex "ESMTP extensions" AUTH
27310 Very briefly, the way SMTP authentication works is as follows:
27311
27312 .ilist
27313 The server advertises a number of authentication &'mechanisms'& in response to
27314 the client's EHLO command.
27315 .next
27316 The client issues an AUTH command, naming a specific mechanism. The command
27317 may, optionally, contain some authentication data.
27318 .next
27319 The server may issue one or more &'challenges'&, to which the client must send
27320 appropriate responses. In simple authentication mechanisms, the challenges are
27321 just prompts for user names and passwords. The server does not have to issue
27322 any challenges &-- in some mechanisms the relevant data may all be transmitted
27323 with the AUTH command.
27324 .next
27325 The server either accepts or denies authentication.
27326 .next
27327 If authentication succeeds, the client may optionally make use of the AUTH
27328 option on the MAIL command to pass an authenticated sender in subsequent
27329 mail transactions. Authentication lasts for the remainder of the SMTP
27330 connection.
27331 .next
27332 If authentication fails, the client may give up, or it may try a different
27333 authentication mechanism, or it may try transferring mail over the
27334 unauthenticated connection.
27335 .endlist
27336
27337 If you are setting up a client, and want to know which authentication
27338 mechanisms the server supports, you can use Telnet to connect to port 25 (the
27339 SMTP port) on the server, and issue an EHLO command. The response to this
27340 includes the list of supported mechanisms. For example:
27341 .display
27342 &`$ `&&*&`telnet server.example 25`&*&
27343 &`Trying 192.168.34.25...`&
27344 &`Connected to server.example.`&
27345 &`Escape character is &#x0027;^]&#x0027;.`&
27346 &`220 server.example ESMTP Exim 4.20 ...`&
27347 &*&`ehlo client.example`&*&
27348 &`250-server.example Hello client.example [10.8.4.5]`&
27349 &`250-SIZE 52428800`&
27350 &`250-PIPELINING`&
27351 &`250-AUTH PLAIN`&
27352 &`250 HELP`&
27353 .endd
27354 The second-last line of this example output shows that the server supports
27355 authentication using the PLAIN mechanism. In Exim, the different authentication
27356 mechanisms are configured by specifying &'authenticator'& drivers. Like the
27357 routers and transports, which authenticators are included in the binary is
27358 controlled by build-time definitions. The following are currently available,
27359 included by setting
27360 .code
27361 AUTH_CRAM_MD5=yes
27362 AUTH_CYRUS_SASL=yes
27363 AUTH_DOVECOT=yes
27364 AUTH_EXTERNAL=yes
27365 AUTH_GSASL=yes
27366 AUTH_HEIMDAL_GSSAPI=yes
27367 AUTH_PLAINTEXT=yes
27368 AUTH_SPA=yes
27369 AUTH_TLS=yes
27370 .endd
27371 in &_Local/Makefile_&, respectively. The first of these supports the CRAM-MD5
27372 authentication mechanism (RFC 2195), and the second provides an interface to
27373 the Cyrus SASL authentication library.
27374 The third is an interface to Dovecot's authentication system, delegating the
27375 work via a socket interface.
27376 The fourth provides for negotiation of authentication done via non-SMTP means,
27377 as defined by RFC 4422 Appendix A.
27378 The fifth provides an interface to the GNU SASL authentication library, which
27379 provides mechanisms but typically not data sources.
27380 The sixth provides direct access to Heimdal GSSAPI, geared for Kerberos, but
27381 supporting setting a server keytab.
27382 The seventh can be configured to support
27383 the PLAIN authentication mechanism (RFC 2595) or the LOGIN mechanism, which is
27384 not formally documented, but used by several MUAs.
27385 The eighth authenticator
27386 supports Microsoft's &'Secure Password Authentication'& mechanism.
27387 The last is an Exim authenticator but not an SMTP one;
27388 instead it can use information from a TLS negotiation.
27389
27390 The authenticators are configured using the same syntax as other drivers (see
27391 section &<<SECTfordricon>>&). If no authenticators are required, no
27392 authentication section need be present in the configuration file. Each
27393 authenticator can in principle have both server and client functions. When Exim
27394 is receiving SMTP mail, it is acting as a server; when it is sending out
27395 messages over SMTP, it is acting as a client. Authenticator configuration
27396 options are provided for use in both these circumstances.
27397
27398 To make it clear which options apply to which situation, the prefixes
27399 &%server_%& and &%client_%& are used on option names that are specific to
27400 either the server or the client function, respectively. Server and client
27401 functions are disabled if none of their options are set. If an authenticator is
27402 to be used for both server and client functions, a single definition, using
27403 both sets of options, is required. For example:
27404 .code
27405 cram:
27406   driver = cram_md5
27407   public_name = CRAM-MD5
27408   server_secret = ${if eq{$auth1}{ph10}{secret1}fail}
27409   client_name = ph10
27410   client_secret = secret2
27411 .endd
27412 The &%server_%& option is used when Exim is acting as a server, and the
27413 &%client_%& options when it is acting as a client.
27414
27415 Descriptions of the individual authenticators are given in subsequent chapters.
27416 The remainder of this chapter covers the generic options for the
27417 authenticators, followed by general discussion of the way authentication works
27418 in Exim.
27419
27420 &*Beware:*& the meaning of &$auth1$&, &$auth2$&, ... varies on a per-driver and
27421 per-mechanism basis.  Please read carefully to determine which variables hold
27422 account labels such as usercodes and which hold passwords or other
27423 authenticating data.
27424
27425 Note that some mechanisms support two different identifiers for accounts: the
27426 &'authentication id'& and the &'authorization id'&.  The contractions &'authn'&
27427 and &'authz'& are commonly encountered.  The American spelling is standard here.
27428 Conceptually, authentication data such as passwords are tied to the identifier
27429 used to authenticate; servers may have rules to permit one user to act as a
27430 second user, so that after login the session is treated as though that second
27431 user had logged in.  That second user is the &'authorization id'&.  A robust
27432 configuration might confirm that the &'authz'& field is empty or matches the
27433 &'authn'& field.  Often this is just ignored.  The &'authn'& can be considered
27434 as verified data, the &'authz'& as an unverified request which the server might
27435 choose to honour.
27436
27437 A &'realm'& is a text string, typically a domain name, presented by a server
27438 to a client to help it select an account and credentials to use.  In some
27439 mechanisms, the client and server provably agree on the realm, but clients
27440 typically can not treat the realm as secure data to be blindly trusted.
27441
27442
27443
27444 .section "Generic options for authenticators" "SECID168"
27445 .cindex "authentication" "generic options"
27446 .cindex "options" "generic; for authenticators"
27447
27448 .option client_condition authenticators string&!! unset
27449 When Exim is authenticating as a client, it skips any authenticator whose
27450 &%client_condition%& expansion yields &"0"&, &"no"&, or &"false"&. This can be
27451 used, for example, to skip plain text authenticators when the connection is not
27452 encrypted by a setting such as:
27453 .code
27454 client_condition = ${if !eq{$tls_out_cipher}{}}
27455 .endd
27456
27457
27458 .option client_set_id authenticators string&!! unset
27459 When client authentication succeeds, this condition is expanded; the
27460 result is used in the log lines for outbound messages.
27461 Typically it will be the user name used for authentication.
27462
27463
27464 .option driver authenticators string unset
27465 This option must always be set. It specifies which of the available
27466 authenticators is to be used.
27467
27468
27469 .option public_name authenticators string unset
27470 This option specifies the name of the authentication mechanism that the driver
27471 implements, and by which it is known to the outside world. These names should
27472 contain only upper case letters, digits, underscores, and hyphens (RFC 2222),
27473 but Exim in fact matches them caselessly. If &%public_name%& is not set, it
27474 defaults to the driver's instance name.
27475
27476
27477 .option server_advertise_condition authenticators string&!! unset
27478 When a server is about to advertise an authentication mechanism, the condition
27479 is expanded. If it yields the empty string, &"0"&, &"no"&, or &"false"&, the
27480 mechanism is not advertised.
27481 If the expansion fails, the mechanism is not advertised. If the failure was not
27482 forced, and was not caused by a lookup defer, the incident is logged.
27483 See section &<<SECTauthexiser>>& below for further discussion.
27484
27485
27486 .option server_condition authenticators string&!! unset
27487 This option must be set for a &%plaintext%& server authenticator, where it
27488 is used directly to control authentication. See section &<<SECTplainserver>>&
27489 for details.
27490
27491 For the &(gsasl)& authenticator, this option is required for various
27492 mechanisms; see chapter &<<CHAPgsasl>>& for details.
27493
27494 For the other authenticators, &%server_condition%& can be used as an additional
27495 authentication or authorization mechanism that is applied after the other
27496 authenticator conditions succeed. If it is set, it is expanded when the
27497 authenticator would otherwise return a success code. If the expansion is forced
27498 to fail, authentication fails. Any other expansion failure causes a temporary
27499 error code to be returned. If the result of a successful expansion is an empty
27500 string, &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
27501 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds. For any
27502 other result, a temporary error code is returned, with the expanded string as
27503 the error text.
27504
27505
27506 .option server_debug_print authenticators string&!! unset
27507 If this option is set and authentication debugging is enabled (see the &%-d%&
27508 command line option), the string is expanded and included in the debugging
27509 output when the authenticator is run as a server. This can help with checking
27510 out the values of variables.
27511 If expansion of the string fails, the error message is written to the debugging
27512 output, and Exim carries on processing.
27513
27514
27515 .option server_set_id authenticators string&!! unset
27516 .vindex "&$authenticated_id$&"
27517 .vindex "&$authenticated_fail_id$&"
27518 When an Exim server successfully authenticates a client, this string is
27519 expanded using data from the authentication, and preserved for any incoming
27520 messages in the variable &$authenticated_id$&. It is also included in the log
27521 lines for incoming messages. For example, a user/password authenticator
27522 configuration might preserve the user name that was used to authenticate, and
27523 refer to it subsequently during delivery of the message.
27524 On a failing authentication the expansion result is instead saved in
27525 the &$authenticated_fail_id$& variable.
27526 If expansion fails, the option is ignored.
27527
27528
27529 .option server_mail_auth_condition authenticators string&!! unset
27530 This option allows a server to discard authenticated sender addresses supplied
27531 as part of MAIL commands in SMTP connections that are authenticated by the
27532 driver on which &%server_mail_auth_condition%& is set. The option is not used
27533 as part of the authentication process; instead its (unexpanded) value is
27534 remembered for later use.
27535 How it is used is described in the following section.
27536
27537
27538
27539
27540
27541 .section "The AUTH parameter on MAIL commands" "SECTauthparamail"
27542 .cindex "authentication" "sender; authenticated"
27543 .cindex "AUTH" "on MAIL command"
27544 When a client supplied an AUTH= item on a MAIL command, Exim applies
27545 the following checks before accepting it as the authenticated sender of the
27546 message:
27547
27548 .ilist
27549 If the connection is not using extended SMTP (that is, HELO was used rather
27550 than EHLO), the use of AUTH= is a syntax error.
27551 .next
27552 If the value of the AUTH= parameter is &"<>"&, it is ignored.
27553 .next
27554 .vindex "&$authenticated_sender$&"
27555 If &%acl_smtp_mailauth%& is defined, the ACL it specifies is run. While it is
27556 running, the value of &$authenticated_sender$& is set to the value obtained
27557 from the AUTH= parameter. If the ACL does not yield &"accept"&, the value of
27558 &$authenticated_sender$& is deleted. The &%acl_smtp_mailauth%& ACL may not
27559 return &"drop"& or &"discard"&. If it defers, a temporary error code (451) is
27560 given for the MAIL command.
27561 .next
27562 If &%acl_smtp_mailauth%& is not defined, the value of the AUTH= parameter
27563 is accepted and placed in &$authenticated_sender$& only if the client has
27564 authenticated.
27565 .next
27566 If the AUTH= value was accepted by either of the two previous rules, and
27567 the client has authenticated, and the authenticator has a setting for the
27568 &%server_mail_auth_condition%&, the condition is checked at this point. The
27569 valued that was saved from the authenticator is expanded. If the expansion
27570 fails, or yields an empty string, &"0"&, &"no"&, or &"false"&, the value of
27571 &$authenticated_sender$& is deleted. If the expansion yields any other value,
27572 the value of &$authenticated_sender$& is retained and passed on with the
27573 message.
27574 .endlist
27575
27576
27577 When &$authenticated_sender$& is set for a message, it is passed on to other
27578 hosts to which Exim authenticates as a client. Do not confuse this value with
27579 &$authenticated_id$&, which is a string obtained from the authentication
27580 process, and which is not usually a complete email address.
27581
27582 .vindex "&$sender_address$&"
27583 Whenever an AUTH= value is ignored, the incident is logged. The ACL for
27584 MAIL, if defined, is run after AUTH= is accepted or ignored. It can
27585 therefore make use of &$authenticated_sender$&. The converse is not true: the
27586 value of &$sender_address$& is not yet set up when the &%acl_smtp_mailauth%&
27587 ACL is run.
27588
27589
27590
27591 .section "Authentication on an Exim server" "SECTauthexiser"
27592 .cindex "authentication" "on an Exim server"
27593 When Exim receives an EHLO command, it advertises the public names of those
27594 authenticators that are configured as servers, subject to the following
27595 conditions:
27596
27597 .ilist
27598 The client host must match &%auth_advertise_hosts%& (default *).
27599 .next
27600 If the &%server_advertise_condition%& option is set, its expansion must not
27601 yield the empty string, &"0"&, &"no"&, or &"false"&.
27602 .endlist
27603
27604 The order in which the authenticators are defined controls the order in which
27605 the mechanisms are advertised.
27606
27607 Some mail clients (for example, some versions of Netscape) require the user to
27608 provide a name and password for authentication whenever AUTH is advertised,
27609 even though authentication may not in fact be needed (for example, Exim may be
27610 set up to allow unconditional relaying from the client by an IP address check).
27611 You can make such clients more friendly by not advertising AUTH to them.
27612 For example, if clients on the 10.9.8.0/24 network are permitted (by the ACL
27613 that runs for RCPT) to relay without authentication, you should set
27614 .code
27615 auth_advertise_hosts = ! 10.9.8.0/24
27616 .endd
27617 so that no authentication mechanisms are advertised to them.
27618
27619 The &%server_advertise_condition%& controls the advertisement of individual
27620 authentication mechanisms. For example, it can be used to restrict the
27621 advertisement of a particular mechanism to encrypted connections, by a setting
27622 such as:
27623 .code
27624 server_advertise_condition = ${if eq{$tls_in_cipher}{}{no}{yes}}
27625 .endd
27626 .vindex "&$tls_in_cipher$&"
27627 If the session is encrypted, &$tls_in_cipher$& is not empty, and so the expansion
27628 yields &"yes"&, which allows the advertisement to happen.
27629
27630 When an Exim server receives an AUTH command from a client, it rejects it
27631 immediately if AUTH was not advertised in response to an earlier EHLO
27632 command. This is the case if
27633
27634 .ilist
27635 The client host does not match &%auth_advertise_hosts%&; or
27636 .next
27637 No authenticators are configured with server options; or
27638 .next
27639 Expansion of &%server_advertise_condition%& blocked the advertising of all the
27640 server authenticators.
27641 .endlist
27642
27643
27644 Otherwise, Exim runs the ACL specified by &%acl_smtp_auth%& in order
27645 to decide whether to accept the command. If &%acl_smtp_auth%& is not set,
27646 AUTH is accepted from any client host.
27647
27648 If AUTH is not rejected by the ACL, Exim searches its configuration for a
27649 server authentication mechanism that was advertised in response to EHLO and
27650 that matches the one named in the AUTH command. If it finds one, it runs
27651 the appropriate authentication protocol, and authentication either succeeds or
27652 fails. If there is no matching advertised mechanism, the AUTH command is
27653 rejected with a 504 error.
27654
27655 .vindex "&$received_protocol$&"
27656 .vindex "&$sender_host_authenticated$&"
27657 When a message is received from an authenticated host, the value of
27658 &$received_protocol$& is set to &"esmtpa"& or &"esmtpsa"& instead of &"esmtp"&
27659 or &"esmtps"&, and &$sender_host_authenticated$& contains the name (not the
27660 public name) of the authenticator driver that successfully authenticated the
27661 client from which the message was received. This variable is empty if there was
27662 no successful authentication.
27663
27664 .cindex authentication "expansion item"
27665 Successful authentication sets up information used by the
27666 &%authresults%& expansion item.
27667
27668
27669
27670
27671 .section "Testing server authentication" "SECID169"
27672 .cindex "authentication" "testing a server"
27673 .cindex "AUTH" "testing a server"
27674 .cindex "base64 encoding" "creating authentication test data"
27675 Exim's &%-bh%& option can be useful for testing server authentication
27676 configurations. The data for the AUTH command has to be sent using base64
27677 encoding. A quick way to produce such data for testing is the following Perl
27678 script:
27679 .code
27680 use MIME::Base64;
27681 printf ("%s", encode_base64(eval "\"$ARGV[0]\""));
27682 .endd
27683 .cindex "binary zero" "in authentication data"
27684 This interprets its argument as a Perl string, and then encodes it. The
27685 interpretation as a Perl string allows binary zeros, which are required for
27686 some kinds of authentication, to be included in the data. For example, a
27687 command line to run this script on such data might be
27688 .code
27689 encode '\0user\0password'
27690 .endd
27691 Note the use of single quotes to prevent the shell interpreting the
27692 backslashes, so that they can be interpreted by Perl to specify characters
27693 whose code value is zero.
27694
27695 &*Warning 1*&: If either of the user or password strings starts with an octal
27696 digit, you must use three zeros instead of one after the leading backslash. If
27697 you do not, the octal digit that starts your string will be incorrectly
27698 interpreted as part of the code for the first character.
27699
27700 &*Warning 2*&: If there are characters in the strings that Perl interprets
27701 specially, you must use a Perl escape to prevent them being misinterpreted. For
27702 example, a command such as
27703 .code
27704 encode '\0user@domain.com\0pas$$word'
27705 .endd
27706 gives an incorrect answer because of the unescaped &"@"& and &"$"& characters.
27707
27708 If you have the &%mimencode%& command installed, another way to produce
27709 base64-encoded strings is to run the command
27710 .code
27711 echo -e -n `\0user\0password' | mimencode
27712 .endd
27713 The &%-e%& option of &%echo%& enables the interpretation of backslash escapes
27714 in the argument, and the &%-n%& option specifies no newline at the end of its
27715 output. However, not all versions of &%echo%& recognize these options, so you
27716 should check your version before relying on this suggestion.
27717
27718
27719
27720 .section "Authentication by an Exim client" "SECID170"
27721 .cindex "authentication" "on an Exim client"
27722 The &(smtp)& transport has two options called &%hosts_require_auth%& and
27723 &%hosts_try_auth%&. When the &(smtp)& transport connects to a server that
27724 announces support for authentication, and the host matches an entry in either
27725 of these options, Exim (as a client) tries to authenticate as follows:
27726
27727 .ilist
27728 For each authenticator that is configured as a client, in the order in which
27729 they are defined in the configuration, it searches the authentication
27730 mechanisms announced by the server for one whose name matches the public name
27731 of the authenticator.
27732 .next
27733 .vindex "&$host$&"
27734 .vindex "&$host_address$&"
27735 When it finds one that matches, it runs the authenticator's client code. The
27736 variables &$host$& and &$host_address$& are available for any string expansions
27737 that the client might do. They are set to the server's name and IP address. If
27738 any expansion is forced to fail, the authentication attempt is abandoned, and
27739 Exim moves on to the next authenticator. Otherwise an expansion failure causes
27740 delivery to be deferred.
27741 .next
27742 If the result of the authentication attempt is a temporary error or a timeout,
27743 Exim abandons trying to send the message to the host for the moment. It will
27744 try again later. If there are any backup hosts available, they are tried in the
27745 usual way.
27746 .next
27747 If the response to authentication is a permanent error (5&'xx'& code), Exim
27748 carries on searching the list of authenticators and tries another one if
27749 possible. If all authentication attempts give permanent errors, or if there are
27750 no attempts because no mechanisms match (or option expansions force failure),
27751 what happens depends on whether the host matches &%hosts_require_auth%& or
27752 &%hosts_try_auth%&. In the first case, a temporary error is generated, and
27753 delivery is deferred. The error can be detected in the retry rules, and thereby
27754 turned into a permanent error if you wish. In the second case, Exim tries to
27755 deliver the message unauthenticated.
27756 .endlist
27757
27758 Note that the hostlist test for whether to do authentication can be
27759 confused if name-IP lookups change between the time the peer is decided
27760 upon and the time that the transport runs.  For example, with a manualroute
27761 router given a host name, and with DNS "round-robin" used by that name: if
27762 the local resolver cache times out between the router and the transport
27763 running, the transport may get an IP for the name for its authentication
27764 check which does not match the connection peer IP.
27765 No authentication will then be done, despite the names being identical.
27766
27767 For such cases use a separate transport which always authenticates.
27768
27769 .cindex "AUTH" "on MAIL command"
27770 When Exim has authenticated itself to a remote server, it adds the AUTH
27771 parameter to the MAIL commands it sends, if it has an authenticated sender for
27772 the message. If the message came from a remote host, the authenticated sender
27773 is the one that was receiving on an incoming MAIL command, provided that the
27774 incoming connection was authenticated and the &%server_mail_auth%& condition
27775 allowed the authenticated sender to be retained. If a local process calls Exim
27776 to send a message, the sender address that is built from the login name and
27777 &%qualify_domain%& is treated as authenticated. However, if the
27778 &%authenticated_sender%& option is set on the &(smtp)& transport, it overrides
27779 the authenticated sender that was received with the message.
27780 .ecindex IIDauthconf1
27781 .ecindex IIDauthconf2
27782
27783
27784
27785
27786
27787
27788 . ////////////////////////////////////////////////////////////////////////////
27789 . ////////////////////////////////////////////////////////////////////////////
27790
27791 .chapter "The plaintext authenticator" "CHAPplaintext"
27792 .scindex IIDplaiauth1 "&(plaintext)& authenticator"
27793 .scindex IIDplaiauth2 "authenticators" "&(plaintext)&"
27794 The &(plaintext)& authenticator can be configured to support the PLAIN and
27795 LOGIN authentication mechanisms, both of which transfer authentication data as
27796 plain (unencrypted) text (though base64 encoded). The use of plain text is a
27797 security risk; you are strongly advised to insist on the use of SMTP encryption
27798 (see chapter &<<CHAPTLS>>&) if you use the PLAIN or LOGIN mechanisms. If you do
27799 use unencrypted plain text, you should not use the same passwords for SMTP
27800 connections as you do for login accounts.
27801
27802 .section "Avoiding cleartext use" "SECTplain_TLS"
27803 The following generic option settings will disable &(plaintext)& authenticators when
27804 TLS is not being used:
27805 .code
27806   server_advertise_condition = ${if def:tls_in_cipher }
27807   client_condition =           ${if def:tls_out_cipher}
27808 .endd
27809
27810 &*Note*&: a plaintext SMTP AUTH done inside TLS is not vulnerable to casual snooping,
27811 but is still vulnerable to a Man In The Middle attack unless certificates
27812 (including their names) have been properly verified.
27813
27814 .section "Plaintext server options" "SECID171"
27815 .cindex "options" "&(plaintext)& authenticator (server)"
27816 When configured as a server, &(plaintext)& uses the following options:
27817
27818 .option server_condition authenticators string&!! unset
27819 This is actually a global authentication option, but it must be set in order to
27820 configure the &(plaintext)& driver as a server. Its use is described below.
27821
27822 .option server_prompts plaintext "string list&!!" unset
27823 The contents of this option, after expansion, must be a colon-separated list of
27824 prompt strings. If expansion fails, a temporary authentication rejection is
27825 given.
27826
27827 .section "Using plaintext in a server" "SECTplainserver"
27828 .cindex "AUTH" "in &(plaintext)& authenticator"
27829 .cindex "binary zero" "in &(plaintext)& authenticator"
27830 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
27831         "in &(plaintext)& authenticator"
27832 .vindex "&$auth1$&, &$auth2$&, etc"
27833 .cindex "base64 encoding" "in &(plaintext)& authenticator"
27834
27835 When running as a server, &(plaintext)& performs the authentication test by
27836 expanding a string. The data sent by the client with the AUTH command, or in
27837 response to subsequent prompts, is base64 encoded, and so may contain any byte
27838 values when decoded. If any data is supplied with the command, it is treated as
27839 a list of strings, separated by NULs (binary zeros), the first three of which
27840 are placed in the expansion variables &$auth1$&, &$auth2$&, and &$auth3$&
27841 (neither LOGIN nor PLAIN uses more than three strings).
27842
27843 For compatibility with previous releases of Exim, the values are also placed in
27844 the expansion variables &$1$&, &$2$&, and &$3$&. However, the use of these
27845 variables for this purpose is now deprecated, as it can lead to confusion in
27846 string expansions that also use them for other things.
27847
27848 If there are more strings in &%server_prompts%& than the number of strings
27849 supplied with the AUTH command, the remaining prompts are used to obtain more
27850 data. Each response from the client may be a list of NUL-separated strings.
27851
27852 .vindex "&$authenticated_id$&"
27853 Once a sufficient number of data strings have been received,
27854 &%server_condition%& is expanded. If the expansion is forced to fail,
27855 authentication fails. Any other expansion failure causes a temporary error code
27856 to be returned. If the result of a successful expansion is an empty string,
27857 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
27858 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
27859 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
27860 For any other result, a temporary error code is returned, with the expanded
27861 string as the error text.
27862
27863 &*Warning*&: If you use a lookup in the expansion to find the user's
27864 password, be sure to make the authentication fail if the user is unknown.
27865 There are good and bad examples at the end of the next section.
27866
27867
27868
27869 .section "The PLAIN authentication mechanism" "SECID172"
27870 .cindex "PLAIN authentication mechanism"
27871 .cindex authentication PLAIN
27872 .cindex "binary zero" "in &(plaintext)& authenticator"
27873 The PLAIN authentication mechanism (RFC 2595) specifies that three strings be
27874 sent as one item of data (that is, one combined string containing two NUL
27875 separators). The data is sent either as part of the AUTH command, or
27876 subsequently in response to an empty prompt from the server.
27877
27878 The second and third strings are a user name and a corresponding password.
27879 Using a single fixed user name and password as an example, this could be
27880 configured as follows:
27881 .code
27882 fixed_plain:
27883   driver = plaintext
27884   public_name = PLAIN
27885   server_prompts = :
27886   server_condition = \
27887     ${if and {{eq{$auth2}{username}}{eq{$auth3}{mysecret}}}}
27888   server_set_id = $auth2
27889 .endd
27890 Note that the default result strings from &%if%& (&"true"& or an empty string)
27891 are exactly what we want here, so they need not be specified. Obviously, if the
27892 password contains expansion-significant characters such as dollar, backslash,
27893 or closing brace, they have to be escaped.
27894
27895 The &%server_prompts%& setting specifies a single, empty prompt (empty items at
27896 the end of a string list are ignored). If all the data comes as part of the
27897 AUTH command, as is commonly the case, the prompt is not used. This
27898 authenticator is advertised in the response to EHLO as
27899 .code
27900 250-AUTH PLAIN
27901 .endd
27902 and a client host can authenticate itself by sending the command
27903 .code
27904 AUTH PLAIN AHVzZXJuYW1lAG15c2VjcmV0
27905 .endd
27906 As this contains three strings (more than the number of prompts), no further
27907 data is required from the client. Alternatively, the client may just send
27908 .code
27909 AUTH PLAIN
27910 .endd
27911 to initiate authentication, in which case the server replies with an empty
27912 prompt. The client must respond with the combined data string.
27913
27914 The data string is base64 encoded, as required by the RFC. This example,
27915 when decoded, is <&'NUL'&>&`username`&<&'NUL'&>&`mysecret`&, where <&'NUL'&>
27916 represents a zero byte. This is split up into three strings, the first of which
27917 is empty. The &%server_condition%& option in the authenticator checks that the
27918 second two are &`username`& and &`mysecret`& respectively.
27919
27920 Having just one fixed user name and password, as in this example, is not very
27921 realistic, though for a small organization with only a handful of
27922 authenticating clients it could make sense.
27923
27924 A more sophisticated instance of this authenticator could use the user name in
27925 &$auth2$& to look up a password in a file or database, and maybe do an encrypted
27926 comparison (see &%crypteq%& in chapter &<<CHAPexpand>>&). Here is a example of
27927 this approach, where the passwords are looked up in a DBM file. &*Warning*&:
27928 This is an incorrect example:
27929 .code
27930 server_condition = \
27931   ${if eq{$auth3}{${lookup{$auth2}dbm{/etc/authpwd}}}}
27932 .endd
27933 The expansion uses the user name (&$auth2$&) as the key to look up a password,
27934 which it then compares to the supplied password (&$auth3$&). Why is this example
27935 incorrect? It works fine for existing users, but consider what happens if a
27936 non-existent user name is given. The lookup fails, but as no success/failure
27937 strings are given for the lookup, it yields an empty string. Thus, to defeat
27938 the authentication, all a client has to do is to supply a non-existent user
27939 name and an empty password. The correct way of writing this test is:
27940 .code
27941 server_condition = ${lookup{$auth2}dbm{/etc/authpwd}\
27942   {${if eq{$value}{$auth3}}} {false}}
27943 .endd
27944 In this case, if the lookup succeeds, the result is checked; if the lookup
27945 fails, &"false"& is returned and authentication fails. If &%crypteq%& is being
27946 used instead of &%eq%&, the first example is in fact safe, because &%crypteq%&
27947 always fails if its second argument is empty. However, the second way of
27948 writing the test makes the logic clearer.
27949
27950
27951 .section "The LOGIN authentication mechanism" "SECID173"
27952 .cindex "LOGIN authentication mechanism"
27953 .cindex authentication LOGIN
27954 The LOGIN authentication mechanism is not documented in any RFC, but is in use
27955 in a number of programs. No data is sent with the AUTH command. Instead, a
27956 user name and password are supplied separately, in response to prompts. The
27957 plaintext authenticator can be configured to support this as in this example:
27958 .code
27959 fixed_login:
27960   driver = plaintext
27961   public_name = LOGIN
27962   server_prompts = User Name : Password
27963   server_condition = \
27964     ${if and {{eq{$auth1}{username}}{eq{$auth2}{mysecret}}}}
27965   server_set_id = $auth1
27966 .endd
27967 Because of the way plaintext operates, this authenticator accepts data supplied
27968 with the AUTH command (in contravention of the specification of LOGIN), but
27969 if the client does not supply it (as is the case for LOGIN clients), the prompt
27970 strings are used to obtain two data items.
27971
27972 Some clients are very particular about the precise text of the prompts. For
27973 example, Outlook Express is reported to recognize only &"Username:"& and
27974 &"Password:"&. Here is an example of a LOGIN authenticator that uses those
27975 strings. It uses the &%ldapauth%& expansion condition to check the user
27976 name and password by binding to an LDAP server:
27977 .code
27978 login:
27979   driver = plaintext
27980   public_name = LOGIN
27981   server_prompts = Username:: : Password::
27982   server_condition = ${if and{{ \
27983     !eq{}{$auth1} }{ \
27984     ldapauth{\
27985       user="uid=${quote_ldap_dn:$auth1},ou=people,o=example.org" \
27986       pass=${quote:$auth2} \
27987       ldap://ldap.example.org/} }} }
27988   server_set_id = uid=$auth1,ou=people,o=example.org
27989 .endd
27990 We have to check that the username is not empty before using it, because LDAP
27991 does not permit empty DN components. We must also use the &%quote_ldap_dn%&
27992 operator to correctly quote the DN for authentication. However, the basic
27993 &%quote%& operator, rather than any of the LDAP quoting operators, is the
27994 correct one to use for the password, because quoting is needed only to make
27995 the password conform to the Exim syntax. At the LDAP level, the password is an
27996 uninterpreted string.
27997
27998
27999 .section "Support for different kinds of authentication" "SECID174"
28000 A number of string expansion features are provided for the purpose of
28001 interfacing to different ways of user authentication. These include checking
28002 traditionally encrypted passwords from &_/etc/passwd_& (or equivalent), PAM,
28003 Radius, &%ldapauth%&, &'pwcheck'&, and &'saslauthd'&. For details see section
28004 &<<SECTexpcond>>&.
28005
28006
28007
28008
28009 .section "Using plaintext in a client" "SECID175"
28010 .cindex "options" "&(plaintext)& authenticator (client)"
28011 The &(plaintext)& authenticator has two client options:
28012
28013 .option client_ignore_invalid_base64 plaintext boolean false
28014 If the client receives a server prompt that is not a valid base64 string,
28015 authentication is abandoned by default. However, if this option is set true,
28016 the error in the challenge is ignored and the client sends the response as
28017 usual.
28018
28019 .option client_send plaintext string&!! unset
28020 The string is a colon-separated list of authentication data strings. Each
28021 string is independently expanded before being sent to the server. The first
28022 string is sent with the AUTH command; any more strings are sent in response
28023 to prompts from the server. Before each string is expanded, the value of the
28024 most recent prompt is placed in the next &$auth$&<&'n'&> variable, starting
28025 with &$auth1$& for the first prompt. Up to three prompts are stored in this
28026 way. Thus, the prompt that is received in response to sending the first string
28027 (with the AUTH command) can be used in the expansion of the second string, and
28028 so on. If an invalid base64 string is received when
28029 &%client_ignore_invalid_base64%& is set, an empty string is put in the
28030 &$auth$&<&'n'&> variable.
28031
28032 &*Note*&: You cannot use expansion to create multiple strings, because
28033 splitting takes priority and happens first.
28034
28035 Because the PLAIN authentication mechanism requires NUL (binary zero) bytes in
28036 the data, further processing is applied to each string before it is sent. If
28037 there are any single circumflex characters in the string, they are converted to
28038 NULs. Should an actual circumflex be required as data, it must be doubled in
28039 the string.
28040
28041 This is an example of a client configuration that implements the PLAIN
28042 authentication mechanism with a fixed user name and password:
28043 .code
28044 fixed_plain:
28045   driver = plaintext
28046   public_name = PLAIN
28047   client_send = ^username^mysecret
28048 .endd
28049 The lack of colons means that the entire text is sent with the AUTH
28050 command, with the circumflex characters converted to NULs.
28051 .new
28052 Note that due to the ambiguity of parsing three consectutive circumflex characters
28053 there is no way to provide a password having a leading circumflex.
28054 .wen
28055
28056
28057 A similar example
28058 that uses the LOGIN mechanism is:
28059 .code
28060 fixed_login:
28061   driver = plaintext
28062   public_name = LOGIN
28063   client_send = : username : mysecret
28064 .endd
28065 The initial colon means that the first string is empty, so no data is sent with
28066 the AUTH command itself. The remaining strings are sent in response to
28067 prompts.
28068 .ecindex IIDplaiauth1
28069 .ecindex IIDplaiauth2
28070
28071
28072
28073
28074 . ////////////////////////////////////////////////////////////////////////////
28075 . ////////////////////////////////////////////////////////////////////////////
28076
28077 .chapter "The cram_md5 authenticator" "CHID9"
28078 .scindex IIDcramauth1 "&(cram_md5)& authenticator"
28079 .scindex IIDcramauth2 "authenticators" "&(cram_md5)&"
28080 .cindex "CRAM-MD5 authentication mechanism"
28081 .cindex authentication CRAM-MD5
28082 The CRAM-MD5 authentication mechanism is described in RFC 2195. The server
28083 sends a challenge string to the client, and the response consists of a user
28084 name and the CRAM-MD5 digest of the challenge string combined with a secret
28085 string (password) which is known to both server and client. Thus, the secret
28086 is not sent over the network as plain text, which makes this authenticator more
28087 secure than &(plaintext)&. However, the downside is that the secret has to be
28088 available in plain text at either end.
28089
28090
28091 .section "Using cram_md5 as a server" "SECID176"
28092 .cindex "options" "&(cram_md5)& authenticator (server)"
28093 This authenticator has one server option, which must be set to configure the
28094 authenticator as a server:
28095
28096 .option server_secret cram_md5 string&!! unset
28097 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(cram_md5)& authenticator"
28098 When the server receives the client's response, the user name is placed in
28099 the expansion variable &$auth1$&, and &%server_secret%& is expanded to
28100 obtain the password for that user. The server then computes the CRAM-MD5 digest
28101 that the client should have sent, and checks that it received the correct
28102 string. If the expansion of &%server_secret%& is forced to fail, authentication
28103 fails. If the expansion fails for some other reason, a temporary error code is
28104 returned to the client.
28105
28106 For compatibility with previous releases of Exim, the user name is also placed
28107 in &$1$&. However, the use of this variables for this purpose is now
28108 deprecated, as it can lead to confusion in string expansions that also use
28109 numeric variables for other things.
28110
28111 For example, the following authenticator checks that the user name given by the
28112 client is &"ph10"&, and if so, uses &"secret"& as the password. For any other
28113 user name, authentication fails.
28114 .code
28115 fixed_cram:
28116   driver = cram_md5
28117   public_name = CRAM-MD5
28118   server_secret = ${if eq{$auth1}{ph10}{secret}fail}
28119   server_set_id = $auth1
28120 .endd
28121 .vindex "&$authenticated_id$&"
28122 If authentication succeeds, the setting of &%server_set_id%& preserves the user
28123 name in &$authenticated_id$&. A more typical configuration might look up the
28124 secret string in a file, using the user name as the key. For example:
28125 .code
28126 lookup_cram:
28127   driver = cram_md5
28128   public_name = CRAM-MD5
28129   server_secret = ${lookup{$auth1}lsearch{/etc/authpwd}\
28130                   {$value}fail}
28131   server_set_id = $auth1
28132 .endd
28133 Note that this expansion explicitly forces failure if the lookup fails
28134 because &$auth1$& contains an unknown user name.
28135
28136 As another example, if you wish to re-use a Cyrus SASL sasldb2 file without
28137 using the relevant libraries, you need to know the realm to specify in the
28138 lookup and then ask for the &"userPassword"& attribute for that user in that
28139 realm, with:
28140 .code
28141 cyrusless_crammd5:
28142   driver = cram_md5
28143   public_name = CRAM-MD5
28144   server_secret = ${lookup{$auth1:mail.example.org:userPassword}\
28145                   dbmjz{/etc/sasldb2}{$value}fail}
28146   server_set_id = $auth1
28147 .endd
28148
28149 .section "Using cram_md5 as a client" "SECID177"
28150 .cindex "options" "&(cram_md5)& authenticator (client)"
28151 When used as a client, the &(cram_md5)& authenticator has two options:
28152
28153
28154
28155 .option client_name cram_md5 string&!! "the primary host name"
28156 This string is expanded, and the result used as the user name data when
28157 computing the response to the server's challenge.
28158
28159
28160 .option client_secret cram_md5 string&!! unset
28161 This option must be set for the authenticator to work as a client. Its value is
28162 expanded and the result used as the secret string when computing the response.
28163
28164
28165 .vindex "&$host$&"
28166 .vindex "&$host_address$&"
28167 Different user names and secrets can be used for different servers by referring
28168 to &$host$& or &$host_address$& in the options. Forced failure of either
28169 expansion string is treated as an indication that this authenticator is not
28170 prepared to handle this case. Exim moves on to the next configured client
28171 authenticator. Any other expansion failure causes Exim to give up trying to
28172 send the message to the current server.
28173
28174 A simple example configuration of a &(cram_md5)& authenticator, using fixed
28175 strings, is:
28176 .code
28177 fixed_cram:
28178   driver = cram_md5
28179   public_name = CRAM-MD5
28180   client_name = ph10
28181   client_secret = secret
28182 .endd
28183 .ecindex IIDcramauth1
28184 .ecindex IIDcramauth2
28185
28186
28187
28188 . ////////////////////////////////////////////////////////////////////////////
28189 . ////////////////////////////////////////////////////////////////////////////
28190
28191 .chapter "The cyrus_sasl authenticator" "CHID10"
28192 .scindex IIDcyrauth1 "&(cyrus_sasl)& authenticator"
28193 .scindex IIDcyrauth2 "authenticators" "&(cyrus_sasl)&"
28194 .cindex "Cyrus" "SASL library"
28195 .cindex "Kerberos"
28196 The code for this authenticator was provided by Matthew Byng-Maddick while
28197 at A L Digital Ltd.
28198
28199 The &(cyrus_sasl)& authenticator provides server support for the Cyrus SASL
28200 library implementation of the RFC 2222 (&"Simple Authentication and Security
28201 Layer"&). This library supports a number of authentication mechanisms,
28202 including PLAIN and LOGIN, but also several others that Exim does not support
28203 directly. In particular, there is support for Kerberos authentication.
28204
28205 The &(cyrus_sasl)& authenticator provides a gatewaying mechanism directly to
28206 the Cyrus interface, so if your Cyrus library can do, for example, CRAM-MD5,
28207 then so can the &(cyrus_sasl)& authenticator. By default it uses the public
28208 name of the driver to determine which mechanism to support.
28209
28210 Where access to some kind of secret file is required, for example, in GSSAPI
28211 or CRAM-MD5, it is worth noting that the authenticator runs as the Exim
28212 user, and that the Cyrus SASL library has no way of escalating privileges
28213 by default. You may also find you need to set environment variables,
28214 depending on the driver you are using.
28215
28216 The application name provided by Exim is &"exim"&, so various SASL options may
28217 be set in &_exim.conf_& in your SASL directory. If you are using GSSAPI for
28218 Kerberos, note that because of limitations in the GSSAPI interface,
28219 changing the server keytab might need to be communicated down to the Kerberos
28220 layer independently. The mechanism for doing so is dependent upon the Kerberos
28221 implementation.
28222
28223 For example, for older releases of Heimdal, the environment variable KRB5_KTNAME
28224 may be set to point to an alternative keytab file. Exim will pass this
28225 variable through from its own inherited environment when started as root or the
28226 Exim user. The keytab file needs to be readable by the Exim user.
28227 With newer releases of Heimdal, a setuid Exim may cause Heimdal to discard the
28228 environment variable.  In practice, for those releases, the Cyrus authenticator
28229 is not a suitable interface for GSSAPI (Kerberos) support.  Instead, consider
28230 the &(heimdal_gssapi)& authenticator, described in chapter &<<CHAPheimdalgss>>&
28231
28232
28233 .section "Using cyrus_sasl as a server" "SECID178"
28234 The &(cyrus_sasl)& authenticator has four private options. It puts the username
28235 (on a successful authentication) into &$auth1$&. For compatibility with
28236 previous releases of Exim, the username is also placed in &$1$&. However, the
28237 use of this variable for this purpose is now deprecated, as it can lead to
28238 confusion in string expansions that also use numeric variables for other
28239 things.
28240
28241
28242 .option server_hostname cyrus_sasl string&!! "see below"
28243 This option selects the hostname that is used when communicating with the
28244 library. The default value is &`$primary_hostname`&. It is up to the underlying
28245 SASL plug-in what it does with this data.
28246
28247
28248 .option server_mech cyrus_sasl string "see below"
28249 This option selects the authentication mechanism this driver should use. The
28250 default is the value of the generic &%public_name%& option. This option allows
28251 you to use a different underlying mechanism from the advertised name. For
28252 example:
28253 .code
28254 sasl:
28255   driver = cyrus_sasl
28256   public_name = X-ANYTHING
28257   server_mech = CRAM-MD5
28258   server_set_id = $auth1
28259 .endd
28260
28261 .option server_realm cyrus_sasl string&!! unset
28262 This specifies the SASL realm that the server claims to be in.
28263
28264
28265 .option server_service cyrus_sasl string &`smtp`&
28266 This is the SASL service that the server claims to implement.
28267
28268
28269 For straightforward cases, you do not need to set any of the authenticator's
28270 private options. All you need to do is to specify an appropriate mechanism as
28271 the public name. Thus, if you have a SASL library that supports CRAM-MD5 and
28272 PLAIN, you could have two authenticators as follows:
28273 .code
28274 sasl_cram_md5:
28275   driver = cyrus_sasl
28276   public_name = CRAM-MD5
28277   server_set_id = $auth1
28278
28279 sasl_plain:
28280   driver = cyrus_sasl
28281   public_name = PLAIN
28282   server_set_id = $auth2
28283 .endd
28284 Cyrus SASL does implement the LOGIN authentication method, even though it is
28285 not a standard method. It is disabled by default in the source distribution,
28286 but it is present in many binary distributions.
28287 .ecindex IIDcyrauth1
28288 .ecindex IIDcyrauth2
28289
28290
28291
28292
28293 . ////////////////////////////////////////////////////////////////////////////
28294 . ////////////////////////////////////////////////////////////////////////////
28295 .chapter "The dovecot authenticator" "CHAPdovecot"
28296 .scindex IIDdcotauth1 "&(dovecot)& authenticator"
28297 .scindex IIDdcotauth2 "authenticators" "&(dovecot)&"
28298 This authenticator is an interface to the authentication facility of the
28299 Dovecot 2 POP/IMAP server, which can support a number of authentication methods.
28300 Note that Dovecot must be configured to use auth-client not auth-userdb.
28301 If you are using Dovecot to authenticate POP/IMAP clients, it might be helpful
28302 to use the same mechanisms for SMTP authentication. This is a server
28303 authenticator only. There is only one option:
28304
28305 .option server_socket dovecot string unset
28306
28307 This option must specify the UNIX socket that is the interface to Dovecot
28308 authentication. The &%public_name%& option must specify an authentication
28309 mechanism that Dovecot is configured to support. You can have several
28310 authenticators for different mechanisms. For example:
28311 .code
28312 dovecot_plain:
28313   driver = dovecot
28314   public_name = PLAIN
28315   server_socket = /var/run/dovecot/auth-client
28316   server_set_id = $auth1
28317
28318 dovecot_ntlm:
28319   driver = dovecot
28320   public_name = NTLM
28321   server_socket = /var/run/dovecot/auth-client
28322   server_set_id = $auth1
28323 .endd
28324 If the SMTP connection is encrypted, or if &$sender_host_address$& is equal to
28325 &$received_ip_address$& (that is, the connection is local), the &"secured"&
28326 option is passed in the Dovecot authentication command. If, for a TLS
28327 connection, a client certificate has been verified, the &"valid-client-cert"&
28328 option is passed. When authentication succeeds, the identity of the user
28329 who authenticated is placed in &$auth1$&.
28330
28331 The Dovecot configuration to match the above will look
28332 something like:
28333 .code
28334 conf.d/10-master.conf :-
28335
28336 service auth {
28337 ...
28338 #SASL
28339   unix_listener auth-client {
28340     mode = 0660
28341     user = mail
28342   }
28343 ...
28344 }
28345
28346 conf.d/10-auth.conf :-
28347
28348 auth_mechanisms = plain login ntlm
28349 .endd
28350
28351 .ecindex IIDdcotauth1
28352 .ecindex IIDdcotauth2
28353
28354
28355 . ////////////////////////////////////////////////////////////////////////////
28356 . ////////////////////////////////////////////////////////////////////////////
28357 .chapter "The gsasl authenticator" "CHAPgsasl"
28358 .scindex IIDgsaslauth1 "&(gsasl)& authenticator"
28359 .scindex IIDgsaslauth2 "authenticators" "&(gsasl)&"
28360 .cindex "authentication" "GNU SASL"
28361 .cindex "authentication" "SASL"
28362 .cindex "authentication" "EXTERNAL"
28363 .cindex "authentication" "ANONYMOUS"
28364 .cindex "authentication" "PLAIN"
28365 .cindex "authentication" "LOGIN"
28366 .cindex "authentication" "DIGEST-MD5"
28367 .cindex "authentication" "CRAM-MD5"
28368 .cindex "authentication" "SCRAM family"
28369 The &(gsasl)& authenticator provides integration for the GNU SASL
28370 library and the mechanisms it provides.  This is new as of the 4.80 release
28371 and there are a few areas where the library does not let Exim smoothly
28372 scale to handle future authentication mechanisms, so no guarantee can be
28373 made that any particular new authentication mechanism will be supported
28374 without code changes in Exim.
28375
28376 The library is expected to add support in an upcoming
28377 realease for the SCRAM-SHA-256 method.
28378 The macro _HAVE_AUTH_GSASL_SCRAM_SHA_256 will be defined
28379 when this happens.
28380
28381 .new
28382 To see the list of mechanisms supported by the library run Exim with "auth" debug
28383 enabled and look for a line containing "GNU SASL supports".
28384 Note however that some may not have been tested from Exim.
28385 .wen
28386
28387
28388 .option client_authz gsasl string&!! unset
28389 This option can be used to supply an &'authorization id'&
28390 which is different to the &'authentication_id'& provided
28391 by &%client_username%& option.
28392 If unset or (after expansion) empty it is not used,
28393 which is the common case.
28394
28395 .option client_channelbinding gsasl boolean false
28396 See &%server_channelbinding%& below.
28397
28398 .option client_password gsasl string&!! unset
28399 This option is exapanded before use, and should result in
28400 the password to be used, in clear.
28401
28402 .option client_username gsasl string&!! unset
28403 This option is exapanded before use, and should result in
28404 the account name to be used.
28405
28406
28407 .option client_spassword gsasl string&!! unset
28408 .new
28409 This option is only supported for library versions 1.9.1 and greater.
28410 The macro _HAVE_AUTH_GSASL_SCRAM_S_KEY will be defined when this is so.
28411 .wen
28412
28413 If a SCRAM mechanism is being used and this option is set
28414 and correctly sized
28415 it is used in preference to &%client_password%&.
28416 The value after expansion should be
28417 a 40 (for SHA-1) or 64 (for SHA-256) character string
28418 with the PBKDF2-prepared password, hex-encoded.
28419
28420 Note that this value will depend on the salt and iteration-count
28421 supplied by the server.
28422 The option is expanded before use.
28423 .new
28424 During the expansion &$auth1$& is set with the client username,
28425 &$auth2$& with the iteration count, and
28426 &$auth3$& with the salt.
28427
28428 The intent of this option
28429 is to support clients that can cache thes salted password
28430 to save on recalculation costs.
28431 The cache lookup should return an unusable value
28432 (eg. an empty string)
28433 if the salt or iteration count has changed
28434
28435 If the authentication succeeds then the above variables are set,
28436 .vindex "&$auth4$&"
28437 plus the calculated salted password value value in &$auth4$&,
28438 during the expansion of the &%client_set_id%& option.
28439 A side-effect of this expansion can be used to prime the cache.
28440 .wen
28441
28442
28443 .option server_channelbinding gsasl boolean false
28444 Some authentication mechanisms are able to use external context at both ends
28445 of the session to bind the authentication to that context, and fail the
28446 authentication process if that context differs.  Specifically, some TLS
28447 ciphersuites can provide identifying information about the cryptographic
28448 context.
28449
28450 This should have meant that certificate identity and verification becomes a
28451 non-issue, as a man-in-the-middle attack will cause the correct client and
28452 server to see different identifiers and authentication will fail.
28453
28454 This is
28455 only usable by mechanisms which support "channel binding"; at time of
28456 writing, that's the SCRAM family.
28457 When using this feature the "-PLUS" variants of the method names need to be used.
28458
28459 This defaults off to ensure smooth upgrade across Exim releases, in case
28460 this option causes some clients to start failing.  Some future release
28461 of Exim might have switched the default to be true.
28462
28463 . However, Channel Binding in TLS has proven to be vulnerable in current versions.
28464 . Do not plan to rely upon this feature for security, ever, without consulting
28465 . with a subject matter expert (a cryptographic engineer).
28466
28467 .new
28468 This option was deprecated in previous releases due to doubts over
28469 the "Triple Handshake" vulnerability.
28470 Exim takes suitable precausions (requiring Extended Master Secret if TLS
28471 Session Resumption was used) for safety.
28472 .wen
28473
28474
28475 .option server_hostname gsasl string&!! "see below"
28476 This option selects the hostname that is used when communicating with the
28477 library. The default value is &`$primary_hostname`&.
28478 Some mechanisms will use this data.
28479
28480
28481 .option server_mech gsasl string "see below"
28482 This option selects the authentication mechanism this driver should use. The
28483 default is the value of the generic &%public_name%& option. This option allows
28484 you to use a different underlying mechanism from the advertised name. For
28485 example:
28486 .code
28487 sasl:
28488   driver = gsasl
28489   public_name = X-ANYTHING
28490   server_mech = CRAM-MD5
28491   server_set_id = $auth1
28492 .endd
28493
28494
28495 .option server_password gsasl string&!! unset
28496 Various mechanisms need access to the cleartext password on the server, so
28497 that proof-of-possession can be demonstrated on the wire, without sending
28498 the password itself.
28499
28500 The data available for lookup varies per mechanism.
28501 In all cases, &$auth1$& is set to the &'authentication id'&.
28502 The &$auth2$& variable will always be the &'authorization id'& (&'authz'&)
28503 if available, else the empty string.
28504 The &$auth3$& variable will always be the &'realm'& if available,
28505 else the empty string.
28506
28507 A forced failure will cause authentication to defer.
28508
28509 If using this option, it may make sense to set the &%server_condition%&
28510 option to be simply "true".
28511
28512
28513 .option server_realm gsasl string&!! unset
28514 This specifies the SASL realm that the server claims to be in.
28515 Some mechanisms will use this data.
28516
28517
28518 .option server_scram_iter gsasl string&!! 4096
28519 This option provides data for the SCRAM family of mechanisms.
28520 The &$auth1$&, &$auth2$& and &$auth3$& variables are available
28521 when this option is expanded.
28522
28523 The result of expansion should be a decimal number,
28524 and represents both a lower-bound on the security, and
28525 a compute cost factor imposed on the client
28526 (if it does not cache results, or the server changes
28527 either the iteration count or the salt).
28528 A minimum value of 4096 is required by the standards
28529 for all current SCRAM mechanism variants.
28530
28531 .option server_scram_salt gsasl string&!! unset
28532 This option provides data for the SCRAM family of mechanisms.
28533 The &$auth1$&, &$auth2$& and &$auth3$& variables are available
28534 when this option is expanded.
28535 The value should be a base64-encoded string,
28536 of random data typically 4-to-16 bytes long.
28537 If unset or empty after expansion the library will provides a value for the
28538 protocol conversation.
28539
28540
28541 .option server_key gsasl string&!! unset
28542 .option server_skey gsasl string&!! unset
28543 These options can be used for the SCRAM family of mechanisms
28544 to provide stored information related to a password,
28545 the storage of which is preferable to plaintext.
28546
28547 &%server_key%& is the value defined in the SCRAM standards as ServerKey;
28548 &%server_skey%& is StoredKey.
28549
28550 They are only available for version 1.9.0 (or later) of the gsasl library.
28551 When this is so, the macros
28552 _OPT_AUTHENTICATOR_GSASL_SERVER_KEY
28553 and _HAVE_AUTH_GSASL_SCRAM_S_KEY
28554 will be defined.
28555
28556 The &$authN$& variables are available when these options are expanded.
28557
28558 If set, the results of expansion should for each
28559 should be a 28 (for SHA-1) or 44 (for SHA-256) character string
28560 of base64-coded data, and will be used in preference to the
28561 &%server_password%& option.
28562 If unset or not of the right length, &%server_password%& will be used.
28563
28564 The libgsasl library release includes a utility &'gsasl'& which can be used
28565 to generate these values.
28566
28567
28568 .option server_service gsasl string &`smtp`&
28569 This is the SASL service that the server claims to implement.
28570 Some mechanisms will use this data.
28571
28572
28573 .section "&(gsasl)& auth variables" "SECTgsaslauthvar"
28574 .vindex "&$auth1$&, &$auth2$&, etc"
28575 These may be set when evaluating specific options, as detailed above.
28576 They will also be set when evaluating &%server_condition%&.
28577
28578 Unless otherwise stated below, the &(gsasl)& integration will use the following
28579 meanings for these variables:
28580
28581 .ilist
28582 .vindex "&$auth1$&"
28583 &$auth1$&: the &'authentication id'&
28584 .next
28585 .vindex "&$auth2$&"
28586 &$auth2$&: the &'authorization id'&
28587 .next
28588 .vindex "&$auth3$&"
28589 &$auth3$&: the &'realm'&
28590 .endlist
28591
28592 On a per-mechanism basis:
28593
28594 .ilist
28595 .cindex "authentication" "EXTERNAL"
28596 EXTERNAL: only &$auth1$& is set, to the possibly empty &'authorization id'&;
28597 the &%server_condition%& option must be present.
28598 .next
28599 .cindex "authentication" "ANONYMOUS"
28600 ANONYMOUS: only &$auth1$& is set, to the possibly empty &'anonymous token'&;
28601 the &%server_condition%& option must be present.
28602 .next
28603 .cindex "authentication" "GSSAPI"
28604 GSSAPI: &$auth1$& will be set to the &'GSSAPI Display Name'&;
28605 &$auth2$& will be set to the &'authorization id'&,
28606 the &%server_condition%& option must be present.
28607 .endlist
28608
28609 An &'anonymous token'& is something passed along as an unauthenticated
28610 identifier; this is analogous to FTP anonymous authentication passing an
28611 email address, or software-identifier@, as the "password".
28612
28613
28614 An example showing the password having the realm specified in the callback
28615 and demonstrating a Cyrus SASL to GSASL migration approach is:
28616 .code
28617 gsasl_cyrusless_crammd5:
28618   driver = gsasl
28619   public_name = CRAM-MD5
28620   server_realm = imap.example.org
28621   server_password = ${lookup{$auth1:$auth3:userPassword}\
28622                     dbmjz{/etc/sasldb2}{$value}fail}
28623   server_set_id = ${quote:$auth1}
28624   server_condition = yes
28625 .endd
28626
28627
28628 . ////////////////////////////////////////////////////////////////////////////
28629 . ////////////////////////////////////////////////////////////////////////////
28630
28631 .chapter "The heimdal_gssapi authenticator" "CHAPheimdalgss"
28632 .scindex IIDheimdalgssauth1 "&(heimdal_gssapi)& authenticator"
28633 .scindex IIDheimdalgssauth2 "authenticators" "&(heimdal_gssapi)&"
28634 .cindex "authentication" "GSSAPI"
28635 .cindex "authentication" "Kerberos"
28636 The &(heimdal_gssapi)& authenticator provides server integration for the
28637 Heimdal GSSAPI/Kerberos library, permitting Exim to set a keytab pathname
28638 reliably.
28639
28640 .option server_hostname heimdal_gssapi string&!! "see below"
28641 This option selects the hostname that is used, with &%server_service%&,
28642 for constructing the GSS server name, as a &'GSS_C_NT_HOSTBASED_SERVICE'&
28643 identifier.  The default value is &`$primary_hostname`&.
28644
28645 .option server_keytab heimdal_gssapi string&!! unset
28646 If set, then Heimdal will not use the system default keytab (typically
28647 &_/etc/krb5.keytab_&) but instead the pathname given in this option.
28648 The value should be a pathname, with no &"file:"& prefix.
28649
28650 .option server_service heimdal_gssapi string&!! "smtp"
28651 This option specifies the service identifier used, in conjunction with
28652 &%server_hostname%&, for building the identifier for finding credentials
28653 from the keytab.
28654
28655
28656 .section "&(heimdal_gssapi)& auth variables" "SECTheimdalgssauthvar"
28657 Beware that these variables will typically include a realm, thus will appear
28658 to be roughly like an email address already.  The &'authzid'& in &$auth2$& is
28659 not verified, so a malicious client can set it to anything.
28660
28661 The &$auth1$& field should be safely trustable as a value from the Key
28662 Distribution Center.  Note that these are not quite email addresses.
28663 Each identifier is for a role, and so the left-hand-side may include a
28664 role suffix.  For instance, &"joe/admin@EXAMPLE.ORG"&.
28665
28666 .vindex "&$auth1$&, &$auth2$&, etc"
28667 .ilist
28668 .vindex "&$auth1$&"
28669 &$auth1$&: the &'authentication id'&, set to the GSS Display Name.
28670 .next
28671 .vindex "&$auth2$&"
28672 &$auth2$&: the &'authorization id'&, sent within SASL encapsulation after
28673 authentication.  If that was empty, this will also be set to the
28674 GSS Display Name.
28675 .endlist
28676
28677
28678 . ////////////////////////////////////////////////////////////////////////////
28679 . ////////////////////////////////////////////////////////////////////////////
28680
28681 .chapter "The spa authenticator" "CHAPspa"
28682 .scindex IIDspaauth1 "&(spa)& authenticator"
28683 .scindex IIDspaauth2 "authenticators" "&(spa)&"
28684 .cindex "authentication" "Microsoft Secure Password"
28685 .cindex "authentication" "NTLM"
28686 .cindex "Microsoft Secure Password Authentication"
28687 .cindex "NTLM authentication"
28688 The &(spa)& authenticator provides client support for Microsoft's &'Secure
28689 Password Authentication'& mechanism,
28690 which is also sometimes known as NTLM (NT LanMan). The code for client side of
28691 this authenticator was contributed by Marc Prud'hommeaux, and much of it is
28692 taken from the Samba project (&url(https://www.samba.org/)). The code for the
28693 server side was subsequently contributed by Tom Kistner. The mechanism works as
28694 follows:
28695
28696 .ilist
28697 After the AUTH command has been accepted, the client sends an SPA
28698 authentication request based on the user name and optional domain.
28699 .next
28700 The server sends back a challenge.
28701 .next
28702 The client builds a challenge response which makes use of the user's password
28703 and sends it to the server, which then accepts or rejects it.
28704 .endlist
28705
28706 Encryption is used to protect the password in transit.
28707
28708
28709
28710 .section "Using spa as a server" "SECID179"
28711 .cindex "options" "&(spa)& authenticator (server)"
28712 The &(spa)& authenticator has just one server option:
28713
28714 .option server_password spa string&!! unset
28715 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(spa)& authenticator"
28716 This option is expanded, and the result must be the cleartext password for the
28717 authenticating user, whose name is at this point in &$auth1$&. For
28718 compatibility with previous releases of Exim, the user name is also placed in
28719 &$1$&. However, the use of this variable for this purpose is now deprecated, as
28720 it can lead to confusion in string expansions that also use numeric variables
28721 for other things. For example:
28722 .code
28723 spa:
28724   driver = spa
28725   public_name = NTLM
28726   server_password = \
28727     ${lookup{$auth1}lsearch{/etc/exim/spa_clearpass}{$value}fail}
28728 .endd
28729 If the expansion is forced to fail, authentication fails. Any other expansion
28730 failure causes a temporary error code to be returned.
28731
28732
28733
28734
28735
28736 .section "Using spa as a client" "SECID180"
28737 .cindex "options" "&(spa)& authenticator (client)"
28738 The &(spa)& authenticator has the following client options:
28739
28740
28741
28742 .option client_domain spa string&!! unset
28743 This option specifies an optional domain for the authentication.
28744
28745
28746 .option client_password spa string&!! unset
28747 This option specifies the user's password, and must be set.
28748
28749
28750 .option client_username spa string&!! unset
28751 This option specifies the user name, and must be set. Here is an example of a
28752 configuration of this authenticator for use with the mail servers at
28753 &'msn.com'&:
28754 .code
28755 msn:
28756   driver = spa
28757   public_name = MSN
28758   client_username = msn/msn_username
28759   client_password = msn_plaintext_password
28760   client_domain = DOMAIN_OR_UNSET
28761 .endd
28762 .ecindex IIDspaauth1
28763 .ecindex IIDspaauth2
28764
28765
28766
28767
28768
28769 . ////////////////////////////////////////////////////////////////////////////
28770 . ////////////////////////////////////////////////////////////////////////////
28771
28772 .chapter "The external authenticator" "CHAPexternauth"
28773 .scindex IIDexternauth1 "&(external)& authenticator"
28774 .scindex IIDexternauth2 "authenticators" "&(external)&"
28775 .cindex "authentication" "Client Certificate"
28776 .cindex "authentication" "X509"
28777 .cindex "Certificate-based authentication"
28778 The &(external)& authenticator provides support for
28779 authentication based on non-SMTP information.
28780 The specification is in RFC 4422 Appendix A
28781 (&url(https://tools.ietf.org/html/rfc4422)).
28782 It is only a transport and negotiation mechanism;
28783 the process of authentication is entirely controlled
28784 by the server configuration.
28785
28786 The client presents an identity in-clear.
28787 It is probably wise for a server to only advertise,
28788 and for clients to only attempt,
28789 this authentication method on a secure (eg. under TLS) connection.
28790
28791 One possible use, compatible with the
28792 K-9 Mail Android client (&url(https://k9mail.github.io/)),
28793 is for using X509 client certificates.
28794
28795 It thus overlaps in function with the TLS authenticator
28796 (see &<<CHAPtlsauth>>&)
28797 but is a full SMTP SASL authenticator
28798 rather than being implicit for TLS-connection carried
28799 client certificates only.
28800
28801 The examples and discussion in this chapter assume that
28802 client-certificate authentication is being done.
28803
28804 The client must present a certificate,
28805 for which it must have been requested via the
28806 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& main options
28807 (see &<<CHAPTLS>>&).
28808 For authentication to be effective the certificate should be
28809 verifiable against a trust-anchor certificate known to the server.
28810
28811 .section "External options" "SECTexternsoptions"
28812 .cindex "options" "&(external)& authenticator (server)"
28813 The &(external)& authenticator has two server options:
28814
28815 .option server_param2 external string&!! unset
28816 .option server_param3 external string&!! unset
28817 .cindex "variables (&$auth1$& &$auth2$& etc)" "in &(external)& authenticator"
28818 These options are expanded before the &%server_condition%& option
28819 and the result are placed in &$auth2$& and &$auth3$& resectively.
28820 If the expansion is forced to fail, authentication fails. Any other expansion
28821 failure causes a temporary error code to be returned.
28822
28823 They can be used to clarify the coding of a complex &%server_condition%&.
28824
28825 .section "Using external in a server" "SECTexternserver"
28826 .cindex "AUTH" "in &(external)& authenticator"
28827 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
28828         "in &(external)& authenticator"
28829 .vindex "&$auth1$&, &$auth2$&, etc"
28830 .cindex "base64 encoding" "in &(external)& authenticator"
28831
28832 When running as a server, &(external)& performs the authentication test by
28833 expanding a string. The data sent by the client with the AUTH command, or in
28834 response to subsequent prompts, is base64 encoded, and so may contain any byte
28835 values when decoded. The decoded value is treated as
28836 an identity for authentication and
28837 placed in the expansion variable &$auth1$&.
28838
28839 For compatibility with previous releases of Exim, the value is also placed in
28840 the expansion variable &$1$&. However, the use of this
28841 variable for this purpose is now deprecated, as it can lead to confusion in
28842 string expansions that also use them for other things.
28843
28844 .vindex "&$authenticated_id$&"
28845 Once an identity has been received,
28846 &%server_condition%& is expanded. If the expansion is forced to fail,
28847 authentication fails. Any other expansion failure causes a temporary error code
28848 to be returned. If the result of a successful expansion is an empty string,
28849 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
28850 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
28851 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
28852 For any other result, a temporary error code is returned, with the expanded
28853 string as the error text.
28854
28855 Example:
28856 .code
28857 ext_ccert_san_mail:
28858   driver =            external
28859   public_name =       EXTERNAL
28860
28861   server_advertise_condition = $tls_in_certificate_verified
28862   server_param2 =     ${certextract {subj_altname,mail,>:} \
28863                                     {$tls_in_peercert}}
28864   server_condition =  ${if forany {$auth2} \
28865                             {eq {$item}{$auth1}}}
28866   server_set_id =     $auth1
28867 .endd
28868 This accepts a client certificate that is verifiable against any
28869 of your configured trust-anchors
28870 (which usually means the full set of public CAs)
28871 and which has a mail-SAN matching the claimed identity sent by the client.
28872
28873 &*Note*&: up to TLS1.2, the client cert is on the wire in-clear, including the SAN.
28874 The account name is therefore guessable by an opponent.
28875 TLS 1.3 protects both server and client certificates, and is not vulnerable
28876 in this way.
28877
28878
28879 .section "Using external in a client" "SECTexternclient"
28880 .cindex "options" "&(external)& authenticator (client)"
28881 The &(external)& authenticator has one client option:
28882
28883 .option client_send external string&!! unset
28884 This option is expanded and sent with the AUTH command as the
28885 identity being asserted.
28886
28887 Example:
28888 .code
28889 ext_ccert:
28890   driver =      external
28891   public_name = EXTERNAL
28892
28893   client_condition = ${if !eq{$tls_out_cipher}{}}
28894   client_send = myaccount@smarthost.example.net
28895 .endd
28896
28897
28898 .ecindex IIDexternauth1
28899 .ecindex IIDexternauth2
28900
28901
28902
28903
28904
28905 . ////////////////////////////////////////////////////////////////////////////
28906 . ////////////////////////////////////////////////////////////////////////////
28907
28908 .chapter "The tls authenticator" "CHAPtlsauth"
28909 .scindex IIDtlsauth1 "&(tls)& authenticator"
28910 .scindex IIDtlsauth2 "authenticators" "&(tls)&"
28911 .cindex "authentication" "Client Certificate"
28912 .cindex "authentication" "X509"
28913 .cindex "Certificate-based authentication"
28914 The &(tls)& authenticator provides server support for
28915 authentication based on client certificates.
28916
28917 It is not an SMTP authentication mechanism and is not
28918 advertised by the server as part of the SMTP EHLO response.
28919 It is an Exim authenticator in the sense that it affects
28920 the protocol element of the log line, can be tested for
28921 by the &%authenticated%& ACL condition, and can set
28922 the &$authenticated_id$& variable.
28923
28924 The client must present a verifiable certificate,
28925 for which it must have been requested via the
28926 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& main options
28927 (see &<<CHAPTLS>>&).
28928
28929 If an authenticator of this type is configured it is
28930 run before any SMTP-level communication is done,
28931 and can authenticate the connection.
28932 If it does, SMTP authentication is not offered.
28933
28934 A maximum of one authenticator of this type may be present.
28935
28936
28937 .cindex "options" "&(tls)& authenticator (server)"
28938 The &(tls)& authenticator has three server options:
28939
28940 .option server_param1 tls string&!! unset
28941 .cindex "variables (&$auth1$& &$auth2$& etc)" "in &(tls)& authenticator"
28942 This option is expanded after the TLS negotiation and
28943 the result is placed in &$auth1$&.
28944 If the expansion is forced to fail, authentication fails. Any other expansion
28945 failure causes a temporary error code to be returned.
28946
28947 .option server_param2 tls string&!! unset
28948 .option server_param3 tls string&!! unset
28949 As above, for &$auth2$& and &$auth3$&.
28950
28951 &%server_param1%& may also be spelled &%server_param%&.
28952
28953
28954 Example:
28955 .code
28956 tls:
28957   driver = tls
28958   server_param1 =     ${certextract {subj_altname,mail,>:} \
28959                                     {$tls_in_peercert}}
28960   server_condition =  ${if and { {eq{$tls_in_certificate_verified}{1}} \
28961                                  {forany {$auth1} \
28962                             {!= {0} \
28963                                 {${lookup ldap{ldap:///\
28964                          mailname=${quote_ldap_dn:${lc:$item}},\
28965                          ou=users,LDAP_DC?mailid} {$value}{0} \
28966                        }    }  } }}}
28967   server_set_id =     ${if = {1}{${listcount:$auth1}} {$auth1}{}}
28968 .endd
28969 This accepts a client certificate that is verifiable against any
28970 of your configured trust-anchors
28971 (which usually means the full set of public CAs)
28972 and which has a SAN with a good account name.
28973
28974 Note that, up to TLS1.2, the client cert is on the wire in-clear, including the SAN,
28975 The account name is therefore guessable by an opponent.
28976 TLS 1.3 protects both server and client certificates, and is not vulnerable
28977 in this way.
28978 Likewise, a traditional plaintext SMTP AUTH done inside TLS is not.
28979
28980 . An alternative might use
28981 . .code
28982 .   server_param1 = ${sha256:$tls_in_peercert}
28983 . .endd
28984 . to require one of a set of specific certs that define a given account
28985 . (the verification is still required, but mostly irrelevant).
28986 . This would help for per-device use.
28987 .
28988 . However, for the future we really need support for checking a
28989 . user cert in LDAP - which probably wants a base-64 DER.
28990
28991 .ecindex IIDtlsauth1
28992 .ecindex IIDtlsauth2
28993
28994
28995 Note that because authentication is traditionally an SMTP operation,
28996 the &%authenticated%& ACL condition cannot be used in
28997 a connect- or helo-ACL.
28998
28999
29000
29001 . ////////////////////////////////////////////////////////////////////////////
29002 . ////////////////////////////////////////////////////////////////////////////
29003
29004 .chapter "Encrypted SMTP connections using TLS/SSL" "CHAPTLS" &&&
29005          "Encrypted SMTP connections"
29006 .scindex IIDencsmtp1 "encryption" "on SMTP connection"
29007 .scindex IIDencsmtp2 "SMTP" "encryption"
29008 .cindex "TLS" "on SMTP connection"
29009 .cindex "OpenSSL"
29010 .cindex "GnuTLS"
29011 Support for TLS (Transport Layer Security), formerly known as SSL (Secure
29012 Sockets Layer), is implemented by making use of the OpenSSL library or the
29013 GnuTLS library (Exim requires GnuTLS release 1.0 or later). There is no
29014 cryptographic code in the Exim distribution itself for implementing TLS. In
29015 order to use this feature you must install OpenSSL or GnuTLS, and then build a
29016 version of Exim that includes TLS support (see section &<<SECTinctlsssl>>&).
29017 You also need to understand the basic concepts of encryption at a managerial
29018 level, and in particular, the way that public keys, private keys, and
29019 certificates are used.
29020
29021 RFC 3207 defines how SMTP connections can make use of encryption. Once a
29022 connection is established, the client issues a STARTTLS command. If the
29023 server accepts this, the client and the server negotiate an encryption
29024 mechanism. If the negotiation succeeds, the data that subsequently passes
29025 between them is encrypted.
29026
29027 Exim's ACLs can detect whether the current SMTP session is encrypted or not,
29028 and if so, what cipher suite is in use, whether the client supplied a
29029 certificate, and whether or not that certificate was verified. This makes it
29030 possible for an Exim server to deny or accept certain commands based on the
29031 encryption state.
29032
29033 &*Warning*&: Certain types of firewall and certain anti-virus products can
29034 disrupt TLS connections. You need to turn off SMTP scanning for these products
29035 in order to get TLS to work.
29036
29037
29038
29039 .section "Support for the &""submissions""& (aka &""ssmtp""& and &""smtps""&) protocol" &&&
29040          "SECID284"
29041 .cindex "submissions protocol"
29042 .cindex "ssmtp protocol"
29043 .cindex "smtps protocol"
29044 .cindex "SMTP" "submissions protocol"
29045 .cindex "SMTP" "ssmtp protocol"
29046 .cindex "SMTP" "smtps protocol"
29047 The history of port numbers for TLS in SMTP is a little messy and has been
29048 contentious.  As of RFC 8314, the common practice of using the historically
29049 allocated port 465 for "email submission but with TLS immediately upon connect
29050 instead of using STARTTLS" is officially blessed by the IETF, and recommended
29051 by them in preference to STARTTLS.
29052
29053 The name originally assigned to the port was &"ssmtp"& or &"smtps"&, but as
29054 clarity emerged over the dual roles of SMTP, for MX delivery and Email
29055 Submission, nomenclature has shifted.  The modern name is now &"submissions"&.
29056
29057 This approach was, for a while, officially abandoned when encrypted SMTP was
29058 standardized, but many clients kept using it, even as the TCP port number was
29059 reassigned for other use.
29060 Thus you may encounter guidance claiming that you shouldn't enable use of
29061 this port.
29062 In practice, a number of mail-clients have only ever supported submissions,
29063 not submission with STARTTLS upgrade.
29064 Ideally, offer both submission (587) and submissions (465) service.
29065
29066 Exim supports TLS-on-connect by means of the &%tls_on_connect_ports%&
29067 global option. Its value must be a list of port numbers;
29068 the most common use is expected to be:
29069 .code
29070 tls_on_connect_ports = 465
29071 .endd
29072 The port numbers specified by this option apply to all SMTP connections, both
29073 via the daemon and via &'inetd'&. You still need to specify all the ports that
29074 the daemon uses (by setting &%daemon_smtp_ports%& or &%local_interfaces%& or
29075 the &%-oX%& command line option) because &%tls_on_connect_ports%& does not add
29076 an extra port &-- rather, it specifies different behaviour on a port that is
29077 defined elsewhere.
29078
29079 There is also a &%-tls-on-connect%& command line option. This overrides
29080 &%tls_on_connect_ports%&; it forces the TLS-only behaviour for all ports.
29081
29082
29083
29084
29085
29086
29087 .section "OpenSSL vs GnuTLS" "SECTopenvsgnu"
29088 .cindex "TLS" "OpenSSL &'vs'& GnuTLS"
29089 TLS is supported in Exim using either the OpenSSL or GnuTLS library.
29090 To build Exim to use OpenSSL you need to set
29091 .code
29092 USE_OPENSSL=yes
29093 .endd
29094 in Local/Makefile.
29095
29096 To build Exim to use GnuTLS, you need to set
29097 .code
29098 USE_GNUTLS=yes
29099 .endd
29100 in Local/Makefile.
29101
29102 You must also set TLS_LIBS and TLS_INCLUDE appropriately, so that the
29103 include files and libraries for GnuTLS can be found.
29104
29105 There are some differences in usage when using GnuTLS instead of OpenSSL:
29106
29107 .ilist
29108 The &%tls_verify_certificates%& option
29109 cannot be the path of a directory
29110 for GnuTLS versions before 3.3.6
29111 (for later versions, or OpenSSL, it can be either).
29112 .next
29113 The default value for &%tls_dhparam%& differs for historical reasons.
29114 .next
29115 .vindex "&$tls_in_peerdn$&"
29116 .vindex "&$tls_out_peerdn$&"
29117 Distinguished Name (DN) strings reported by the OpenSSL library use a slash for
29118 separating fields; GnuTLS uses commas, in accordance with RFC 2253. This
29119 affects the value of the &$tls_in_peerdn$& and &$tls_out_peerdn$& variables.
29120 .next
29121 OpenSSL identifies cipher suites using hyphens as separators, for example:
29122 DES-CBC3-SHA. GnuTLS historically used underscores, for example:
29123 RSA_ARCFOUR_SHA. What is more, OpenSSL complains if underscores are present
29124 in a cipher list. To make life simpler, Exim changes underscores to hyphens
29125 for OpenSSL and passes the string unchanged to GnuTLS (expecting the library
29126 to handle its own older variants) when processing lists of cipher suites in the
29127 &%tls_require_ciphers%& options (the global option and the &(smtp)& transport
29128 option).
29129 .next
29130 The &%tls_require_ciphers%& options operate differently, as described in the
29131 sections &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
29132 .next
29133 The &%tls_dh_min_bits%& SMTP transport option is only honoured by GnuTLS.
29134 When using OpenSSL, this option is ignored.
29135 (If an API is found to let OpenSSL be configured in this way,
29136 let the Exim Maintainers know and we'll likely use it).
29137 .next
29138 With GnuTLS, if an explicit list is used for the &%tls_privatekey%& main option
29139 main option, it must be ordered to match the &%tls_certificate%& list.
29140 .next
29141 Some other recently added features may only be available in one or the other.
29142 This should be documented with the feature.  If the documentation does not
29143 explicitly state that the feature is infeasible in the other TLS
29144 implementation, then patches are welcome.
29145 .new
29146 .next
29147 The output from "exim -bV" will show which (if any) support was included
29148 in the build.
29149 Also, the macro "_HAVE_OPENSSL" or "_HAVE_GNUTLS" will be defined.
29150 .wen
29151 .endlist
29152
29153
29154 .section "GnuTLS parameter computation" "SECTgnutlsparam"
29155 This section only applies if &%tls_dhparam%& is set to &`historic`& or to
29156 an explicit path; if the latter, then the text about generation still applies,
29157 but not the chosen filename.
29158 By default, as of Exim 4.80 a hard-coded D-H prime is used.
29159 See the documentation of &%tls_dhparam%& for more information.
29160
29161 GnuTLS uses D-H parameters that may take a substantial amount of time
29162 to compute. It is unreasonable to re-compute them for every TLS session.
29163 Therefore, Exim keeps this data in a file in its spool directory, called
29164 &_gnutls-params-NNNN_& for some value of NNNN, corresponding to the number
29165 of bits requested.
29166 The file is owned by the Exim user and is readable only by
29167 its owner. Every Exim process that start up GnuTLS reads the D-H
29168 parameters from this file. If the file does not exist, the first Exim process
29169 that needs it computes the data and writes it to a temporary file which is
29170 renamed once it is complete. It does not matter if several Exim processes do
29171 this simultaneously (apart from wasting a few resources). Once a file is in
29172 place, new Exim processes immediately start using it.
29173
29174 For maximum security, the parameters that are stored in this file should be
29175 recalculated periodically, the frequency depending on your paranoia level.
29176 If you are avoiding using the fixed D-H primes published in RFCs, then you
29177 are concerned about some advanced attacks and will wish to do this; if you do
29178 not regenerate then you might as well stick to the standard primes.
29179
29180 Arranging this is easy in principle; just delete the file when you want new
29181 values to be computed. However, there may be a problem. The calculation of new
29182 parameters needs random numbers, and these are obtained from &_/dev/random_&.
29183 If the system is not very active, &_/dev/random_& may delay returning data
29184 until enough randomness (entropy) is available. This may cause Exim to hang for
29185 a substantial amount of time, causing timeouts on incoming connections.
29186
29187 The solution is to generate the parameters externally to Exim. They are stored
29188 in &_gnutls-params-N_& in PEM format, which means that they can be
29189 generated externally using the &(certtool)& command that is part of GnuTLS.
29190
29191 To replace the parameters with new ones, instead of deleting the file
29192 and letting Exim re-create it, you can generate new parameters using
29193 &(certtool)& and, when this has been done, replace Exim's cache file by
29194 renaming. The relevant commands are something like this:
29195 .code
29196 # ls
29197 [ look for file; assume gnutls-params-2236 is the most recent ]
29198 # rm -f new-params
29199 # touch new-params
29200 # chown exim:exim new-params
29201 # chmod 0600 new-params
29202 # certtool --generate-dh-params --bits 2236 >>new-params
29203 # openssl dhparam -noout -text -in new-params | head
29204 [ check the first line, make sure it's not more than 2236;
29205   if it is, then go back to the start ("rm") and repeat
29206   until the size generated is at most the size requested ]
29207 # chmod 0400 new-params
29208 # mv new-params gnutls-params-2236
29209 .endd
29210 If Exim never has to generate the parameters itself, the possibility of
29211 stalling is removed.
29212
29213 The filename changed in Exim 4.80, to gain the -bits suffix.  The value which
29214 Exim will choose depends upon the version of GnuTLS in use.  For older GnuTLS,
29215 the value remains hard-coded in Exim as 1024.  As of GnuTLS 2.12.x, there is
29216 a way for Exim to ask for the "normal" number of bits for D-H public-key usage,
29217 and Exim does so.  This attempt to remove Exim from TLS policy decisions
29218 failed, as GnuTLS 2.12 returns a value higher than the current hard-coded limit
29219 of the NSS library.  Thus Exim gains the &%tls_dh_max_bits%& global option,
29220 which applies to all D-H usage, client or server.  If the value returned by
29221 GnuTLS is greater than &%tls_dh_max_bits%& then the value will be clamped down
29222 to &%tls_dh_max_bits%&.  The default value has been set at the current NSS
29223 limit, which is still much higher than Exim historically used.
29224
29225 The filename and bits used will change as the GnuTLS maintainers change the
29226 value for their parameter &`GNUTLS_SEC_PARAM_NORMAL`&, as clamped by
29227 &%tls_dh_max_bits%&.  At the time of writing (mid 2012), GnuTLS 2.12 recommends
29228 2432 bits, while NSS is limited to 2236 bits.
29229
29230 In fact, the requested value will be *lower* than &%tls_dh_max_bits%&, to
29231 increase the chance of the generated prime actually being within acceptable
29232 bounds, as GnuTLS has been observed to overshoot.  Note the check step in the
29233 procedure above.  There is no sane procedure available to Exim to double-check
29234 the size of the generated prime, so it might still be too large.
29235
29236
29237 .section "Requiring specific ciphers in OpenSSL" "SECTreqciphssl"
29238 .cindex "TLS" "requiring specific ciphers (OpenSSL)"
29239 .oindex "&%tls_require_ciphers%&" "OpenSSL"
29240 There is a function in the OpenSSL library that can be passed a list of cipher
29241 suites before the cipher negotiation takes place. This specifies which ciphers
29242 are acceptable for TLS versions prior to 1.3.
29243 The list is colon separated and may contain names like
29244 DES-CBC3-SHA. Exim passes the expanded value of &%tls_require_ciphers%&
29245 directly to this function call.
29246 Many systems will install the OpenSSL manual-pages, so you may have
29247 &'ciphers(1)'& available to you.
29248 The following quotation from the OpenSSL
29249 documentation specifies what forms of item are allowed in the cipher string:
29250
29251 .ilist
29252 It can consist of a single cipher suite such as RC4-SHA.
29253 .next
29254 It can represent a list of cipher suites containing a certain algorithm,
29255 or cipher suites of a certain type. For example SHA1 represents all
29256 ciphers suites using the digest algorithm SHA1 and SSLv3 represents all
29257 SSL v3 algorithms.
29258 .next
29259 Lists of cipher suites can be combined in a single cipher string using
29260 the + character. This is used as a logical and operation. For example
29261 SHA1+DES represents all cipher suites containing the SHA1 and the DES
29262 algorithms.
29263 .endlist
29264
29265 Each cipher string can be optionally preceded by one of the characters &`!`&,
29266 &`-`& or &`+`&.
29267 .ilist
29268 If &`!`& is used, the ciphers are permanently deleted from the list. The
29269 ciphers deleted can never reappear in the list even if they are explicitly
29270 stated.
29271 .next
29272 If &`-`& is used, the ciphers are deleted from the list, but some or all
29273 of the ciphers can be added again by later options.
29274 .next
29275 If &`+`& is used, the ciphers are moved to the end of the list. This
29276 option does not add any new ciphers; it just moves matching existing ones.
29277 .endlist
29278
29279 If none of these characters is present, the string is interpreted as
29280 a list of ciphers to be appended to the current preference list. If the list
29281 includes any ciphers already present they will be ignored: that is, they will
29282 not be moved to the end of the list.
29283 .endlist
29284
29285 The OpenSSL &'ciphers(1)'& command may be used to test the results of a given
29286 string:
29287 .code
29288 # note single-quotes to get ! past any shell history expansion
29289 $ openssl ciphers 'HIGH:!MD5:!SHA1'
29290 .endd
29291
29292 This example will let the library defaults be permitted on the MX port, where
29293 there's probably no identity verification anyway, but ups the ante on the
29294 submission ports where the administrator might have some influence on the
29295 choice of clients used:
29296 .code
29297 # OpenSSL variant; see man ciphers(1)
29298 tls_require_ciphers = ${if =={$received_port}{25}\
29299                            {DEFAULT}\
29300                            {HIGH:!MD5:!SHA1}}
29301 .endd
29302
29303 This example will prefer ECDSA-authenticated ciphers over RSA ones:
29304 .code
29305 tls_require_ciphers = ECDSA:RSA:!COMPLEMENTOFDEFAULT
29306 .endd
29307
29308 For TLS version 1.3 the control available is less fine-grained
29309 and Exim does not provide access to it at present.
29310 The value of the &%tls_require_ciphers%& option is ignored when
29311 TLS version 1.3 is negotiated.
29312
29313 As of writing the library default cipher suite list for TLSv1.3 is
29314 .code
29315 TLS_AES_256_GCM_SHA384:TLS_CHACHA20_POLY1305_SHA256:TLS_AES_128_GCM_SHA256
29316 .endd
29317
29318
29319 .section "Requiring specific ciphers or other parameters in GnuTLS" &&&
29320          "SECTreqciphgnu"
29321 .cindex "GnuTLS" "specifying parameters for"
29322 .cindex "TLS" "specifying ciphers (GnuTLS)"
29323 .cindex "TLS" "specifying key exchange methods (GnuTLS)"
29324 .cindex "TLS" "specifying MAC algorithms (GnuTLS)"
29325 .cindex "TLS" "specifying protocols (GnuTLS)"
29326 .cindex "TLS" "specifying priority string (GnuTLS)"
29327 .oindex "&%tls_require_ciphers%&" "GnuTLS"
29328 The GnuTLS library allows the caller to provide a "priority string", documented
29329 as part of the &[gnutls_priority_init]& function.  This is very similar to the
29330 ciphersuite specification in OpenSSL.
29331
29332 The &%tls_require_ciphers%& option is treated as the GnuTLS priority string
29333 and controls both protocols and ciphers.
29334
29335 The &%tls_require_ciphers%& option is available both as an global option,
29336 controlling how Exim behaves as a server, and also as an option of the
29337 &(smtp)& transport, controlling how Exim behaves as a client.  In both cases
29338 the value is string expanded.  The resulting string is not an Exim list and
29339 the string is given to the GnuTLS library, so that Exim does not need to be
29340 aware of future feature enhancements of GnuTLS.
29341
29342 Documentation of the strings accepted may be found in the GnuTLS manual, under
29343 "Priority strings".  This is online as
29344 &url(https://www.gnutls.org/manual/html_node/Priority-Strings.html),
29345 but beware that this relates to GnuTLS 3, which may be newer than the version
29346 installed on your system.  If you are using GnuTLS 3,
29347 then the example code
29348 &url(https://www.gnutls.org/manual/gnutls.html#Listing-the-ciphersuites-in-a-priority-string)
29349 on that site can be used to test a given string.
29350
29351 For example:
29352 .code
29353 # Disable older versions of protocols
29354 tls_require_ciphers = NORMAL:%LATEST_RECORD_VERSION:-VERS-SSL3.0
29355 .endd
29356
29357 Prior to Exim 4.80, an older API of GnuTLS was used, and Exim supported three
29358 additional options, "&%gnutls_require_kx%&", "&%gnutls_require_mac%&" and
29359 "&%gnutls_require_protocols%&".  &%tls_require_ciphers%& was an Exim list.
29360
29361 This example will let the library defaults be permitted on the MX port, where
29362 there's probably no identity verification anyway, and lowers security further
29363 by increasing compatibility; but this ups the ante on the submission ports
29364 where the administrator might have some influence on the choice of clients
29365 used:
29366 .code
29367 # GnuTLS variant
29368 tls_require_ciphers = ${if =={$received_port}{25}\
29369                            {NORMAL:%COMPAT}\
29370                            {SECURE128}}
29371 .endd
29372
29373
29374 .section "Configuring an Exim server to use TLS" "SECID182"
29375 .cindex "TLS" "configuring an Exim server"
29376 .cindex "ESMTP extensions" STARTTLS
29377 When Exim has been built with TLS support, it advertises the availability of
29378 the STARTTLS command to client hosts that match &%tls_advertise_hosts%&,
29379 but not to any others. The default value of this option is *, which means
29380 that STARTTLS is always advertised.  Set it to blank to never advertise;
29381 this is reasonable for systems that want to use TLS only as a client.
29382
29383 If STARTTLS is to be used you
29384 need to set some other options in order to make TLS available.
29385
29386 If a client issues a STARTTLS command and there is some configuration
29387 problem in the server, the command is rejected with a 454 error. If the client
29388 persists in trying to issue SMTP commands, all except QUIT are rejected
29389 with the error
29390 .code
29391 554 Security failure
29392 .endd
29393 If a STARTTLS command is issued within an existing TLS session, it is
29394 rejected with a 554 error code.
29395
29396 To enable TLS operations on a server, the &%tls_advertise_hosts%& option
29397 must be set to match some hosts. The default is * which matches all hosts.
29398
29399 If this is all you do, TLS encryption will be enabled but not authentication -
29400 meaning that the peer has no assurance it is actually you he is talking to.
29401 You gain protection from a passive sniffer listening on the wire but not
29402 from someone able to intercept the communication.
29403
29404 Further protection requires some further configuration at the server end.
29405
29406 To make TLS work you need to set, in the server,
29407 .code
29408 tls_certificate = /some/file/name
29409 tls_privatekey = /some/file/name
29410 .endd
29411 These options are, in fact, expanded strings, so you can make them depend on
29412 the identity of the client that is connected if you wish. The first file
29413 contains the server's X509 certificate, and the second contains the private key
29414 that goes with it. These files need to be
29415 PEM format and readable by the Exim user, and must
29416 always be given as full path names.
29417 The key must not be password-protected.
29418 They can be the same file if both the
29419 certificate and the key are contained within it. If &%tls_privatekey%& is not
29420 set, or if its expansion is forced to fail or results in an empty string, this
29421 is assumed to be the case. The certificate file may also contain intermediate
29422 certificates that need to be sent to the client to enable it to authenticate
29423 the server's certificate.
29424
29425 For dual-stack (eg. RSA and ECDSA) configurations, these options can be
29426 colon-separated lists of file paths.  Ciphers using given authentication
29427 algorithms require the presence of a suitable certificate to supply the
29428 public-key.  The server selects among the certificates to present to the
29429 client depending on the selected cipher, hence the priority ordering for
29430 ciphers will affect which certificate is used.
29431
29432 If you do not understand about certificates and keys, please try to find a
29433 source of this background information, which is not Exim-specific. (There are a
29434 few comments below in section &<<SECTcerandall>>&.)
29435
29436 &*Note*&: These options do not apply when Exim is operating as a client &--
29437 they apply only in the case of a server. If you need to use a certificate in an
29438 Exim client, you must set the options of the same names in an &(smtp)&
29439 transport.
29440
29441 With just these options, an Exim server will be able to use TLS. It does not
29442 require the client to have a certificate (but see below for how to insist on
29443 this). There is one other option that may be needed in other situations. If
29444 .code
29445 tls_dhparam = /some/file/name
29446 .endd
29447 is set, the SSL library is initialized for the use of Diffie-Hellman ciphers
29448 with the parameters contained in the file.
29449 Set this to &`none`& to disable use of DH entirely, by making no prime
29450 available:
29451 .code
29452 tls_dhparam = none
29453 .endd
29454 This may also be set to a string identifying a standard prime to be used for
29455 DH; if it is set to &`default`& or, for OpenSSL, is unset, then the prime
29456 used is &`ike23`&.  There are a few standard primes available, see the
29457 documentation for &%tls_dhparam%& for the complete list.
29458
29459 See the command
29460 .code
29461 openssl dhparam
29462 .endd
29463 for a way of generating file data.
29464
29465 The strings supplied for these three options are expanded every time a client
29466 host connects. It is therefore possible to use different certificates and keys
29467 for different hosts, if you so wish, by making use of the client's IP address
29468 in &$sender_host_address$& to control the expansion. If a string expansion is
29469 forced to fail, Exim behaves as if the option is not set.
29470
29471 .cindex "cipher" "logging"
29472 .cindex "log" "TLS cipher"
29473 .vindex "&$tls_in_cipher$&"
29474 The variable &$tls_in_cipher$& is set to the cipher suite that was negotiated for
29475 an incoming TLS connection. It is included in the &'Received:'& header of an
29476 incoming message (by default &-- you can, of course, change this), and it is
29477 also included in the log line that records a message's arrival, keyed by
29478 &"X="&, unless the &%tls_cipher%& log selector is turned off. The &%encrypted%&
29479 condition can be used to test for specific cipher suites in ACLs.
29480
29481 Once TLS has been established, the ACLs that run for subsequent SMTP commands
29482 can check the name of the cipher suite and vary their actions accordingly. The
29483 cipher suite names vary, depending on which TLS library is being used. For
29484 example, OpenSSL uses the name DES-CBC3-SHA for the cipher suite which in other
29485 contexts is known as TLS_RSA_WITH_3DES_EDE_CBC_SHA. Check the OpenSSL or GnuTLS
29486 documentation for more details.
29487
29488 For outgoing SMTP deliveries, &$tls_out_cipher$& is used and logged
29489 (again depending on the &%tls_cipher%& log selector).
29490
29491
29492 .section "Requesting and verifying client certificates" "SECID183"
29493 .cindex "certificate" "verification of client"
29494 .cindex "TLS" "client certificate verification"
29495 If you want an Exim server to request a certificate when negotiating a TLS
29496 session with a client, you must set either &%tls_verify_hosts%& or
29497 &%tls_try_verify_hosts%&. You can, of course, set either of them to * to
29498 apply to all TLS connections. For any host that matches one of these options,
29499 Exim requests a certificate as part of the setup of the TLS session. The
29500 contents of the certificate are verified by comparing it with a list of
29501 expected trust-anchors or certificates.
29502 These may be the system default set (depending on library version),
29503 an explicit file or,
29504 depending on library version, a directory, identified by
29505 &%tls_verify_certificates%&.
29506
29507 A file can contain multiple certificates, concatenated end to end. If a
29508 directory is used
29509 (OpenSSL only),
29510 each certificate must be in a separate file, with a name (or a symbolic link)
29511 of the form <&'hash'&>.0, where <&'hash'&> is a hash value constructed from the
29512 certificate. You can compute the relevant hash by running the command
29513 .code
29514 openssl x509 -hash -noout -in /cert/file
29515 .endd
29516 where &_/cert/file_& contains a single certificate.
29517
29518 There is no checking of names of the client against the certificate
29519 Subject Name or Subject Alternate Names.
29520
29521 The difference between &%tls_verify_hosts%& and &%tls_try_verify_hosts%& is
29522 what happens if the client does not supply a certificate, or if the certificate
29523 does not match any of the certificates in the collection named by
29524 &%tls_verify_certificates%&. If the client matches &%tls_verify_hosts%&, the
29525 attempt to set up a TLS session is aborted, and the incoming connection is
29526 dropped. If the client matches &%tls_try_verify_hosts%&, the (encrypted) SMTP
29527 session continues. ACLs that run for subsequent SMTP commands can detect the
29528 fact that no certificate was verified, and vary their actions accordingly. For
29529 example, you can insist on a certificate before accepting a message for
29530 relaying, but not when the message is destined for local delivery.
29531
29532 .vindex "&$tls_in_peerdn$&"
29533 When a client supplies a certificate (whether it verifies or not), the value of
29534 the Distinguished Name of the certificate is made available in the variable
29535 &$tls_in_peerdn$& during subsequent processing of the message.
29536
29537 .cindex "log" "distinguished name"
29538 Because it is often a long text string, it is not included in the log line or
29539 &'Received:'& header by default. You can arrange for it to be logged, keyed by
29540 &"DN="&, by setting the &%tls_peerdn%& log selector, and you can use
29541 &%received_header_text%& to change the &'Received:'& header. When no
29542 certificate is supplied, &$tls_in_peerdn$& is empty.
29543
29544
29545 .section "Revoked certificates" "SECID184"
29546 .cindex "TLS" "revoked certificates"
29547 .cindex "revocation list"
29548 .cindex "certificate" "revocation list"
29549 .cindex "OCSP" "stapling"
29550 Certificate issuing authorities issue Certificate Revocation Lists (CRLs) when
29551 certificates are revoked. If you have such a list, you can pass it to an Exim
29552 server using the global option called &%tls_crl%& and to an Exim client using
29553 an identically named option for the &(smtp)& transport. In each case, the value
29554 of the option is expanded and must then be the name of a file that contains a
29555 CRL in PEM format.
29556 The downside is that clients have to periodically re-download a potentially huge
29557 file from every certificate authority they know of.
29558
29559 The way with most moving parts at query time is Online Certificate
29560 Status Protocol (OCSP), where the client verifies the certificate
29561 against an OCSP server run by the CA.  This lets the CA track all
29562 usage of the certs.  It requires running software with access to the
29563 private key of the CA, to sign the responses to the OCSP queries.  OCSP
29564 is based on HTTP and can be proxied accordingly.
29565
29566 The only widespread OCSP server implementation (known to this writer)
29567 comes as part of OpenSSL and aborts on an invalid request, such as
29568 connecting to the port and then disconnecting.  This requires
29569 re-entering the passphrase each time some random client does this.
29570
29571 The third way is OCSP Stapling; in this, the server using a certificate
29572 issued by the CA periodically requests an OCSP proof of validity from
29573 the OCSP server, then serves it up inline as part of the TLS
29574 negotiation.   This approach adds no extra round trips, does not let the
29575 CA track users, scales well with number of certs issued by the CA and is
29576 resilient to temporary OCSP server failures, as long as the server
29577 starts retrying to fetch an OCSP proof some time before its current
29578 proof expires.  The downside is that it requires server support.
29579
29580 Unless Exim is built with the support disabled,
29581 or with GnuTLS earlier than version 3.3.16 / 3.4.8
29582 support for OCSP stapling is included.
29583
29584 There is a global option called &%tls_ocsp_file%&.
29585 The file specified therein is expected to be in DER format, and contain
29586 an OCSP proof.  Exim will serve it as part of the TLS handshake.  This
29587 option will be re-expanded for SNI, if the &%tls_certificate%& option
29588 contains &`tls_in_sni`&, as per other TLS options.
29589
29590 Exim does not at this time implement any support for fetching a new OCSP
29591 proof.  The burden is on the administrator to handle this, outside of
29592 Exim.  The file specified should be replaced atomically, so that the
29593 contents are always valid.  Exim will expand the &%tls_ocsp_file%& option
29594 on each connection, so a new file will be handled transparently on the
29595 next connection.
29596
29597 When built with OpenSSL Exim will check for a valid next update timestamp
29598 in the OCSP proof; if not present, or if the proof has expired, it will be
29599 ignored.
29600
29601 For the client to be able to verify the stapled OCSP the server must
29602 also supply, in its stapled information, any intermediate
29603 certificates for the chain leading to the OCSP proof from the signer
29604 of the server certificate.  There may be zero or one such. These
29605 intermediate certificates should be added to the server OCSP stapling
29606 file named by &%tls_ocsp_file%&.
29607
29608 Note that the proof only covers the terminal server certificate,
29609 not any of the chain from CA to it.
29610
29611 There is no current way to staple a proof for a client certificate.
29612
29613 .code
29614   A helper script "ocsp_fetch.pl" for fetching a proof from a CA
29615   OCSP server is supplied.  The server URL may be included in the
29616   server certificate, if the CA is helpful.
29617
29618   One failure mode seen was the OCSP Signer cert expiring before the end
29619   of validity of the OCSP proof. The checking done by Exim/OpenSSL
29620   noted this as invalid overall, but the re-fetch script did not.
29621 .endd
29622
29623
29624 .new
29625 .section "Caching of static server configuration items" "SECTserverTLScache"
29626 .cindex certificate caching
29627 .cindex privatekey caching
29628 .cindex crl caching
29629 .cindex ocsp caching
29630 .cindex ciphers caching
29631 .cindex "CA bundle" caching
29632 .cindex "certificate authorities" caching
29633 .cindex tls_certificate caching
29634 .cindex tls_privatekey caching
29635 .cindex tls_crl caching
29636 .cindex tls_ocsp_file caching
29637 .cindex tls_require_ciphers caching
29638 .cindex tls_verify_certificate caching
29639 .cindex caching certificate
29640 .cindex caching privatekey
29641 .cindex caching crl
29642 .cindex caching ocsp
29643 .cindex caching ciphers
29644 .cindex caching "certificate authorities
29645 If any of the main configuration options &%tls_certificate%&, &%tls_privatekey%&,
29646 &%tls_crl%& and &%tls_ocsp_file%& have values with no
29647 expandable elements,
29648 then the associated information is loaded at daemon startup.
29649 It is made available
29650 to child processes forked for handling received SMTP connections.
29651
29652 This caching is currently only supported under Linux and FreeBSD.
29653
29654 If caching is not possible, for example if an item has to be dependent
29655 on the peer host so contains a &$sender_host_name$& expansion, the load
29656 of the associated information is done at the startup of the TLS connection.
29657
29658 The cache is invalidated and reloaded after any changes to the directories
29659 containing files specified by these options.
29660
29661 The information specified by the main option &%tls_verify_certificates%&
29662 is similarly cached so long as it specifies files explicitly
29663 or (under GnuTLS) is the string &"system,cache"&.
29664 The latter case is not automatically invalidated;
29665 it is the operator's responsibility to arrange for a daemon restart
29666 any time the system certificate authority bundle is updated.
29667 A HUP signal is sufficient for this.
29668 The value &"system"& results in no caching under GnuTLS.
29669
29670 The macro _HAVE_TLS_CA_CACHE will be defined if the suffix for "system"
29671 is acceptable in configurations for the Exim executavble.
29672
29673 Caching of the system Certificate Authorities bundle can
29674 save siginificant time and processing on every TLS connection
29675 accepted by Exim.
29676 .wen
29677
29678
29679
29680
29681 .section "Configuring an Exim client to use TLS" "SECTclientTLS"
29682 .cindex "cipher" "logging"
29683 .cindex "log" "TLS cipher"
29684 .cindex "log" "distinguished name"
29685 .cindex "TLS" "configuring an Exim client"
29686 The &%tls_cipher%& and &%tls_peerdn%& log selectors apply to outgoing SMTP
29687 deliveries as well as to incoming, the latter one causing logging of the
29688 server certificate's DN. The remaining client configuration for TLS is all
29689 within the &(smtp)& transport.
29690
29691 .cindex "ESMTP extensions" STARTTLS
29692 It is not necessary to set any options to have TLS work in the &(smtp)&
29693 transport. If Exim is built with TLS support, and TLS is advertised by a
29694 server, the &(smtp)& transport always tries to start a TLS session. However,
29695 this can be prevented by setting &%hosts_avoid_tls%& (an option of the
29696 transport) to a list of server hosts for which TLS should not be used.
29697
29698 If you do not want Exim to attempt to send messages unencrypted when an attempt
29699 to set up an encrypted connection fails in any way, you can set
29700 &%hosts_require_tls%& to a list of hosts for which encryption is mandatory. For
29701 those hosts, delivery is always deferred if an encrypted connection cannot be
29702 set up. If there are any other hosts for the address, they are tried in the
29703 usual way.
29704
29705 When the server host is not in &%hosts_require_tls%&, Exim may try to deliver
29706 the message unencrypted. It always does this if the response to STARTTLS is
29707 a 5&'xx'& code. For a temporary error code, or for a failure to negotiate a TLS
29708 session after a success response code, what happens is controlled by the
29709 &%tls_tempfail_tryclear%& option of the &(smtp)& transport. If it is false,
29710 delivery to this host is deferred, and other hosts (if available) are tried. If
29711 it is true, Exim attempts to deliver unencrypted after a 4&'xx'& response to
29712 STARTTLS, and if STARTTLS is accepted, but the subsequent TLS
29713 negotiation fails, Exim closes the current connection (because it is in an
29714 unknown state), opens a new one to the same host, and then tries the delivery
29715 unencrypted.
29716
29717 The &%tls_certificate%& and &%tls_privatekey%& options of the &(smtp)&
29718 transport provide the client with a certificate, which is passed to the server
29719 if it requests it.
29720 This is an optional thing for TLS connections, although either end
29721 may insist on it.
29722 If the server is Exim, it will request a certificate only if
29723 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& matches the client.
29724
29725 &*Note*&: Do not use a certificate which has the OCSP-must-staple extension,
29726 for client use (they are usable for server use).
29727 As the TLS protocol has no means for the client to staple before TLS 1.3 it will result
29728 in failed connections.
29729
29730 If the &%tls_verify_certificates%& option is set on the &(smtp)& transport, it
29731 specifies a collection of expected server certificates.
29732 These may be
29733 the system default set (depending on library version),
29734 a file,
29735 or (depending on library version) a directory.
29736 The client verifies the server's certificate
29737 against this collection, taking into account any revoked certificates that are
29738 in the list defined by &%tls_crl%&.
29739 Failure to verify fails the TLS connection unless either of the
29740 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& options are set.
29741
29742 The &%tls_verify_hosts%& and &%tls_try_verify_hosts%& options restrict
29743 certificate verification to the listed servers.  Verification either must
29744 or need not succeed respectively.
29745
29746 The &%tls_verify_cert_hostnames%& option lists hosts for which additional
29747 name checks are made on the server certificate.
29748 .new
29749 The match against this list is, as per other Exim usage, the
29750 IP for the host.  That is most closely associated with the
29751 name on the DNS A (or AAAA) record for the host.
29752 However, the name that needs to be in the certificate
29753 is the one at the head of any CNAME chain leading to the A record.
29754 .wen
29755 The option defaults to always checking.
29756
29757 The &(smtp)& transport has two OCSP-related options:
29758 &%hosts_require_ocsp%&; a host-list for which a Certificate Status
29759 is requested and required for the connection to proceed.  The default
29760 value is empty.
29761 &%hosts_request_ocsp%&; a host-list for which (additionally)
29762 a Certificate Status is requested (but not necessarily verified).  The default
29763 value is "*" meaning that requests are made unless configured
29764 otherwise.
29765
29766 The host(s) should also be in &%hosts_require_tls%&, and
29767 &%tls_verify_certificates%& configured for the transport,
29768 for OCSP to be relevant.
29769
29770 If
29771 &%tls_require_ciphers%& is set on the &(smtp)& transport, it must contain a
29772 list of permitted cipher suites. If either of these checks fails, delivery to
29773 the current host is abandoned, and the &(smtp)& transport tries to deliver to
29774 alternative hosts, if any.
29775
29776  &*Note*&:
29777 These options must be set in the &(smtp)& transport for Exim to use TLS when it
29778 is operating as a client. Exim does not assume that a server certificate (set
29779 by the global options of the same name) should also be used when operating as a
29780 client.
29781
29782 .vindex "&$host$&"
29783 .vindex "&$host_address$&"
29784 All the TLS options in the &(smtp)& transport are expanded before use, with
29785 &$host$& and &$host_address$& containing the name and address of the server to
29786 which the client is connected. Forced failure of an expansion causes Exim to
29787 behave as if the relevant option were unset.
29788
29789 .vindex &$tls_out_bits$&
29790 .vindex &$tls_out_cipher$&
29791 .vindex &$tls_out_peerdn$&
29792 .vindex &$tls_out_sni$&
29793 Before an SMTP connection is established, the
29794 &$tls_out_bits$&, &$tls_out_cipher$&, &$tls_out_peerdn$& and &$tls_out_sni$&
29795 variables are emptied. (Until the first connection, they contain the values
29796 that were set when the message was received.) If STARTTLS is subsequently
29797 successfully obeyed, these variables are set to the relevant values for the
29798 outgoing connection.
29799
29800
29801
29802 .new
29803 .section "Caching of static client configuration items" "SECTclientTLScache"
29804 .cindex certificate caching
29805 .cindex privatekey caching
29806 .cindex crl caching
29807 .cindex ciphers caching
29808 .cindex "CA bundle" caching
29809 .cindex "certificate authorities" caching
29810 .cindex tls_certificate caching
29811 .cindex tls_privatekey caching
29812 .cindex tls_crl caching
29813 .cindex tls_require_ciphers caching
29814 .cindex tls_verify_certificate caching
29815 .cindex caching certificate
29816 .cindex caching privatekey
29817 .cindex caching crl
29818 .cindex caching ciphers
29819 .cindex caching "certificate authorities
29820 If any of the transport configuration options &%tls_certificate%&, &%tls_privatekey%&
29821 and &%tls_crl%& have values with no
29822 expandable elements,
29823 then the associated information is loaded per smtp transport
29824 at daemon startup, at the start of a queue run, or on a
29825 command-line specified message delivery.
29826 It is made available
29827 to child processes forked for handling making SMTP connections.
29828
29829 This caching is currently only supported under Linux.
29830
29831 If caching is not possible, the load
29832 of the associated information is done at the startup of the TLS connection.
29833
29834 The cache is invalidated in the daemon
29835 and reloaded after any changes to the directories
29836 containing files specified by these options.
29837
29838 The information specified by the main option &%tls_verify_certificates%&
29839 is similarly cached so long as it specifies files explicitly
29840 or (under GnuTLS) is the string &"system,cache"&.
29841 The latter case is not automatically invaludated;
29842 it is the operator's responsibility to arrange for a daemon restart
29843 any time the system certificate authority bundle is updated.
29844 A HUP signal is sufficient for this.
29845 The value &"system"& results in no caching under GnuTLS.
29846
29847 The macro _HAVE_TLS_CA_CACHE will be defined if the suffix for "system"
29848 is acceptable in configurations for the Exim executavble.
29849
29850 Caching of the system Certificate Authorities bundle can
29851 save siginificant time and processing on every TLS connection
29852 initiated by Exim.
29853 .wen
29854
29855
29856
29857
29858 .section "Use of TLS Server Name Indication" "SECTtlssni"
29859 .cindex "TLS" "Server Name Indication"
29860 .cindex "TLS" SNI
29861 .cindex SNI
29862 .vindex "&$tls_in_sni$&"
29863 .oindex "&%tls_in_sni%&"
29864 With TLS1.0 or above, there is an extension mechanism by which extra
29865 information can be included at various points in the protocol.  One of these
29866 extensions, documented in RFC 6066 (and before that RFC 4366) is
29867 &"Server Name Indication"&, commonly &"SNI"&.  This extension is sent by the
29868 client in the initial handshake, so that the server can examine the servername
29869 within and possibly choose to use different certificates and keys (and more)
29870 for this session.
29871
29872 This is analogous to HTTP's &"Host:"& header, and is the main mechanism by
29873 which HTTPS-enabled web-sites can be virtual-hosted, many sites to one IP
29874 address.
29875
29876 With SMTP to MX, there are the same problems here as in choosing the identity
29877 against which to validate a certificate: you can't rely on insecure DNS to
29878 provide the identity which you then cryptographically verify.  So this will
29879 be of limited use in that environment.
29880
29881 With SMTP to Submission, there is a well-defined hostname which clients are
29882 connecting to and can validate certificates against.  Thus clients &*can*&
29883 choose to include this information in the TLS negotiation.  If this becomes
29884 wide-spread, then hosters can choose to present different certificates to
29885 different clients.  Or even negotiate different cipher suites.
29886
29887 The &%tls_sni%& option on an SMTP transport is an expanded string; the result,
29888 if not empty, will be sent on a TLS session as part of the handshake.  There's
29889 nothing more to it.  Choosing a sensible value not derived insecurely is the
29890 only point of caution.  The &$tls_out_sni$& variable will be set to this string
29891 for the lifetime of the client connection (including during authentication).
29892
29893 .new
29894 If DANE validated the connection attempt then the value of the &%tls_sni%& option
29895 is forced to the domain part of the recipient address.
29896 .wen
29897
29898 Except during SMTP client sessions, if &$tls_in_sni$& is set then it is a string
29899 received from a client.
29900 It can be logged with the &%log_selector%& item &`+tls_sni`&.
29901
29902 If the string &`tls_in_sni`& appears in the main section's &%tls_certificate%&
29903 option (prior to expansion) then the following options will be re-expanded
29904 during TLS session handshake, to permit alternative values to be chosen:
29905
29906 .ilist
29907 &%tls_certificate%&
29908 .next
29909 &%tls_crl%&
29910 .next
29911 &%tls_privatekey%&
29912 .next
29913 &%tls_verify_certificates%&
29914 .next
29915 &%tls_ocsp_file%&
29916 .endlist
29917
29918 Great care should be taken to deal with matters of case, various injection
29919 attacks in the string (&`../`& or SQL), and ensuring that a valid filename
29920 can always be referenced; it is important to remember that &$tls_in_sni$& is
29921 arbitrary unverified data provided prior to authentication.
29922 Further, the initial certificate is loaded before SNI has arrived, so
29923 an expansion for &%tls_certificate%& must have a default which is used
29924 when &$tls_in_sni$& is empty.
29925
29926 The Exim developers are proceeding cautiously and so far no other TLS options
29927 are re-expanded.
29928
29929 When Exim is built against OpenSSL, OpenSSL must have been built with support
29930 for TLS Extensions.  This holds true for OpenSSL 1.0.0+ and 0.9.8+ with
29931 enable-tlsext in EXTRACONFIGURE.  If you invoke &(openssl s_client -h)& and
29932 see &`-servername`& in the output, then OpenSSL has support.
29933
29934 When Exim is built against GnuTLS, SNI support is available as of GnuTLS
29935 0.5.10.  (Its presence predates the current API which Exim uses, so if Exim
29936 built, then you have SNI support).
29937
29938 .new
29939 .cindex TLS ALPN
29940 .cindex ALPN "general information"
29941 .cindex TLS "Application Layer Protocol Names"
29942 There is a TLS feature related to SNI
29943 called Application Layer Protocol Name (ALPN).
29944 This is intended to declare, or select, what protocol layer will be using a TLS
29945 connection.
29946 The client for the connection proposes a set of protocol names, and
29947 the server responds with a selected one.
29948 It is not, as of 2021, commonly used for SMTP connections.
29949 However, to guard against misirected or malicious use of web clients
29950 (which often do use ALPN) against MTA ports, Exim by default check that
29951 there is no incompatible ALPN specified by a client for a TLS connection.
29952 If there is, the connection is rejected.
29953
29954 As a client Exim does not supply ALPN by default.
29955 The behaviour of both client and server can be configured using the options
29956 &%tls_alpn%& and &%hosts_require_alpn%&.
29957 There are no variables providing observability.
29958 Some feature-specific logging may appear on denied connections, but this
29959 depends on the behavious of the peer
29960 (not all peers can send a feature-specific TLS Alert).
29961
29962 This feature is available when Exim is built with
29963 OpenSSL 1.1.0 or later or GnuTLS 3.2.0 or later;
29964 the macro _HAVE_TLS_ALPN will be defined when this is so.
29965 .wen
29966
29967
29968
29969 .section "Multiple messages on the same encrypted TCP/IP connection" &&&
29970          "SECTmulmessam"
29971 .cindex "multiple SMTP deliveries with TLS"
29972 .cindex "TLS" "multiple message deliveries"
29973 Exim sends multiple messages down the same TCP/IP connection by starting up
29974 an entirely new delivery process for each message, passing the socket from
29975 one process to the next. This implementation does not fit well with the use
29976 of TLS, because there is quite a lot of state information associated with a TLS
29977 connection, not just a socket identification. Passing all the state information
29978 to a new process is not feasible. Consequently, for sending using TLS Exim
29979 starts an additional proxy process for handling the encryption, piping the
29980 unencrypted data stream from and to the delivery processes.
29981
29982 An older mode of operation can be enabled on a per-host basis by the
29983 &%hosts_noproxy_tls%& option on the &(smtp)& transport.  If the host matches
29984 this list the proxy process described above is not used; instead Exim
29985 shuts down an existing TLS session being run by the delivery process
29986 before passing the socket to a new process. The new process may then
29987 try to start a new TLS session, and if successful, may try to re-authenticate
29988 if AUTH is in use, before sending the next message.
29989
29990 The RFC is not clear as to whether or not an SMTP session continues in clear
29991 after TLS has been shut down, or whether TLS may be restarted again later, as
29992 just described. However, if the server is Exim, this shutdown and
29993 reinitialization works. It is not known which (if any) other servers operate
29994 successfully if the client closes a TLS session and continues with unencrypted
29995 SMTP, but there are certainly some that do not work. For such servers, Exim
29996 should not pass the socket to another process, because the failure of the
29997 subsequent attempt to use it would cause Exim to record a temporary host error,
29998 and delay other deliveries to that host.
29999
30000 To test for this case, Exim sends an EHLO command to the server after
30001 closing down the TLS session. If this fails in any way, the connection is
30002 closed instead of being passed to a new delivery process, but no retry
30003 information is recorded.
30004
30005 There is also a manual override; you can set &%hosts_nopass_tls%& on the
30006 &(smtp)& transport to match those hosts for which Exim should not pass
30007 connections to new processes if TLS has been used.
30008
30009
30010
30011
30012 .section "Certificates and all that" "SECTcerandall"
30013 .cindex "certificate" "references to discussion"
30014 In order to understand fully how TLS works, you need to know about
30015 certificates, certificate signing, and certificate authorities.
30016 This is a large topic and an introductory guide is unsuitable for the Exim
30017 reference manual, so instead we provide pointers to existing documentation.
30018
30019 The Apache web-server was for a long time the canonical guide, so their
30020 documentation is a good place to start; their SSL module's Introduction
30021 document is currently at
30022 .display
30023 &url(https://httpd.apache.org/docs/current/ssl/ssl_intro.html)
30024 .endd
30025 and their FAQ is at
30026 .display
30027 &url(https://httpd.apache.org/docs/current/ssl/ssl_faq.html)
30028 .endd
30029
30030 Eric Rescorla's book, &'SSL and TLS'&, published by Addison-Wesley (ISBN
30031 0-201-61598-3) in 2001, contains both introductory and more in-depth
30032 descriptions.
30033 More recently Ivan Ristić's book &'Bulletproof SSL and TLS'&,
30034 published by Feisty Duck (ISBN 978-1907117046) in 2013 is good.
30035 Ivan is the author of the popular TLS testing tools at
30036 &url(https://www.ssllabs.com/).
30037
30038
30039 .section "Certificate chains" "SECID186"
30040 A file named by &%tls_certificate%& may contain more than one
30041 certificate. This is useful in the case where the certificate that is being
30042 sent is validated by an intermediate certificate which the other end does
30043 not have. Multiple certificates must be in the correct order in the file.
30044 First the host's certificate itself, then the first intermediate
30045 certificate to validate the issuer of the host certificate, then the next
30046 intermediate certificate to validate the issuer of the first intermediate
30047 certificate, and so on, until finally (optionally) the root certificate.
30048 The root certificate must already be trusted by the recipient for
30049 validation to succeed, of course, but if it's not preinstalled, sending the
30050 root certificate along with the rest makes it available for the user to
30051 install if the receiving end is a client MUA that can interact with a user.
30052
30053 Note that certificates using MD5 are unlikely to work on today's Internet;
30054 even if your libraries allow loading them for use in Exim when acting as a
30055 server, increasingly clients will not accept such certificates.  The error
30056 diagnostics in such a case can be frustratingly vague.
30057
30058
30059
30060 .section "Self-signed certificates" "SECID187"
30061 .cindex "certificate" "self-signed"
30062 You can create a self-signed certificate using the &'req'& command provided
30063 with OpenSSL, like this:
30064 . ==== Do not shorten the duration here without reading and considering
30065 . ==== the text below.  Please leave it at 9999 days.
30066 .code
30067 openssl req -x509 -newkey rsa:1024 -keyout file1 -out file2 \
30068             -days 9999 -nodes
30069 .endd
30070 &_file1_& and &_file2_& can be the same file; the key and the certificate are
30071 delimited and so can be identified independently. The &%-days%& option
30072 specifies a period for which the certificate is valid. The &%-nodes%& option is
30073 important: if you do not set it, the key is encrypted with a passphrase
30074 that you are prompted for, and any use that is made of the key causes more
30075 prompting for the passphrase. This is not helpful if you are going to use
30076 this certificate and key in an MTA, where prompting is not possible.
30077
30078 . ==== I expect to still be working 26 years from now.  The less technical
30079 . ==== debt I create, in terms of storing up trouble for my later years, the
30080 . ==== happier I will be then.  We really have reached the point where we
30081 . ==== should start, at the very least, provoking thought and making folks
30082 . ==== pause before proceeding, instead of leaving all the fixes until two
30083 . ==== years before 2^31 seconds after the 1970 Unix epoch.
30084 . ==== -pdp, 2012
30085 NB: we are now past the point where 9999 days takes us past the 32-bit Unix
30086 epoch.  If your system uses unsigned time_t (most do) and is 32-bit, then
30087 the above command might produce a date in the past.  Think carefully about
30088 the lifetime of the systems you're deploying, and either reduce the duration
30089 of the certificate or reconsider your platform deployment.  (At time of
30090 writing, reducing the duration is the most likely choice, but the inexorable
30091 progression of time takes us steadily towards an era where this will not
30092 be a sensible resolution).
30093
30094 A self-signed certificate made in this way is sufficient for testing, and
30095 may be adequate for all your requirements if you are mainly interested in
30096 encrypting transfers, and not in secure identification.
30097
30098 However, many clients require that the certificate presented by the server be a
30099 user (also called &"leaf"& or &"site"&) certificate, and not a self-signed
30100 certificate. In this situation, the self-signed certificate described above
30101 must be installed on the client host as a trusted root &'certification
30102 authority'& (CA), and the certificate used by Exim must be a user certificate
30103 signed with that self-signed certificate.
30104
30105 For information on creating self-signed CA certificates and using them to sign
30106 user certificates, see the &'General implementation overview'& chapter of the
30107 Open-source PKI book, available online at
30108 &url(https://sourceforge.net/projects/ospkibook/).
30109 .ecindex IIDencsmtp1
30110 .ecindex IIDencsmtp2
30111
30112
30113 .new
30114 .section "TLS Resumption" "SECTresumption"
30115 .cindex TLS resumption
30116 TLS Session Resumption for TLS 1.2 and TLS 1.3 connections can be used (defined
30117 in RFC 5077 for 1.2).  The support for this requires GnuTLS 3.6.3 or OpenSSL 1.1.1
30118 (or later).
30119
30120 Session resumption (this is the "stateless" variant) involves the server sending
30121 a "session ticket" to the client on one connection, which can be stored by the
30122 client and used for a later session.  The ticket contains sufficient state for
30123 the server to reconstruct the TLS session, avoiding some expensive crypto
30124 calculation and (on TLS1.2) one full packet roundtrip time.
30125
30126 .ilist
30127 Operational cost/benefit:
30128
30129  The extra data being transmitted costs a minor amount, and the client has
30130  extra costs in storing and retrieving the data.
30131
30132  In the Exim/Gnutls implementation the extra cost on an initial connection
30133  which is TLS1.2 over a loopback path is about 6ms on 2017-laptop class hardware.
30134  The saved cost on a subsequent connection is about 4ms; three or more
30135  connections become a net win.  On longer network paths, two or more
30136  connections will have an average lower startup time thanks to the one
30137  saved packet roundtrip.  TLS1.3 will save the crypto cpu costs but not any
30138  packet roundtrips.
30139
30140 .cindex "hints database" tls
30141  Since a new hints DB is used on the TLS client,
30142  the hints DB maintenance should be updated to additionally handle "tls".
30143
30144 .next
30145 Security aspects:
30146
30147  The session ticket is encrypted, but is obviously an additional security
30148  vulnarability surface.  An attacker able to decrypt it would have access
30149  all connections using the resumed session.
30150  The session ticket encryption key is not committed to storage by the server
30151  and is rotated regularly (OpenSSL: 1hr, and one previous key is used for
30152  overlap; GnuTLS 6hr but does not specify any overlap).
30153  Tickets have limited lifetime (2hr, and new ones issued after 1hr under
30154  OpenSSL.  GnuTLS 2hr, appears to not do overlap).
30155
30156  There is a question-mark over the security of the Diffie-Helman parameters
30157  used for session negotiation.
30158
30159 .next
30160 Observability:
30161
30162  The &%log_selector%& "tls_resumption" appends an asterisk to the tls_cipher "X="
30163  element.
30164
30165  The variables &$tls_in_resumption$& and &$tls_out_resumption$&
30166  have bits 0-4 indicating respectively
30167  support built, client requested ticket, client offered session,
30168  server issued ticket, resume used.  A suitable decode list is provided
30169  in the builtin macro _RESUME_DECODE for in &%listextract%& expansions.
30170
30171 .next
30172 Control:
30173
30174 The &%tls_resumption_hosts%& main option specifies a hostlist for which
30175 exim, operating as a server, will offer resumption to clients.
30176 Current best practice is to not offer the feature to MUA connection.
30177 Commonly this can be done like this:
30178 .code
30179 tls_resumption_hosts = ${if inlist {$received_port}{587:465} {:}{*}}
30180 .endd
30181 If the peer host matches the list after expansion then resumption
30182 is offered and/or accepted.
30183
30184 The &%tls_resumption_hosts%& smtp transport option performs the
30185 equivalent function for operation as a client.
30186 If the peer host matches the list after expansion then resumption
30187 is attempted (if a stored session is available) or the information
30188 stored (if supplied by the peer).
30189
30190
30191 .next
30192 Issues:
30193
30194  In a resumed session:
30195 .ilist
30196   The variables &$tls_{in,out}_cipher$& will have values different
30197  to the original (under GnuTLS).
30198 .next
30199   The variables &$tls_{in,out}_ocsp$& will be "not requested" or "no response",
30200  and the &%hosts_require_ocsp%& smtp trasnport option will fail.
30201 . XXX need to do something with that hosts_require_ocsp
30202 .endlist
30203
30204 .endlist
30205 .wen
30206
30207
30208 .section DANE "SECDANE"
30209 .cindex DANE
30210 DNS-based Authentication of Named Entities, as applied to SMTP over TLS, provides assurance to a client that
30211 it is actually talking to the server it wants to rather than some attacker operating a Man In The Middle (MITM)
30212 operation.  The latter can terminate the TLS connection you make, and make another one to the server (so both
30213 you and the server still think you have an encrypted connection) and, if one of the "well known" set of
30214 Certificate Authorities has been suborned - something which *has* been seen already (2014), a verifiable
30215 certificate (if you're using normal root CAs, eg. the Mozilla set, as your trust anchors).
30216
30217 What DANE does is replace the CAs with the DNS as the trust anchor.  The assurance is limited to a) the possibility
30218 that the DNS has been suborned, b) mistakes made by the admins of the target server.   The attack surface presented
30219 by (a) is thought to be smaller than that of the set of root CAs.
30220
30221 It also allows the server to declare (implicitly) that connections to it should use TLS.  An MITM could simply
30222 fail to pass on a server's STARTTLS.
30223
30224 DANE scales better than having to maintain (and communicate via side-channel) copies of server certificates
30225 for every possible target server.  It also scales (slightly) better than having to maintain on an SMTP
30226 client a copy of the standard CAs bundle.  It also means not having to pay a CA for certificates.
30227
30228 DANE requires a server operator to do three things: 1) run DNSSEC.  This provides assurance to clients
30229 that DNS lookups they do for the server have not been tampered with.  The domain MX record applying
30230 to this server, its A record, its TLSA record and any associated CNAME records must all be covered by
30231 DNSSEC.
30232 2) add TLSA DNS records.  These say what the server certificate for a TLS connection should be.
30233 3) offer a server certificate, or certificate chain, in TLS connections which is is anchored by one of the TLSA records.
30234
30235 There are no changes to Exim specific to server-side operation of DANE.
30236 Support for client-side operation of DANE can be included at compile time by defining SUPPORT_DANE=yes
30237 in &_Local/Makefile_&.
30238 If it has been included, the macro "_HAVE_DANE" will be defined.
30239
30240 A TLSA record consist of 4 fields, the "Certificate Usage", the
30241 "Selector", the "Matching type", and the "Certificate Association Data".
30242 For a detailed description of the TLSA record see
30243 &url(https://tools.ietf.org/html/rfc7671#page-5,RFC 7671).
30244
30245 The TLSA record for the server may have "Certificate Usage" (1st) field of DANE-TA(2) or DANE-EE(3).
30246 These are the "Trust Anchor" and "End Entity" variants.
30247 The latter specifies the End Entity directly, i.e. the certificate involved is that of the server
30248 (and if only DANE-EE is used then it should be the sole one transmitted during the TLS handshake);
30249 this is appropriate for a single system, using a self-signed certificate.
30250 DANE-TA usage is effectively declaring a specific CA to be used; this might be a private CA or a public,
30251 well-known one.
30252 A private CA at simplest is just a self-signed certificate (with certain
30253 attributes) which is used to sign server certificates, but running one securely
30254 does require careful arrangement.
30255 With DANE-TA, as implemented in Exim and commonly in other MTAs,
30256 the server TLS handshake must transmit the entire certificate chain from CA to server-certificate.
30257 DANE-TA is commonly used for several services and/or servers, each having a TLSA query-domain CNAME record,
30258 all of which point to a single TLSA record.
30259 DANE-TA and DANE-EE can both be used together.
30260
30261 Our recommendation is to use DANE with a certificate from a public CA,
30262 because this enables a variety of strategies for remote clients to verify
30263 your certificate.
30264 You can then publish information both via DANE and another technology,
30265 "MTA-STS", described below.
30266
30267 When you use DANE-TA to publish trust anchor information, you ask entities
30268 outside your administrative control to trust the Certificate Authority for
30269 connections to you.
30270 If using a private CA then you should expect others to still apply the
30271 technical criteria they'd use for a public CA to your certificates.
30272 In particular, you should probably try to follow current best practices for CA
30273 operation around hash algorithms and key sizes.
30274 Do not expect other organizations to lower their security expectations just
30275 because a particular profile might be reasonable for your own internal use.
30276
30277 When this text was last updated, this in practice means to avoid use of SHA-1
30278 and MD5; if using RSA to use key sizes of at least 2048 bits (and no larger
30279 than 4096, for interoperability); to use keyUsage fields correctly; to use
30280 random serial numbers.
30281 The list of requirements is subject to change as best practices evolve.
30282 If you're not already using a private CA, or it doesn't meet these
30283 requirements, then we encourage you to avoid all these issues and use a public
30284 CA such as &url(https://letsencrypt.org/,Let's Encrypt) instead.
30285
30286 The TLSA record should have a "Selector" (2nd) field of SPKI(1) and
30287 a "Matching Type" (3rd) field of SHA2-512(2).
30288
30289 For the "Certificate Authority Data" (4th) field, commands like
30290
30291 .code
30292   openssl x509 -pubkey -noout <certificate.pem \
30293   | openssl rsa -outform der -pubin 2>/dev/null \
30294   | openssl sha512 \
30295   | awk '{print $2}'
30296 .endd
30297
30298 are workable to create a hash of the certificate's public key.
30299
30300 An example TLSA record for DANE-EE(3), SPKI(1), and SHA-512 (2) looks like
30301
30302 .code
30303   _25._tcp.mail.example.com. TLSA 3 1 2 8BA8A336E...
30304 .endd
30305
30306 At the time of writing, &url(https://www.huque.com/bin/gen_tlsa)
30307 is useful for quickly generating TLSA records.
30308
30309
30310 For use with the DANE-TA model, server certificates must have a correct name (SubjectName or SubjectAltName).
30311
30312 The Certificate issued by the CA published in the DANE-TA model should be
30313 issued using a strong hash algorithm.
30314 Exim, and importantly various other MTAs sending to you, will not
30315 re-enable hash algorithms which have been disabled by default in TLS
30316 libraries.
30317 This means no MD5 and no SHA-1.  SHA2-256 is the minimum for reliable
30318 interoperability (and probably the maximum too, in 2018).
30319
30320 The use of OCSP-stapling should be considered, allowing for fast revocation of certificates (which would otherwise
30321 be limited by the DNS TTL on the TLSA records).  However, this is likely to only be usable with DANE-TA.  NOTE: the
30322 default of requesting OCSP for all hosts is modified iff DANE is in use, to:
30323
30324 .code
30325   hosts_request_ocsp = ${if or { {= {0}{$tls_out_tlsa_usage}} \
30326                                  {= {4}{$tls_out_tlsa_usage}} } \
30327                          {*}{}}
30328 .endd
30329
30330 The (new) variable &$tls_out_tlsa_usage$& is a bitfield with numbered bits set for TLSA record usage codes.
30331 The zero above means DANE was not in use, the four means that only DANE-TA usage TLSA records were
30332 found. If the definition of &%hosts_request_ocsp%& includes the
30333 string "tls_out_tlsa_usage", they are re-expanded in time to
30334 control the OCSP request.
30335
30336 This modification of hosts_request_ocsp is only done if it has the default value of "*".  Admins who change it, and
30337 those who use &%hosts_require_ocsp%&, should consider the interaction with DANE in their OCSP settings.
30338
30339
30340 For client-side DANE there are three new smtp transport options, &%hosts_try_dane%&, &%hosts_require_dane%&
30341 and &%dane_require_tls_ciphers%&.
30342 The &"require"& variant will result in failure if the target host is not
30343 DNSSEC-secured. To get DNSSEC-secured hostname resolution, use
30344 the &%dnssec_request_domains%& router or transport option.
30345
30346 DANE will only be usable if the target host has DNSSEC-secured MX, A and TLSA records.
30347
30348 A TLSA lookup will be done if either of the above options match and the host-lookup succeeded using DNSSEC.
30349 If a TLSA lookup is done and succeeds, a DANE-verified TLS connection
30350 will be required for the host.  If it does not, the host will not
30351 be used; there is no fallback to non-DANE or non-TLS.
30352
30353 If DANE is requested and usable, then the TLS cipher list configuration
30354 prefers to use the option &%dane_require_tls_ciphers%& and falls
30355 back to &%tls_require_ciphers%& only if that is unset.
30356 This lets you configure "decent crypto" for DANE and "better than nothing
30357 crypto" as the default.  Note though that while GnuTLS lets the string control
30358 which versions of TLS/SSL will be negotiated, OpenSSL does not and you're
30359 limited to ciphersuite constraints.
30360
30361 If DANE is requested and useable (see above) the following transport options are ignored:
30362 .code
30363   hosts_require_tls
30364   tls_verify_hosts
30365   tls_try_verify_hosts
30366   tls_verify_certificates
30367   tls_crl
30368   tls_verify_cert_hostnames
30369   tls_sni
30370 .endd
30371
30372 If DANE is not usable, whether requested or not, and CA-anchored
30373 verification evaluation is wanted, the above variables should be set appropriately.
30374
30375 The router and transport option &%dnssec_request_domains%& must not be
30376 set to &"never"&, and &%dnssec_require_domains%& is ignored.
30377
30378 If verification was successful using DANE then the "CV" item in the delivery log line will show as "CV=dane".
30379
30380 There is a new variable &$tls_out_dane$& which will have "yes" if
30381 verification succeeded using DANE and "no" otherwise (only useful
30382 in combination with events; see &<<CHAPevents>>&),
30383 and a new variable &$tls_out_tlsa_usage$& (detailed above).
30384
30385 .cindex DANE reporting
30386 An event (see &<<CHAPevents>>&) of type "dane:fail" will be raised on failures
30387 to achieve DANE-verified connection, if one was either requested and offered, or
30388 required.  This is intended to support TLS-reporting as defined in
30389 &url(https://tools.ietf.org/html/draft-ietf-uta-smtp-tlsrpt-17).
30390 The &$event_data$& will be one of the Result Types defined in
30391 Section 4.3 of that document.
30392
30393 Under GnuTLS, DANE is only supported from version 3.0.0 onwards.
30394
30395 DANE is specified in published RFCs and decouples certificate authority trust
30396 selection from a "race to the bottom" of "you must trust everything for mail
30397 to get through".  There is an alternative technology called MTA-STS, which
30398 instead publishes MX trust anchor information on an HTTPS website.  At the
30399 time this text was last updated, MTA-STS was still a draft, not yet an RFC.
30400 Exim has no support for MTA-STS as a client, but Exim mail server operators
30401 can choose to publish information describing their TLS configuration using
30402 MTA-STS to let those clients who do use that protocol derive trust
30403 information.
30404
30405 The MTA-STS design requires a certificate from a public Certificate Authority
30406 which is recognized by clients sending to you.
30407 That selection of which CAs are trusted by others is outside your control.
30408
30409 The most interoperable course of action is probably to use
30410 &url(https://letsencrypt.org/,Let's Encrypt), with automated certificate
30411 renewal; to publish the anchor information in DNSSEC-secured DNS via TLSA
30412 records for DANE clients (such as Exim and Postfix) and to publish anchor
30413 information for MTA-STS as well.  This is what is done for the &'exim.org'&
30414 domain itself (with caveats around occasionally broken MTA-STS because of
30415 incompatible specification changes prior to reaching RFC status).
30416
30417
30418
30419 . ////////////////////////////////////////////////////////////////////////////
30420 . ////////////////////////////////////////////////////////////////////////////
30421
30422 .chapter "Access control lists" "CHAPACL"
30423 .scindex IIDacl "&ACL;" "description"
30424 .cindex "control of incoming mail"
30425 .cindex "message" "controlling incoming"
30426 .cindex "policy control" "access control lists"
30427 Access Control Lists (ACLs) are defined in a separate section of the runtime
30428 configuration file, headed by &"begin acl"&. Each ACL definition starts with a
30429 name, terminated by a colon. Here is a complete ACL section that contains just
30430 one very small ACL:
30431 .code
30432 begin acl
30433 small_acl:
30434   accept   hosts = one.host.only
30435 .endd
30436 You can have as many lists as you like in the ACL section, and the order in
30437 which they appear does not matter. The lists are self-terminating.
30438
30439 The majority of ACLs are used to control Exim's behaviour when it receives
30440 certain SMTP commands. This applies both to incoming TCP/IP connections, and
30441 when a local process submits a message using SMTP by specifying the &%-bs%&
30442 option. The most common use is for controlling which recipients are accepted
30443 in incoming messages. In addition, you can define an ACL that is used to check
30444 local non-SMTP messages. The default configuration file contains an example of
30445 a realistic ACL for checking RCPT commands. This is discussed in chapter
30446 &<<CHAPdefconfil>>&.
30447
30448
30449 .section "Testing ACLs" "SECID188"
30450 The &%-bh%& command line option provides a way of testing your ACL
30451 configuration locally by running a fake SMTP session with which you interact.
30452
30453
30454 .section "Specifying when ACLs are used" "SECID189"
30455 .cindex "&ACL;" "options for specifying"
30456 In order to cause an ACL to be used, you have to name it in one of the relevant
30457 options in the main part of the configuration. These options are:
30458 .cindex "AUTH" "ACL for"
30459 .cindex "DATA" "ACLs for"
30460 .cindex "ETRN" "ACL for"
30461 .cindex "EXPN" "ACL for"
30462 .cindex "HELO" "ACL for"
30463 .cindex "EHLO" "ACL for"
30464 .cindex "DKIM" "ACL for"
30465 .cindex "MAIL" "ACL for"
30466 .cindex "QUIT, ACL for"
30467 .cindex "RCPT" "ACL for"
30468 .cindex "STARTTLS, ACL for"
30469 .cindex "VRFY" "ACL for"
30470 .cindex "SMTP" "connection, ACL for"
30471 .cindex "non-SMTP messages" "ACLs for"
30472 .cindex "MIME content scanning" "ACL for"
30473 .cindex "PRDR" "ACL for"
30474
30475 .table2 140pt
30476 .irow &%acl_not_smtp%&         "ACL for non-SMTP messages"
30477 .irow &%acl_not_smtp_mime%&    "ACL for non-SMTP MIME parts"
30478 .irow &%acl_not_smtp_start%&   "ACL at start of non-SMTP message"
30479 .irow &%acl_smtp_auth%&        "ACL for AUTH"
30480 .irow &%acl_smtp_connect%&     "ACL for start of SMTP connection"
30481 .irow &%acl_smtp_data%&        "ACL after DATA is complete"
30482 .irow &%acl_smtp_data_prdr%&   "ACL for each recipient, after DATA is complete"
30483 .irow &%acl_smtp_dkim%&        "ACL for each DKIM signer"
30484 .irow &%acl_smtp_etrn%&        "ACL for ETRN"
30485 .irow &%acl_smtp_expn%&        "ACL for EXPN"
30486 .irow &%acl_smtp_helo%&        "ACL for HELO or EHLO"
30487 .irow &%acl_smtp_mail%&        "ACL for MAIL"
30488 .irow &%acl_smtp_mailauth%&    "ACL for the AUTH parameter of MAIL"
30489 .irow &%acl_smtp_mime%&        "ACL for content-scanning MIME parts"
30490 .irow &%acl_smtp_notquit%&     "ACL for non-QUIT terminations"
30491 .irow &%acl_smtp_predata%&     "ACL at start of DATA command"
30492 .irow &%acl_smtp_quit%&        "ACL for QUIT"
30493 .irow &%acl_smtp_rcpt%&        "ACL for RCPT"
30494 .irow &%acl_smtp_starttls%&    "ACL for STARTTLS"
30495 .irow &%acl_smtp_vrfy%&        "ACL for VRFY"
30496 .endtable
30497
30498 For example, if you set
30499 .code
30500 acl_smtp_rcpt = small_acl
30501 .endd
30502 the little ACL defined above is used whenever Exim receives a RCPT command
30503 in an SMTP dialogue. The majority of policy tests on incoming messages can be
30504 done when RCPT commands arrive. A rejection of RCPT should cause the
30505 sending MTA to give up on the recipient address contained in the RCPT
30506 command, whereas rejection at other times may cause the client MTA to keep on
30507 trying to deliver the message. It is therefore recommended that you do as much
30508 testing as possible at RCPT time.
30509
30510
30511 .section "The non-SMTP ACLs" "SECID190"
30512 .cindex "non-SMTP messages" "ACLs for"
30513 The non-SMTP ACLs apply to all non-interactive incoming messages, that is, they
30514 apply to batched SMTP as well as to non-SMTP messages. (Batched SMTP is not
30515 really SMTP.) Many of the ACL conditions (for example, host tests, and tests on
30516 the state of the SMTP connection such as encryption and authentication) are not
30517 relevant and are forbidden in these ACLs. However, the sender and recipients
30518 are known, so the &%senders%& and &%sender_domains%& conditions and the
30519 &$sender_address$& and &$recipients$& variables can be used. Variables such as
30520 &$authenticated_sender$& are also available. You can specify added header lines
30521 in any of these ACLs.
30522
30523 The &%acl_not_smtp_start%& ACL is run right at the start of receiving a
30524 non-SMTP message, before any of the message has been read. (This is the
30525 analogue of the &%acl_smtp_predata%& ACL for SMTP input.) In the case of
30526 batched SMTP input, it runs after the DATA command has been reached. The
30527 result of this ACL is ignored; it cannot be used to reject a message. If you
30528 really need to, you could set a value in an ACL variable here and reject based
30529 on that in the &%acl_not_smtp%& ACL. However, this ACL can be used to set
30530 controls, and in particular, it can be used to set
30531 .code
30532 control = suppress_local_fixups
30533 .endd
30534 This cannot be used in the other non-SMTP ACLs because by the time they are
30535 run, it is too late.
30536
30537 The &%acl_not_smtp_mime%& ACL is available only when Exim is compiled with the
30538 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
30539
30540 The &%acl_not_smtp%& ACL is run just before the &[local_scan()]& function. Any
30541 kind of rejection is treated as permanent, because there is no way of sending a
30542 temporary error for these kinds of message.
30543
30544
30545 .section "The SMTP connect ACL" "SECID191"
30546 .cindex "SMTP" "connection, ACL for"
30547 .oindex &%smtp_banner%&
30548 The ACL test specified by &%acl_smtp_connect%& happens at the start of an SMTP
30549 session, after the test specified by &%host_reject_connection%& (which is now
30550 an anomaly) and any TCP Wrappers testing (if configured). If the connection is
30551 accepted by an &%accept%& verb that has a &%message%& modifier, the contents of
30552 the message override the banner message that is otherwise specified by the
30553 &%smtp_banner%& option.
30554
30555
30556 .section "The EHLO/HELO ACL" "SECID192"
30557 .cindex "EHLO" "ACL for"
30558 .cindex "HELO" "ACL for"
30559 The ACL test specified by &%acl_smtp_helo%& happens when the client issues an
30560 EHLO or HELO command, after the tests specified by &%helo_accept_junk_hosts%&,
30561 &%helo_allow_chars%&, &%helo_verify_hosts%&, and &%helo_try_verify_hosts%&.
30562 Note that a client may issue more than one EHLO or HELO command in an SMTP
30563 session, and indeed is required to issue a new EHLO or HELO after successfully
30564 setting up encryption following a STARTTLS command.
30565
30566 Note also that a deny neither forces the client to go away nor means that
30567 mail will be refused on the connection.  Consider checking for
30568 &$sender_helo_name$& being defined in a MAIL or RCPT ACL to do that.
30569
30570 If the command is accepted by an &%accept%& verb that has a &%message%&
30571 modifier, the message may not contain more than one line (it will be truncated
30572 at the first newline and a panic logged if it does). Such a message cannot
30573 affect the EHLO options that are listed on the second and subsequent lines of
30574 an EHLO response.
30575
30576
30577 .section "The DATA ACLs" "SECID193"
30578 .cindex "DATA" "ACLs for"
30579 Two ACLs are associated with the DATA command, because it is two-stage
30580 command, with two responses being sent to the client.
30581 When the DATA command is received, the ACL defined by &%acl_smtp_predata%&
30582 is obeyed. This gives you control after all the RCPT commands, but before
30583 the message itself is received. It offers the opportunity to give a negative
30584 response to the DATA command before the data is transmitted. Header lines
30585 added by MAIL or RCPT ACLs are not visible at this time, but any that
30586 are defined here are visible when the &%acl_smtp_data%& ACL is run.
30587
30588 You cannot test the contents of the message, for example, to verify addresses
30589 in the headers, at RCPT time or when the DATA command is received. Such
30590 tests have to appear in the ACL that is run after the message itself has been
30591 received, before the final response to the DATA command is sent. This is
30592 the ACL specified by &%acl_smtp_data%&, which is the second ACL that is
30593 associated with the DATA command.
30594
30595 .cindex CHUNKING "BDAT command"
30596 .cindex BDAT "SMTP command"
30597 .cindex "RFC 3030" CHUNKING
30598 If CHUNKING was advertised and a BDAT command sequence is received,
30599 the &%acl_smtp_predata%& ACL is not run.
30600 . XXX why not?  It should be possible, for the first BDAT.
30601 The &%acl_smtp_data%& is run after the last BDAT command and all of
30602 the data specified is received.
30603
30604 For both of these ACLs, it is not possible to reject individual recipients. An
30605 error response rejects the entire message. Unfortunately, it is known that some
30606 MTAs do not treat hard (5&'xx'&) responses to the DATA command (either
30607 before or after the data) correctly &-- they keep the message on their queues
30608 and try again later, but that is their problem, though it does waste some of
30609 your resources.
30610
30611 The &%acl_smtp_data%& ACL is run after
30612 the &%acl_smtp_data_prdr%&,
30613 the &%acl_smtp_dkim%&
30614 and the &%acl_smtp_mime%& ACLs.
30615
30616 .section "The SMTP DKIM ACL" "SECTDKIMACL"
30617 The &%acl_smtp_dkim%& ACL is available only when Exim is compiled with DKIM support
30618 enabled (which is the default).
30619
30620 The ACL test specified by &%acl_smtp_dkim%& happens after a message has been
30621 received, and is executed for each DKIM signature found in a message.  If not
30622 otherwise specified, the default action is to accept.
30623
30624 This ACL is evaluated before &%acl_smtp_mime%& and &%acl_smtp_data%&.
30625
30626 For details on the operation of DKIM, see section &<<SECDKIM>>&.
30627
30628
30629 .section "The SMTP MIME ACL" "SECID194"
30630 The &%acl_smtp_mime%& option is available only when Exim is compiled with the
30631 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
30632
30633 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
30634
30635
30636 .section "The SMTP PRDR ACL" "SECTPRDRACL"
30637 .cindex "PRDR" "ACL for"
30638 .oindex "&%prdr_enable%&"
30639 The &%acl_smtp_data_prdr%& ACL is available only when Exim is compiled
30640 with PRDR support enabled (which is the default).
30641 It becomes active only when the PRDR feature is negotiated between
30642 client and server for a message, and more than one recipient
30643 has been accepted.
30644
30645 The ACL test specified by &%acl_smtp_data_prdr%& happens after a message
30646 has been received, and is executed once for each recipient of the message
30647 with &$local_part$& and &$domain$& valid.
30648 The test may accept, defer or deny for individual recipients.
30649 The &%acl_smtp_data%& will still be called after this ACL and
30650 can reject the message overall, even if this ACL has accepted it
30651 for some or all recipients.
30652
30653 PRDR may be used to support per-user content filtering.  Without it
30654 one must defer any recipient after the first that has a different
30655 content-filter configuration.  With PRDR, the RCPT-time check
30656 .cindex "PRDR" "variable for"
30657 for this can be disabled when the variable &$prdr_requested$&
30658 is &"yes"&.
30659 Any required difference in behaviour of the main DATA-time
30660 ACL should however depend on the PRDR-time ACL having run, as Exim
30661 will avoid doing so in some situations (e.g. single-recipient mails).
30662
30663 See also the &%prdr_enable%& global option
30664 and the &%hosts_try_prdr%& smtp transport option.
30665
30666 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
30667 If the ACL is not defined, processing completes as if
30668 the feature was not requested by the client.
30669
30670 .section "The QUIT ACL" "SECTQUITACL"
30671 .cindex "QUIT, ACL for"
30672 The ACL for the SMTP QUIT command is anomalous, in that the outcome of the ACL
30673 does not affect the response code to QUIT, which is always 221. Thus, the ACL
30674 does not in fact control any access.
30675 For this reason, it may only accept
30676 or warn as its final result.
30677
30678 This ACL can be used for tasks such as custom logging at the end of an SMTP
30679 session. For example, you can use ACL variables in other ACLs to count
30680 messages, recipients, etc., and log the totals at QUIT time using one or
30681 more &%logwrite%& modifiers on a &%warn%& verb.
30682
30683 &*Warning*&: Only the &$acl_c$&&'x'& variables can be used for this, because
30684 the &$acl_m$&&'x'& variables are reset at the end of each incoming message.
30685
30686 You do not need to have a final &%accept%&, but if you do, you can use a
30687 &%message%& modifier to specify custom text that is sent as part of the 221
30688 response to QUIT.
30689
30690 This ACL is run only for a &"normal"& QUIT. For certain kinds of disastrous
30691 failure (for example, failure to open a log file, or when Exim is bombing out
30692 because it has detected an unrecoverable error), all SMTP commands from the
30693 client are given temporary error responses until QUIT is received or the
30694 connection is closed. In these special cases, the QUIT ACL does not run.
30695
30696
30697 .section "The not-QUIT ACL" "SECTNOTQUITACL"
30698 .vindex &$acl_smtp_notquit$&
30699 The not-QUIT ACL, specified by &%acl_smtp_notquit%&, is run in most cases when
30700 an SMTP session ends without sending QUIT. However, when Exim itself is in bad
30701 trouble, such as being unable to write to its log files, this ACL is not run,
30702 because it might try to do things (such as write to log files) that make the
30703 situation even worse.
30704
30705 Like the QUIT ACL, this ACL is provided to make it possible to do customized
30706 logging or to gather statistics, and its outcome is ignored. The &%delay%&
30707 modifier is forbidden in this ACL, and the only permitted verbs are &%accept%&
30708 and &%warn%&.
30709
30710 .vindex &$smtp_notquit_reason$&
30711 When the not-QUIT ACL is running, the variable &$smtp_notquit_reason$& is set
30712 to a string that indicates the reason for the termination of the SMTP
30713 connection. The possible values are:
30714 .table2
30715 .irow &`acl-drop`&                 "Another ACL issued a &%drop%& command"
30716 .irow &`bad-commands`&             "Too many unknown or non-mail commands"
30717 .irow &`command-timeout`&          "Timeout while reading SMTP commands"
30718 .irow &`connection-lost`&          "The SMTP connection has been lost"
30719 .irow &`data-timeout`&             "Timeout while reading message data"
30720 .irow &`local-scan-error`&         "The &[local_scan()]& function crashed"
30721 .irow &`local-scan-timeout`&       "The &[local_scan()]& function timed out"
30722 .irow &`signal-exit`&              "SIGTERM or SIGINT"
30723 .irow &`synchronization-error`&    "SMTP synchronization error"
30724 .irow &`tls-failed`&               "TLS failed to start"
30725 .endtable
30726 In most cases when an SMTP connection is closed without having received QUIT,
30727 Exim sends an SMTP response message before actually closing the connection.
30728 With the exception of the &`acl-drop`& case, the default message can be
30729 overridden by the &%message%& modifier in the not-QUIT ACL. In the case of a
30730 &%drop%& verb in another ACL, it is the message from the other ACL that is
30731 used.
30732
30733
30734 .section "Finding an ACL to use" "SECID195"
30735 .cindex "&ACL;" "finding which to use"
30736 The value of an &%acl_smtp_%&&'xxx'& option is expanded before use, so
30737 you can use different ACLs in different circumstances. For example,
30738 .code
30739 acl_smtp_rcpt = ${if ={25}{$interface_port} \
30740                      {acl_check_rcpt} {acl_check_rcpt_submit} }
30741 .endd
30742 In the default configuration file there are some example settings for
30743 providing an RFC 4409 message &"submission"& service on port 587 and
30744 an RFC 8314 &"submissions"& service on port 465. You can use a string
30745 expansion like this to choose an ACL for MUAs on these ports which is
30746 more appropriate for this purpose than the default ACL on port 25.
30747
30748 The expanded string does not have to be the name of an ACL in the
30749 configuration file; there are other possibilities. Having expanded the
30750 string, Exim searches for an ACL as follows:
30751
30752 .ilist
30753 If the string begins with a slash, Exim uses it as a filename, and reads its
30754 contents as an ACL. The lines are processed in the same way as lines in the
30755 Exim configuration file. In particular, continuation lines are supported, blank
30756 lines are ignored, as are lines whose first non-whitespace character is &"#"&.
30757 If the file does not exist or cannot be read, an error occurs (typically
30758 causing a temporary failure of whatever caused the ACL to be run). For example:
30759 .code
30760 acl_smtp_data = /etc/acls/\
30761   ${lookup{$sender_host_address}lsearch\
30762   {/etc/acllist}{$value}{default}}
30763 .endd
30764 This looks up an ACL file to use on the basis of the host's IP address, falling
30765 back to a default if the lookup fails. If an ACL is successfully read from a
30766 file, it is retained in memory for the duration of the Exim process, so that it
30767 can be re-used without having to re-read the file.
30768 .next
30769 If the string does not start with a slash, and does not contain any spaces,
30770 Exim searches the ACL section of the configuration for an ACL whose name
30771 matches the string.
30772 .next
30773 If no named ACL is found, or if the string contains spaces, Exim parses
30774 the string as an inline ACL. This can save typing in cases where you just
30775 want to have something like
30776 .code
30777 acl_smtp_vrfy = accept
30778 .endd
30779 in order to allow free use of the VRFY command. Such a string may contain
30780 newlines; it is processed in the same way as an ACL that is read from a file.
30781 .endlist
30782
30783
30784
30785
30786 .section "ACL return codes" "SECID196"
30787 .cindex "&ACL;" "return codes"
30788 Except for the QUIT ACL, which does not affect the SMTP return code (see
30789 section &<<SECTQUITACL>>& above), the result of running an ACL is either
30790 &"accept"& or &"deny"&, or, if some test cannot be completed (for example, if a
30791 database is down), &"defer"&. These results cause 2&'xx'&, 5&'xx'&, and 4&'xx'&
30792 return codes, respectively, to be used in the SMTP dialogue. A fourth return,
30793 &"error"&, occurs when there is an error such as invalid syntax in the ACL.
30794 This also causes a 4&'xx'& return code.
30795
30796 For the non-SMTP ACL, &"defer"& and &"error"& are treated in the same way as
30797 &"deny"&, because there is no mechanism for passing temporary errors to the
30798 submitters of non-SMTP messages.
30799
30800
30801 ACLs that are relevant to message reception may also return &"discard"&. This
30802 has the effect of &"accept"&, but causes either the entire message or an
30803 individual recipient address to be discarded. In other words, it is a
30804 blackholing facility. Use it with care.
30805
30806 If the ACL for MAIL returns &"discard"&, all recipients are discarded, and no
30807 ACL is run for subsequent RCPT commands. The effect of &"discard"& in a
30808 RCPT ACL is to discard just the one recipient address. If there are no
30809 recipients left when the message's data is received, the DATA ACL is not
30810 run. A &"discard"& return from the DATA or the non-SMTP ACL discards all the
30811 remaining recipients. The &"discard"& return is not permitted for the
30812 &%acl_smtp_predata%& ACL.
30813
30814 If the ACL for VRFY returns &"accept"&, a recipient verify (without callout)
30815 is done on the address and the result determines the SMTP response.
30816
30817
30818 .cindex "&[local_scan()]& function" "when all recipients discarded"
30819 The &[local_scan()]& function is always run, even if there are no remaining
30820 recipients; it may create new recipients.
30821
30822
30823
30824 .section "Unset ACL options" "SECID197"
30825 .cindex "&ACL;" "unset options"
30826 The default actions when any of the &%acl_%&&'xxx'& options are unset are not
30827 all the same. &*Note*&: These defaults apply only when the relevant ACL is
30828 not defined at all. For any defined ACL, the default action when control
30829 reaches the end of the ACL statements is &"deny"&.
30830
30831 For &%acl_smtp_quit%& and &%acl_not_smtp_start%& there is no default because
30832 these two are ACLs that are used only for their side effects. They cannot be
30833 used to accept or reject anything.
30834
30835 For &%acl_not_smtp%&, &%acl_smtp_auth%&, &%acl_smtp_connect%&,
30836 &%acl_smtp_data%&, &%acl_smtp_helo%&, &%acl_smtp_mail%&, &%acl_smtp_mailauth%&,
30837 &%acl_smtp_mime%&, &%acl_smtp_predata%&, and &%acl_smtp_starttls%&, the action
30838 when the ACL is not defined is &"accept"&.
30839
30840 For the others (&%acl_smtp_etrn%&, &%acl_smtp_expn%&, &%acl_smtp_rcpt%&, and
30841 &%acl_smtp_vrfy%&), the action when the ACL is not defined is &"deny"&.
30842 This means that &%acl_smtp_rcpt%& must be defined in order to receive any
30843 messages over an SMTP connection. For an example, see the ACL in the default
30844 configuration file.
30845
30846
30847
30848
30849 .section "Data for message ACLs" "SECID198"
30850 .cindex "&ACL;" "data for message ACL"
30851 .vindex &$domain$&
30852 .vindex &$local_part$&
30853 .vindex &$sender_address$&
30854 .vindex &$sender_host_address$&
30855 .vindex &$smtp_command$&
30856 When a MAIL or RCPT ACL, or either of the DATA ACLs, is running, the variables
30857 that contain information about the host and the message's sender (for example,
30858 &$sender_host_address$& and &$sender_address$&) are set, and can be used in ACL
30859 statements. In the case of RCPT (but not MAIL or DATA), &$domain$& and
30860 &$local_part$& are set from the argument address. The entire SMTP command
30861 is available in &$smtp_command$&.
30862
30863 When an ACL for the AUTH parameter of MAIL is running, the variables that
30864 contain information about the host are set, but &$sender_address$& is not yet
30865 set. Section &<<SECTauthparamail>>& contains a discussion of this parameter and
30866 how it is used.
30867
30868 .vindex "&$message_size$&"
30869 The &$message_size$& variable is set to the value of the SIZE parameter on
30870 the MAIL command at MAIL, RCPT and pre-data time, or to -1 if
30871 that parameter is not given. The value is updated to the true message size by
30872 the time the final DATA ACL is run (after the message data has been
30873 received).
30874
30875 .vindex "&$rcpt_count$&"
30876 .vindex "&$recipients_count$&"
30877 The &$rcpt_count$& variable increases by one for each RCPT command received.
30878 The &$recipients_count$& variable increases by one each time a RCPT command is
30879 accepted, so while an ACL for RCPT is being processed, it contains the number
30880 of previously accepted recipients. At DATA time (for both the DATA ACLs),
30881 &$rcpt_count$& contains the total number of RCPT commands, and
30882 &$recipients_count$& contains the total number of accepted recipients.
30883
30884
30885
30886
30887
30888 .section "Data for non-message ACLs" "SECTdatfornon"
30889 .cindex "&ACL;" "data for non-message ACL"
30890 .vindex &$smtp_command_argument$&
30891 .vindex &$smtp_command$&
30892 When an ACL is being run for AUTH, EHLO, ETRN, EXPN, HELO, STARTTLS, or VRFY,
30893 the remainder of the SMTP command line is placed in &$smtp_command_argument$&,
30894 and the entire SMTP command is available in &$smtp_command$&.
30895 These variables can be tested using a &%condition%& condition. For example,
30896 here is an ACL for use with AUTH, which insists that either the session is
30897 encrypted, or the CRAM-MD5 authentication method is used. In other words, it
30898 does not permit authentication methods that use cleartext passwords on
30899 unencrypted connections.
30900 .code
30901 acl_check_auth:
30902   accept encrypted = *
30903   accept condition = ${if eq{${uc:$smtp_command_argument}}\
30904                      {CRAM-MD5}}
30905   deny   message   = TLS encryption or CRAM-MD5 required
30906 .endd
30907 (Another way of applying this restriction is to arrange for the authenticators
30908 that use cleartext passwords not to be advertised when the connection is not
30909 encrypted. You can use the generic &%server_advertise_condition%& authenticator
30910 option to do this.)
30911
30912
30913
30914 .section "Format of an ACL" "SECID199"
30915 .cindex "&ACL;" "format of"
30916 .cindex "&ACL;" "verbs, definition of"
30917 An individual ACL consists of a number of statements. Each statement starts
30918 with a verb, optionally followed by a number of conditions and &"modifiers"&.
30919 Modifiers can change the way the verb operates, define error and log messages,
30920 set variables, insert delays, and vary the processing of accepted messages.
30921
30922 If all the conditions are met, the verb is obeyed. The same condition may be
30923 used (with different arguments) more than once in the same statement. This
30924 provides a means of specifying an &"and"& conjunction between conditions. For
30925 example:
30926 .code
30927 deny  dnslists = list1.example
30928       dnslists = list2.example
30929 .endd
30930 If there are no conditions, the verb is always obeyed. Exim stops evaluating
30931 the conditions and modifiers when it reaches a condition that fails. What
30932 happens then depends on the verb (and in one case, on a special modifier). Not
30933 all the conditions make sense at every testing point. For example, you cannot
30934 test a sender address in the ACL that is run for a VRFY command.
30935
30936
30937 .section "ACL verbs" "SECID200"
30938 The ACL verbs are as follows:
30939
30940 .ilist
30941 .cindex "&%accept%& ACL verb"
30942 &%accept%&: If all the conditions are met, the ACL returns &"accept"&. If any
30943 of the conditions are not met, what happens depends on whether &%endpass%&
30944 appears among the conditions (for syntax see below). If the failing condition
30945 is before &%endpass%&, control is passed to the next ACL statement; if it is
30946 after &%endpass%&, the ACL returns &"deny"&. Consider this statement, used to
30947 check a RCPT command:
30948 .code
30949 accept domains = +local_domains
30950        endpass
30951        verify = recipient
30952 .endd
30953 If the recipient domain does not match the &%domains%& condition, control
30954 passes to the next statement. If it does match, the recipient is verified, and
30955 the command is accepted if verification succeeds. However, if verification
30956 fails, the ACL yields &"deny"&, because the failing condition is after
30957 &%endpass%&.
30958
30959 The &%endpass%& feature has turned out to be confusing to many people, so its
30960 use is not recommended nowadays. It is always possible to rewrite an ACL so
30961 that &%endpass%& is not needed, and it is no longer used in the default
30962 configuration.
30963
30964 .cindex "&%message%& ACL modifier" "with &%accept%&"
30965 If a &%message%& modifier appears on an &%accept%& statement, its action
30966 depends on whether or not &%endpass%& is present. In the absence of &%endpass%&
30967 (when an &%accept%& verb either accepts or passes control to the next
30968 statement), &%message%& can be used to vary the message that is sent when an
30969 SMTP command is accepted. For example, in a RCPT ACL you could have:
30970 .display
30971 &`accept  `&<&'some conditions'&>
30972 &`        message = OK, I will allow you through today`&
30973 .endd
30974 You can specify an SMTP response code, optionally followed by an &"extended
30975 response code"& at the start of the message, but the first digit must be the
30976 same as would be sent by default, which is 2 for an &%accept%& verb.
30977
30978 If &%endpass%& is present in an &%accept%& statement, &%message%& specifies
30979 an error message that is used when access is denied. This behaviour is retained
30980 for backward compatibility, but current &"best practice"& is to avoid the use
30981 of &%endpass%&.
30982
30983
30984 .next
30985 .cindex "&%defer%& ACL verb"
30986 &%defer%&: If all the conditions are true, the ACL returns &"defer"& which, in
30987 an SMTP session, causes a 4&'xx'& response to be given. For a non-SMTP ACL,
30988 &%defer%& is the same as &%deny%&, because there is no way of sending a
30989 temporary error. For a RCPT command, &%defer%& is much the same as using a
30990 &(redirect)& router and &`:defer:`& while verifying, but the &%defer%& verb can
30991 be used in any ACL, and even for a recipient it might be a simpler approach.
30992
30993
30994 .next
30995 .cindex "&%deny%& ACL verb"
30996 &%deny%&: If all the conditions are met, the ACL returns &"deny"&. If any of
30997 the conditions are not met, control is passed to the next ACL statement. For
30998 example,
30999 .code
31000 deny dnslists = blackholes.mail-abuse.org
31001 .endd
31002 rejects commands from hosts that are on a DNS black list.
31003
31004
31005 .next
31006 .cindex "&%discard%& ACL verb"
31007 &%discard%&: This verb behaves like &%accept%&, except that it returns
31008 &"discard"& from the ACL instead of &"accept"&. It is permitted only on ACLs
31009 that are concerned with receiving messages. When all the conditions are true,
31010 the sending entity receives a &"success"& response. However, &%discard%& causes
31011 recipients to be discarded. If it is used in an ACL for RCPT, just the one
31012 recipient is discarded; if used for MAIL, DATA or in the non-SMTP ACL, all the
31013 message's recipients are discarded. Recipients that are discarded before DATA
31014 do not appear in the log line when the &%received_recipients%& log selector is set.
31015
31016 If the &%log_message%& modifier is set when &%discard%& operates,
31017 its contents are added to the line that is automatically written to the log.
31018 The &%message%& modifier operates exactly as it does for &%accept%&.
31019
31020
31021 .next
31022 .cindex "&%drop%& ACL verb"
31023 &%drop%&: This verb behaves like &%deny%&, except that an SMTP connection is
31024 forcibly closed after the 5&'xx'& error message has been sent. For example:
31025 .code
31026 drop   condition = ${if > {$rcpt_count}{20}}
31027        message   = I don't take more than 20 RCPTs
31028 .endd
31029 There is no difference between &%deny%& and &%drop%& for the connect-time ACL.
31030 The connection is always dropped after sending a 550 response.
31031
31032 .next
31033 .cindex "&%require%& ACL verb"
31034 &%require%&: If all the conditions are met, control is passed to the next ACL
31035 statement. If any of the conditions are not met, the ACL returns &"deny"&. For
31036 example, when checking a RCPT command,
31037 .code
31038 require message = Sender did not verify
31039         verify  = sender
31040 .endd
31041 passes control to subsequent statements only if the message's sender can be
31042 verified. Otherwise, it rejects the command. Note the positioning of the
31043 &%message%& modifier, before the &%verify%& condition. The reason for this is
31044 discussed in section &<<SECTcondmodproc>>&.
31045
31046 .next
31047 .cindex "&%warn%& ACL verb"
31048 &%warn%&: If all the conditions are true, a line specified by the
31049 &%log_message%& modifier is written to Exim's main log. Control always passes
31050 to the next ACL statement. If any condition is false, the log line is not
31051 written. If an identical log line is requested several times in the same
31052 message, only one copy is actually written to the log. If you want to force
31053 duplicates to be written, use the &%logwrite%& modifier instead.
31054
31055 If &%log_message%& is not present, a &%warn%& verb just checks its conditions
31056 and obeys any &"immediate"& modifiers (such as &%control%&, &%set%&,
31057 &%logwrite%&, &%add_header%&, and &%remove_header%&) that appear before the
31058 first failing condition. There is more about adding header lines in section
31059 &<<SECTaddheadacl>>&.
31060
31061 If any condition on a &%warn%& statement cannot be completed (that is, there is
31062 some sort of defer), the log line specified by &%log_message%& is not written.
31063 This does not include the case of a forced failure from a lookup, which
31064 is considered to be a successful completion. After a defer, no further
31065 conditions or modifiers in the &%warn%& statement are processed. The incident
31066 is logged, and the ACL continues to be processed, from the next statement
31067 onwards.
31068
31069
31070 .vindex "&$acl_verify_message$&"
31071 When one of the &%warn%& conditions is an address verification that fails, the
31072 text of the verification failure message is in &$acl_verify_message$&. If you
31073 want this logged, you must set it up explicitly. For example:
31074 .code
31075 warn   !verify = sender
31076        log_message = sender verify failed: $acl_verify_message
31077 .endd
31078 .endlist
31079
31080 At the end of each ACL there is an implicit unconditional &%deny%&.
31081
31082 As you can see from the examples above, the conditions and modifiers are
31083 written one to a line, with the first one on the same line as the verb, and
31084 subsequent ones on following lines. If you have a very long condition, you can
31085 continue it onto several physical lines by the usual backslash continuation
31086 mechanism. It is conventional to align the conditions vertically.
31087
31088
31089
31090 .section "ACL variables" "SECTaclvariables"
31091 .cindex "&ACL;" "variables"
31092 There are some special variables that can be set during ACL processing. They
31093 can be used to pass information between different ACLs, different invocations
31094 of the same ACL in the same SMTP connection, and between ACLs and the routers,
31095 transports, and filters that are used to deliver a message. The names of these
31096 variables must begin with &$acl_c$& or &$acl_m$&, followed either by a digit or
31097 an underscore, but the remainder of the name can be any sequence of
31098 alphanumeric characters and underscores that you choose. There is no limit on
31099 the number of ACL variables. The two sets act as follows:
31100 .ilist
31101 The values of those variables whose names begin with &$acl_c$& persist
31102 throughout an SMTP connection. They are never reset. Thus, a value that is set
31103 while receiving one message is still available when receiving the next message
31104 on the same SMTP connection.
31105 .next
31106 The values of those variables whose names begin with &$acl_m$& persist only
31107 while a message is being received. They are reset afterwards. They are also
31108 reset by MAIL, RSET, EHLO, HELO, and after starting up a TLS session.
31109 .endlist
31110
31111 When a message is accepted, the current values of all the ACL variables are
31112 preserved with the message and are subsequently made available at delivery
31113 time. The ACL variables are set by a modifier called &%set%&. For example:
31114 .code
31115 accept hosts = whatever
31116        set acl_m4 = some value
31117 accept authenticated = *
31118        set acl_c_auth = yes
31119 .endd
31120 &*Note*&: A leading dollar sign is not used when naming a variable that is to
31121 be set. If you want to set a variable without taking any action, you can use a
31122 &%warn%& verb without any other modifiers or conditions.
31123
31124 .oindex &%strict_acl_vars%&
31125 What happens if a syntactically valid but undefined ACL variable is
31126 referenced depends on the setting of the &%strict_acl_vars%& option. If it is
31127 false (the default), an empty string is substituted; if it is true, an
31128 error is generated.
31129
31130 Versions of Exim before 4.64 have a limited set of numbered variables, but
31131 their names are compatible, so there is no problem with upgrading.
31132
31133
31134 .section "Condition and modifier processing" "SECTcondmodproc"
31135 .cindex "&ACL;" "conditions; processing"
31136 .cindex "&ACL;" "modifiers; processing"
31137 An exclamation mark preceding a condition negates its result. For example:
31138 .code
31139 deny   domains = *.dom.example
31140       !verify  = recipient
31141 .endd
31142 causes the ACL to return &"deny"& if the recipient domain ends in
31143 &'dom.example'& and the recipient address cannot be verified. Sometimes
31144 negation can be used on the right-hand side of a condition. For example, these
31145 two statements are equivalent:
31146 .code
31147 deny  hosts = !192.168.3.4
31148 deny !hosts =  192.168.3.4
31149 .endd
31150 However, for many conditions (&%verify%& being a good example), only left-hand
31151 side negation of the whole condition is possible.
31152
31153 The arguments of conditions and modifiers are expanded. A forced failure
31154 of an expansion causes a condition to be ignored, that is, it behaves as if the
31155 condition is true. Consider these two statements:
31156 .code
31157 accept  senders = ${lookup{$host_name}lsearch\
31158                   {/some/file}{$value}fail}
31159 accept  senders = ${lookup{$host_name}lsearch\
31160                   {/some/file}{$value}{}}
31161 .endd
31162 Each attempts to look up a list of acceptable senders. If the lookup succeeds,
31163 the returned list is searched, but if the lookup fails the behaviour is
31164 different in the two cases. The &%fail%& in the first statement causes the
31165 condition to be ignored, leaving no further conditions. The &%accept%& verb
31166 therefore succeeds. The second statement, however, generates an empty list when
31167 the lookup fails. No sender can match an empty list, so the condition fails,
31168 and therefore the &%accept%& also fails.
31169
31170 ACL modifiers appear mixed in with conditions in ACL statements. Some of them
31171 specify actions that are taken as the conditions for a statement are checked;
31172 others specify text for messages that are used when access is denied or a
31173 warning is generated. The &%control%& modifier affects the way an incoming
31174 message is handled.
31175
31176 The positioning of the modifiers in an ACL statement is important, because the
31177 processing of a verb ceases as soon as its outcome is known. Only those
31178 modifiers that have already been encountered will take effect. For example,
31179 consider this use of the &%message%& modifier:
31180 .code
31181 require message = Can't verify sender
31182         verify  = sender
31183         message = Can't verify recipient
31184         verify  = recipient
31185         message = This message cannot be used
31186 .endd
31187 If sender verification fails, Exim knows that the result of the statement is
31188 &"deny"&, so it goes no further. The first &%message%& modifier has been seen,
31189 so its text is used as the error message. If sender verification succeeds, but
31190 recipient verification fails, the second message is used. If recipient
31191 verification succeeds, the third message becomes &"current"&, but is never used
31192 because there are no more conditions to cause failure.
31193
31194 For the &%deny%& verb, on the other hand, it is always the last &%message%&
31195 modifier that is used, because all the conditions must be true for rejection to
31196 happen. Specifying more than one &%message%& modifier does not make sense, and
31197 the message can even be specified after all the conditions. For example:
31198 .code
31199 deny   hosts = ...
31200       !senders = *@my.domain.example
31201        message = Invalid sender from client host
31202 .endd
31203 The &"deny"& result does not happen until the end of the statement is reached,
31204 by which time Exim has set up the message.
31205
31206
31207
31208 .section "ACL modifiers" "SECTACLmodi"
31209 .cindex "&ACL;" "modifiers; list of"
31210 The ACL modifiers are as follows:
31211
31212 .vlist
31213 .vitem &*add_header*&&~=&~<&'text'&>
31214 This modifier specifies one or more header lines that are to be added to an
31215 incoming message, assuming, of course, that the message is ultimately
31216 accepted. For details, see section &<<SECTaddheadacl>>&.
31217
31218 .vitem &*continue*&&~=&~<&'text'&>
31219 .cindex "&%continue%& ACL modifier"
31220 .cindex "database" "updating in ACL"
31221 This modifier does nothing of itself, and processing of the ACL always
31222 continues with the next condition or modifier. The value of &%continue%& is in
31223 the side effects of expanding its argument. Typically this could be used to
31224 update a database. It is really just a syntactic tidiness, to avoid having to
31225 write rather ugly lines like this:
31226 .display
31227 &`condition = ${if eq{0}{`&<&'some expansion'&>&`}{true}{true}}`&
31228 .endd
31229 Instead, all you need is
31230 .display
31231 &`continue = `&<&'some expansion'&>
31232 .endd
31233
31234 .vitem &*control*&&~=&~<&'text'&>
31235 .cindex "&%control%& ACL modifier"
31236 This modifier affects the subsequent processing of the SMTP connection or of an
31237 incoming message that is accepted. The effect of the first type of control
31238 lasts for the duration of the connection, whereas the effect of the second type
31239 lasts only until the current message has been received. The message-specific
31240 controls always apply to the whole message, not to individual recipients,
31241 even if the &%control%& modifier appears in a RCPT ACL.
31242
31243 As there are now quite a few controls that can be applied, they are described
31244 separately in section &<<SECTcontrols>>&. The &%control%& modifier can be used
31245 in several different ways. For example:
31246
31247 . ==== As this is a nested list, any displays it contains must be indented
31248 . ==== as otherwise they are too far to the left. That comment applies only
31249 . ==== when xmlto and fop are used; formatting with sdop gets it right either
31250 . ==== way.
31251
31252 .ilist
31253 It can be at the end of an &%accept%& statement:
31254 .code
31255     accept  ...some conditions
31256             control = queue
31257 .endd
31258 In this case, the control is applied when this statement yields &"accept"&, in
31259 other words, when the conditions are all true.
31260
31261 .next
31262 It can be in the middle of an &%accept%& statement:
31263 .code
31264     accept  ...some conditions...
31265             control = queue
31266             ...some more conditions...
31267 .endd
31268 If the first set of conditions are true, the control is applied, even if the
31269 statement does not accept because one of the second set of conditions is false.
31270 In this case, some subsequent statement must yield &"accept"& for the control
31271 to be relevant.
31272
31273 .next
31274 It can be used with &%warn%& to apply the control, leaving the
31275 decision about accepting or denying to a subsequent verb. For
31276 example:
31277 .code
31278     warn    ...some conditions...
31279             control = freeze
31280     accept  ...
31281 .endd
31282 This example of &%warn%& does not contain &%message%&, &%log_message%&, or
31283 &%logwrite%&, so it does not add anything to the message and does not write a
31284 log entry.
31285
31286 .next
31287 If you want to apply a control unconditionally, you can use it with a
31288 &%require%& verb. For example:
31289 .code
31290     require  control = no_multiline_responses
31291 .endd
31292 .endlist
31293
31294 .vitem &*delay*&&~=&~<&'time'&>
31295 .cindex "&%delay%& ACL modifier"
31296 .oindex "&%-bh%&"
31297 This modifier may appear in any ACL except notquit. It causes Exim to wait for
31298 the time interval before proceeding. However, when testing Exim using the
31299 &%-bh%& option, the delay is not actually imposed (an appropriate message is
31300 output instead). The time is given in the usual Exim notation, and the delay
31301 happens as soon as the modifier is processed. In an SMTP session, pending
31302 output is flushed before the delay is imposed.
31303
31304 Like &%control%&, &%delay%& can be used with &%accept%& or &%deny%&, for
31305 example:
31306 .code
31307 deny    ...some conditions...
31308         delay = 30s
31309 .endd
31310 The delay happens if all the conditions are true, before the statement returns
31311 &"deny"&. Compare this with:
31312 .code
31313 deny    delay = 30s
31314         ...some conditions...
31315 .endd
31316 which waits for 30s before processing the conditions. The &%delay%& modifier
31317 can also be used with &%warn%& and together with &%control%&:
31318 .code
31319 warn    ...some conditions...
31320         delay = 2m
31321         control = freeze
31322 accept  ...
31323 .endd
31324
31325 If &%delay%& is encountered when the SMTP PIPELINING extension is in use,
31326 responses to several commands are no longer buffered and sent in one packet (as
31327 they would normally be) because all output is flushed before imposing the
31328 delay. This optimization is disabled so that a number of small delays do not
31329 appear to the client as one large aggregated delay that might provoke an
31330 unwanted timeout. You can, however, disable output flushing for &%delay%& by
31331 using a &%control%& modifier to set &%no_delay_flush%&.
31332
31333
31334 .vitem &*endpass*&
31335 .cindex "&%endpass%& ACL modifier"
31336 This modifier, which has no argument, is recognized only in &%accept%& and
31337 &%discard%& statements. It marks the boundary between the conditions whose
31338 failure causes control to pass to the next statement, and the conditions whose
31339 failure causes the ACL to return &"deny"&. This concept has proved to be
31340 confusing to some people, so the use of &%endpass%& is no longer recommended as
31341 &"best practice"&. See the description of &%accept%& above for more details.
31342
31343
31344 .vitem &*log_message*&&~=&~<&'text'&>
31345 .cindex "&%log_message%& ACL modifier"
31346 This modifier sets up a message that is used as part of the log message if the
31347 ACL denies access or a &%warn%& statement's conditions are true. For example:
31348 .code
31349 require log_message = wrong cipher suite $tls_in_cipher
31350         encrypted   = DES-CBC3-SHA
31351 .endd
31352 &%log_message%& is also used when recipients are discarded by &%discard%&. For
31353 example:
31354 .display
31355 &`discard `&<&'some conditions'&>
31356 &`        log_message = Discarded $local_part@$domain because...`&
31357 .endd
31358 When access is denied, &%log_message%& adds to any underlying error message
31359 that may exist because of a condition failure. For example, while verifying a
31360 recipient address, a &':fail:'& redirection might have already set up a
31361 message.
31362
31363 The message may be defined before the conditions to which it applies, because
31364 the string expansion does not happen until Exim decides that access is to be
31365 denied. This means that any variables that are set by the condition are
31366 available for inclusion in the message. For example, the &$dnslist_$&<&'xxx'&>
31367 variables are set after a DNS black list lookup succeeds. If the expansion of
31368 &%log_message%& fails, or if the result is an empty string, the modifier is
31369 ignored.
31370
31371 .vindex "&$acl_verify_message$&"
31372 If you want to use a &%warn%& statement to log the result of an address
31373 verification, you can use &$acl_verify_message$& to include the verification
31374 error message.
31375
31376 If &%log_message%& is used with a &%warn%& statement, &"Warning:"& is added to
31377 the start of the logged message. If the same warning log message is requested
31378 more than once while receiving  a single email message, only one copy is
31379 actually logged. If you want to log multiple copies, use &%logwrite%& instead
31380 of &%log_message%&. In the absence of &%log_message%& and &%logwrite%&, nothing
31381 is logged for a successful &%warn%& statement.
31382
31383 If &%log_message%& is not present and there is no underlying error message (for
31384 example, from the failure of address verification), but &%message%& is present,
31385 the &%message%& text is used for logging rejections. However, if any text for
31386 logging contains newlines, only the first line is logged. In the absence of
31387 both &%log_message%& and &%message%&, a default built-in message is used for
31388 logging rejections.
31389
31390
31391 .vitem "&*log_reject_target*&&~=&~<&'log name list'&>"
31392 .cindex "&%log_reject_target%& ACL modifier"
31393 .cindex "logging in ACL" "specifying which log"
31394 This modifier makes it possible to specify which logs are used for messages
31395 about ACL rejections. Its argument is a colon-separated list of words that can
31396 be &"main"&, &"reject"&, or &"panic"&. The default is &`main:reject`&. The list
31397 may be empty, in which case a rejection is not logged at all. For example, this
31398 ACL fragment writes no logging information when access is denied:
31399 .display
31400 &`deny `&<&'some conditions'&>
31401 &`     log_reject_target =`&
31402 .endd
31403 This modifier can be used in SMTP and non-SMTP ACLs. It applies to both
31404 permanent and temporary rejections. Its effect lasts for the rest of the
31405 current ACL.
31406
31407
31408 .vitem &*logwrite*&&~=&~<&'text'&>
31409 .cindex "&%logwrite%& ACL modifier"
31410 .cindex "logging in ACL" "immediate"
31411 This modifier writes a message to a log file as soon as it is encountered when
31412 processing an ACL. (Compare &%log_message%&, which, except in the case of
31413 &%warn%& and &%discard%&, is used only if the ACL statement denies
31414 access.) The &%logwrite%& modifier can be used to log special incidents in
31415 ACLs. For example:
31416 .display
31417 &`accept `&<&'some special conditions'&>
31418 &`       control  = freeze`&
31419 &`       logwrite = froze message because ...`&
31420 .endd
31421 By default, the message is written to the main log. However, it may begin
31422 with a colon, followed by a comma-separated list of log names, and then
31423 another colon, to specify exactly which logs are to be written. For
31424 example:
31425 .code
31426 logwrite = :main,reject: text for main and reject logs
31427 logwrite = :panic: text for panic log only
31428 .endd
31429
31430
31431 .vitem &*message*&&~=&~<&'text'&>
31432 .cindex "&%message%& ACL modifier"
31433 This modifier sets up a text string that is expanded and used as a response
31434 message when an ACL statement terminates the ACL with an &"accept"&, &"deny"&,
31435 or &"defer"& response. (In the case of the &%accept%& and &%discard%& verbs,
31436 there is some complication if &%endpass%& is involved; see the description of
31437 &%accept%& for details.)
31438
31439 The expansion of the message happens at the time Exim decides that the ACL is
31440 to end, not at the time it processes &%message%&. If the expansion fails, or
31441 generates an empty string, the modifier is ignored. Here is an example where
31442 &%message%& must be specified first, because the ACL ends with a rejection if
31443 the &%hosts%& condition fails:
31444 .code
31445 require  message = Host not recognized
31446          hosts = 10.0.0.0/8
31447 .endd
31448 (Once a condition has failed, no further conditions or modifiers are
31449 processed.)
31450
31451 .cindex "SMTP" "error codes"
31452 .oindex "&%smtp_banner%&
31453 For ACLs that are triggered by SMTP commands, the message is returned as part
31454 of the SMTP response. The use of &%message%& with &%accept%& (or &%discard%&)
31455 is meaningful only for SMTP, as no message is returned when a non-SMTP message
31456 is accepted. In the case of the connect ACL, accepting with a message modifier
31457 overrides the value of &%smtp_banner%&. For the EHLO/HELO ACL, a customized
31458 accept message may not contain more than one line (otherwise it will be
31459 truncated at the first newline and a panic logged), and it cannot affect the
31460 EHLO options.
31461
31462 When SMTP is involved, the message may begin with an overriding response code,
31463 consisting of three digits optionally followed by an &"extended response code"&
31464 of the form &'n.n.n'&, each code being followed by a space. For example:
31465 .code
31466 deny  message = 599 1.2.3 Host not welcome
31467       hosts = 192.168.34.0/24
31468 .endd
31469 The first digit of the supplied response code must be the same as would be sent
31470 by default. A panic occurs if it is not. Exim uses a 550 code when it denies
31471 access, but for the predata ACL, note that the default success code is 354, not
31472 2&'xx'&.
31473
31474 Notwithstanding the previous paragraph, for the QUIT ACL, unlike the others,
31475 the message modifier cannot override the 221 response code.
31476
31477 The text in a &%message%& modifier is literal; any quotes are taken as
31478 literals, but because the string is expanded, backslash escapes are processed
31479 anyway. If the message contains newlines, this gives rise to a multi-line SMTP
31480 response.
31481
31482 .vindex "&$acl_verify_message$&"
31483 .new
31484 While the text is being expanded, the &$acl_verify_message$& variable
31485 contains any message previously set.
31486 Afterwards, &$acl_verify_message$& is cleared.
31487 .wen
31488
31489 If &%message%& is used on a statement that verifies an address, the message
31490 specified overrides any message that is generated by the verification process.
31491 However, the original message is available in the variable
31492 &$acl_verify_message$&, so you can incorporate it into your message if you
31493 wish. In particular, if you want the text from &%:fail:%& items in &(redirect)&
31494 routers to be passed back as part of the SMTP response, you should either not
31495 use a &%message%& modifier, or make use of &$acl_verify_message$&.
31496
31497 For compatibility with previous releases of Exim, a &%message%& modifier that
31498 is used with a &%warn%& verb behaves in a similar way to the &%add_header%&
31499 modifier, but this usage is now deprecated. However, &%message%& acts only when
31500 all the conditions are true, wherever it appears in an ACL command, whereas
31501 &%add_header%& acts as soon as it is encountered. If &%message%& is used with
31502 &%warn%& in an ACL that is not concerned with receiving a message, it has no
31503 effect.
31504
31505
31506 .vitem &*queue*&&~=&~<&'text'&>
31507 .cindex "&%queue%& ACL modifier"
31508 .cindex "named queues" "selecting in ACL"
31509 This modifier specifies the use of a named queue for spool files
31510 for the message.
31511 It can only be used before the message is received (i.e. not in
31512 the DATA ACL).
31513 This could be used, for example, for known high-volume burst sources
31514 of traffic, or for quarantine of messages.
31515 Separate queue-runner processes will be needed for named queues.
31516 If the text after expansion is empty, the default queue is used.
31517
31518
31519 .vitem &*remove_header*&&~=&~<&'text'&>
31520 This modifier specifies one or more header names in a colon-separated list
31521  that are to be removed from an incoming message, assuming, of course, that
31522 the message is ultimately accepted. For details, see section &<<SECTremoveheadacl>>&.
31523
31524
31525 .vitem &*set*&&~<&'acl_name'&>&~=&~<&'value'&>
31526 .cindex "&%set%& ACL modifier"
31527 This modifier puts a value into one of the ACL variables (see section
31528 &<<SECTaclvariables>>&).
31529
31530
31531 .vitem &*udpsend*&&~=&~<&'parameters'&>
31532 .cindex "UDP communications"
31533 This modifier sends a UDP packet, for purposes such as statistics
31534 collection or behaviour monitoring. The parameters are expanded, and
31535 the result of the expansion must be a colon-separated list consisting
31536 of a destination server, port number, and the packet contents. The
31537 server can be specified as a host name or IPv4 or IPv6 address. The
31538 separator can be changed with the usual angle bracket syntax. For
31539 example, you might want to collect information on which hosts connect
31540 when:
31541 .code
31542 udpsend = <; 2001:dB8::dead:beef ; 1234 ;\
31543              $tod_zulu $sender_host_address
31544 .endd
31545 .endlist
31546
31547
31548
31549
31550 .section "Use of the control modifier" "SECTcontrols"
31551 .cindex "&%control%& ACL modifier"
31552 The &%control%& modifier supports the following settings:
31553
31554 .vlist
31555 .vitem &*control&~=&~allow_auth_unadvertised*&
31556 This modifier allows a client host to use the SMTP AUTH command even when it
31557 has not been advertised in response to EHLO. Furthermore, because there are
31558 apparently some really broken clients that do this, Exim will accept AUTH after
31559 HELO (rather than EHLO) when this control is set. It should be used only if you
31560 really need it, and you should limit its use to those broken clients that do
31561 not work without it. For example:
31562 .code
31563 warn hosts   = 192.168.34.25
31564      control = allow_auth_unadvertised
31565 .endd
31566 Normally, when an Exim server receives an AUTH command, it checks the name of
31567 the authentication mechanism that is given in the command to ensure that it
31568 matches an advertised mechanism. When this control is set, the check that a
31569 mechanism has been advertised is bypassed. Any configured mechanism can be used
31570 by the client. This control is permitted only in the connection and HELO ACLs.
31571
31572
31573 .vitem &*control&~=&~caseful_local_part*& &&&
31574        &*control&~=&~caselower_local_part*&
31575 .cindex "&ACL;" "case of local part in"
31576 .cindex "case of local parts"
31577 .vindex "&$local_part$&"
31578 These two controls are permitted only in the ACL specified by &%acl_smtp_rcpt%&
31579 (that is, during RCPT processing). By default, the contents of &$local_part$&
31580 are lower cased before ACL processing. If &"caseful_local_part"& is specified,
31581 any uppercase letters in the original local part are restored in &$local_part$&
31582 for the rest of the ACL, or until a control that sets &"caselower_local_part"&
31583 is encountered.
31584
31585 These controls affect only the current recipient. Moreover, they apply only to
31586 local part handling that takes place directly in the ACL (for example, as a key
31587 in lookups). If a test to verify the recipient is obeyed, the case-related
31588 handling of the local part during the verification is controlled by the router
31589 configuration (see the &%caseful_local_part%& generic router option).
31590
31591 This facility could be used, for example, to add a spam score to local parts
31592 containing upper case letters. For example, using &$acl_m4$& to accumulate the
31593 spam score:
31594 .code
31595 warn  control = caseful_local_part
31596       set acl_m4 = ${eval:\
31597                      $acl_m4 + \
31598                      ${if match{$local_part}{[A-Z]}{1}{0}}\
31599                     }
31600       control = caselower_local_part
31601 .endd
31602 Notice that we put back the lower cased version afterwards, assuming that
31603 is what is wanted for subsequent tests.
31604
31605
31606 .vitem &*control&~=&~cutthrough_delivery/*&<&'options'&>
31607 .cindex "&ACL;" "cutthrough routing"
31608 .cindex "cutthrough" "requesting"
31609 This option requests delivery be attempted while the item is being received.
31610
31611 The option is usable in the RCPT ACL.
31612 If enabled for a message received via smtp and routed to an smtp transport,
31613 and only one transport, interface, destination host and port combination
31614 is used for all recipients of the message,
31615 then the delivery connection is made while the receiving connection is open
31616 and data is copied from one to the other.
31617
31618 An attempt to set this option for any recipient but the first
31619 for a mail will be quietly ignored.
31620 If a recipient-verify callout
31621 (with use_sender)
31622 connection is subsequently
31623 requested in the same ACL it is held open and used for
31624 any subsequent recipients and the data,
31625 otherwise one is made after the initial RCPT ACL completes.
31626
31627 Note that routers are used in verify mode,
31628 and cannot depend on content of received headers.
31629 Note also that headers cannot be
31630 modified by any of the post-data ACLs (DATA, MIME and DKIM).
31631 Headers may be modified by routers (subject to the above) and transports.
31632 The &'Received-By:'& header is generated as soon as the body reception starts,
31633 rather than the traditional time after the full message is received;
31634 this will affect the timestamp.
31635
31636 All the usual ACLs are called; if one results in the message being
31637 rejected, all effort spent in delivery (including the costs on
31638 the ultimate destination) will be wasted.
31639 Note that in the case of data-time ACLs this includes the entire
31640 message body.
31641
31642 Cutthrough delivery is not supported via transport-filters or when DKIM signing
31643 of outgoing messages is done, because it sends data to the ultimate destination
31644 before the entire message has been received from the source.
31645 It is not supported for messages received with the SMTP PRDR
31646 or CHUNKING
31647 options in use.
31648
31649 Should the ultimate destination system positively accept or reject the mail,
31650 a corresponding indication is given to the source system and nothing is queued.
31651 If the item is successfully delivered in cutthrough mode
31652 the delivery log lines are tagged with ">>" rather than "=>" and appear
31653 before the acceptance "<=" line.
31654
31655 If there is a temporary error the item is queued for later delivery in the
31656 usual fashion.
31657 This behaviour can be adjusted by appending the option &*defer=*&<&'value'&>
31658 to the control; the default value is &"spool"& and the alternate value
31659 &"pass"& copies an SMTP defer response from the target back to the initiator
31660 and does not queue the message.
31661 Note that this is independent of any recipient verify conditions in the ACL.
31662
31663 Delivery in this mode avoids the generation of a bounce mail to a
31664 (possibly faked)
31665 sender when the destination system is doing content-scan based rejection.
31666
31667
31668 .vitem &*control&~=&~debug/*&<&'options'&>
31669 .cindex "&ACL;" "enabling debug logging"
31670 .cindex "debugging" "enabling from an ACL"
31671 This control turns on debug logging, almost as though Exim had been invoked
31672 with &`-d`&, with the output going to a new logfile in the usual logs directory,
31673 by default called &'debuglog'&.
31674 The filename can be adjusted with the &'tag'& option, which
31675 may access any variables already defined.  The logging may be adjusted with
31676 the &'opts'& option, which takes the same values as the &`-d`& command-line
31677 option.
31678 Logging started this way may be stopped, and the file removed,
31679 with the &'kill'& option.
31680 Some examples (which depend on variables that don't exist in all
31681 contexts):
31682 .code
31683       control = debug
31684       control = debug/tag=.$sender_host_address
31685       control = debug/opts=+expand+acl
31686       control = debug/tag=.$message_exim_id/opts=+expand
31687       control = debug/kill
31688 .endd
31689
31690
31691 .vitem &*control&~=&~dkim_disable_verify*&
31692 .cindex "disable DKIM verify"
31693 .cindex "DKIM" "disable verify"
31694 This control turns off DKIM verification processing entirely.  For details on
31695 the operation and configuration of DKIM, see section &<<SECDKIM>>&.
31696
31697
31698 .vitem &*control&~=&~dmarc_disable_verify*&
31699 .cindex "disable DMARC verify"
31700 .cindex "DMARC" "disable verify"
31701 This control turns off DMARC verification processing entirely.  For details on
31702 the operation and configuration of DMARC, see section &<<SECDMARC>>&.
31703
31704
31705 .vitem &*control&~=&~dscp/*&<&'value'&>
31706 .cindex "&ACL;" "setting DSCP value"
31707 .cindex "DSCP" "inbound"
31708 This option causes the DSCP value associated with the socket for the inbound
31709 connection to be adjusted to a given value, given as one of a number of fixed
31710 strings or to numeric value.
31711 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
31712 Common values include &`throughput`&, &`mincost`&, and on newer systems
31713 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
31714
31715 The outbound packets from Exim will be marked with this value in the header
31716 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
31717 that these values will have any effect, not be stripped by networking
31718 equipment, or do much of anything without cooperation with your Network
31719 Engineer and those of all network operators between the source and destination.
31720
31721
31722 .vitem &*control&~=&~enforce_sync*& &&&
31723        &*control&~=&~no_enforce_sync*&
31724 .cindex "SMTP" "synchronization checking"
31725 .cindex "synchronization checking in SMTP"
31726 These controls make it possible to be selective about when SMTP synchronization
31727 is enforced. The global option &%smtp_enforce_sync%& specifies the initial
31728 state of the switch (it is true by default). See the description of this option
31729 in chapter &<<CHAPmainconfig>>& for details of SMTP synchronization checking.
31730
31731 The effect of these two controls lasts for the remainder of the SMTP
31732 connection. They can appear in any ACL except the one for the non-SMTP
31733 messages. The most straightforward place to put them is in the ACL defined by
31734 &%acl_smtp_connect%&, which is run at the start of an incoming SMTP connection,
31735 before the first synchronization check. The expected use is to turn off the
31736 synchronization checks for badly-behaved hosts that you nevertheless need to
31737 work with.
31738
31739
31740 .vitem &*control&~=&~fakedefer/*&<&'message'&>
31741 .cindex "fake defer"
31742 .cindex "defer, fake"
31743 This control works in exactly the same way as &%fakereject%& (described below)
31744 except that it causes an SMTP 450 response after the message data instead of a
31745 550 response. You must take care when using &%fakedefer%& because it causes the
31746 messages to be duplicated when the sender retries. Therefore, you should not
31747 use &%fakedefer%& if the message is to be delivered normally.
31748
31749 .vitem &*control&~=&~fakereject/*&<&'message'&>
31750 .cindex "fake rejection"
31751 .cindex "rejection, fake"
31752 This control is permitted only for the MAIL, RCPT, and DATA ACLs, in other
31753 words, only when an SMTP message is being received. If Exim accepts the
31754 message, instead the final 250 response, a 550 rejection message is sent.
31755 However, Exim proceeds to deliver the message as normal. The control applies
31756 only to the current message, not to any subsequent ones that may be received in
31757 the same SMTP connection.
31758
31759 The text for the 550 response is taken from the &%control%& modifier. If no
31760 message is supplied, the following is used:
31761 .code
31762 550-Your message has been rejected but is being
31763 550-kept for evaluation.
31764 550-If it was a legitimate message, it may still be
31765 550 delivered to the target recipient(s).
31766 .endd
31767 This facility should be used with extreme caution.
31768
31769 .vitem &*control&~=&~freeze*&
31770 .cindex "frozen messages" "forcing in ACL"
31771 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
31772 other words, only when a message is being received. If the message is accepted,
31773 it is placed on Exim's queue and frozen. The control applies only to the
31774 current message, not to any subsequent ones that may be received in the same
31775 SMTP connection.
31776
31777 This modifier can optionally be followed by &`/no_tell`&. If the global option
31778 &%freeze_tell%& is set, it is ignored for the current message (that is, nobody
31779 is told about the freezing), provided all the &*control=freeze*& modifiers that
31780 are obeyed for the current message have the &`/no_tell`& option.
31781
31782 .vitem &*control&~=&~no_delay_flush*&
31783 .cindex "SMTP" "output flushing, disabling for delay"
31784 Exim normally flushes SMTP output before implementing a delay in an ACL, to
31785 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
31786 use. This control, as long as it is encountered before the &%delay%& modifier,
31787 disables such output flushing.
31788
31789 .vitem &*control&~=&~no_callout_flush*&
31790 .cindex "SMTP" "output flushing, disabling for callout"
31791 Exim normally flushes SMTP output before performing a callout in an ACL, to
31792 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
31793 use. This control, as long as it is encountered before the &%verify%& condition
31794 that causes the callout, disables such output flushing.
31795
31796 .vitem &*control&~=&~no_mbox_unspool*&
31797 This control is available when Exim is compiled with the content scanning
31798 extension. Content scanning may require a copy of the current message, or parts
31799 of it, to be written in &"mbox format"& to a spool file, for passing to a virus
31800 or spam scanner. Normally, such copies are deleted when they are no longer
31801 needed. If this control is set, the copies are not deleted. The control applies
31802 only to the current message, not to any subsequent ones that may be received in
31803 the same SMTP connection. It is provided for debugging purposes and is unlikely
31804 to be useful in production.
31805
31806 .vitem &*control&~=&~no_multiline_responses*&
31807 .cindex "multiline responses, suppressing"
31808 This control is permitted for any ACL except the one for non-SMTP messages.
31809 It seems that there are broken clients in use that cannot handle multiline
31810 SMTP responses, despite the fact that RFC 821 defined them over 20 years ago.
31811
31812 If this control is set, multiline SMTP responses from ACL rejections are
31813 suppressed. One way of doing this would have been to put out these responses as
31814 one long line. However, RFC 2821 specifies a maximum of 512 bytes per response
31815 (&"use multiline responses for more"& it says &-- ha!), and some of the
31816 responses might get close to that. So this facility, which is after all only a
31817 sop to broken clients, is implemented by doing two very easy things:
31818
31819 .ilist
31820 Extra information that is normally output as part of a rejection caused by
31821 sender verification failure is omitted. Only the final line (typically &"sender
31822 verification failed"&) is sent.
31823 .next
31824 If a &%message%& modifier supplies a multiline response, only the first
31825 line is output.
31826 .endlist
31827
31828 The setting of the switch can, of course, be made conditional on the
31829 calling host. Its effect lasts until the end of the SMTP connection.
31830
31831 .vitem &*control&~=&~no_pipelining*&
31832 .cindex "PIPELINING" "suppressing advertising"
31833 .cindex "ESMTP extensions" PIPELINING
31834 This control turns off the advertising of the PIPELINING extension to SMTP in
31835 the current session. To be useful, it must be obeyed before Exim sends its
31836 response to an EHLO command. Therefore, it should normally appear in an ACL
31837 controlled by &%acl_smtp_connect%& or &%acl_smtp_helo%&. See also
31838 &%pipelining_advertise_hosts%&.
31839
31840 .vitem &*control&~=&~queue/*&<&'options'&>* &&&
31841        &*control&~=&~queue_only*&
31842 .oindex "&%queue%&"
31843 .oindex "&%queue_only%&"
31844 .cindex "queueing incoming messages"
31845 .cindex queueing "forcing in ACL"
31846 .cindex "first pass routing"
31847 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
31848 other words, only when a message is being received. If the message is accepted,
31849 it is placed on Exim's queue and left there for delivery by a subsequent queue
31850 runner.
31851 If used with no options set,
31852 no immediate delivery process is started. In other words, it has the
31853 effect as the &%queue_only%& global option or &'-odq'& command-line option.
31854
31855 If the &'first_pass_route'& option is given then
31856 the behaviour is like the command-line &'-oqds'& option;
31857 a delivery process is started which stops short of making
31858 any SMTP delivery.  The benefit is that the hints database will be updated for
31859 the message being waiting for a specific host, and a later queue run will be
31860 able to send all such messages on a single connection.
31861
31862 The control only applies to the current message, not to any subsequent ones that
31863  may be received in the same SMTP connection.
31864
31865 .vitem &*control&~=&~submission/*&<&'options'&>
31866 .cindex "message" "submission"
31867 .cindex "submission mode"
31868 This control is permitted only for the MAIL, RCPT, and start of data ACLs (the
31869 latter is the one defined by &%acl_smtp_predata%&). Setting it tells Exim that
31870 the current message is a submission from a local MUA. In this case, Exim
31871 operates in &"submission mode"&, and applies certain fixups to the message if
31872 necessary. For example, it adds a &'Date:'& header line if one is not present.
31873 This control is not permitted in the &%acl_smtp_data%& ACL, because that is too
31874 late (the message has already been created).
31875
31876 Chapter &<<CHAPmsgproc>>& describes the processing that Exim applies to
31877 messages. Section &<<SECTsubmodnon>>& covers the processing that happens in
31878 submission mode; the available options for this control are described there.
31879 The control applies only to the current message, not to any subsequent ones
31880 that may be received in the same SMTP connection.
31881
31882 .vitem &*control&~=&~suppress_local_fixups*&
31883 .cindex "submission fixups, suppressing"
31884 This control applies to locally submitted (non TCP/IP) messages, and is the
31885 complement of &`control = submission`&. It disables the fixups that are
31886 normally applied to locally-submitted messages. Specifically:
31887
31888 .ilist
31889 Any &'Sender:'& header line is left alone (in this respect, it is a
31890 dynamic version of &%local_sender_retain%&).
31891 .next
31892 No &'Message-ID:'&, &'From:'&, or &'Date:'& header lines are added.
31893 .next
31894 There is no check that &'From:'& corresponds to the actual sender.
31895 .endlist ilist
31896
31897 This control may be useful when a remotely-originated message is accepted,
31898 passed to some scanning program, and then re-submitted for delivery. It can be
31899 used only in the &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
31900 and &%acl_not_smtp_start%& ACLs, because it has to be set before the message's
31901 data is read.
31902
31903 &*Note:*& This control applies only to the current message, not to any others
31904 that are being submitted at the same time using &%-bs%& or &%-bS%&.
31905
31906 .vitem &*control&~=&~utf8_downconvert*&
31907 This control enables conversion of UTF-8 in message envelope addresses
31908 to a-label form.
31909 For details see section &<<SECTi18nMTA>>&.
31910 .endlist vlist
31911
31912
31913 .section "Summary of message fixup control" "SECTsummesfix"
31914 All four possibilities for message fixups can be specified:
31915
31916 .ilist
31917 Locally submitted, fixups applied: the default.
31918 .next
31919 Locally submitted, no fixups applied: use
31920 &`control = suppress_local_fixups`&.
31921 .next
31922 Remotely submitted, no fixups applied: the default.
31923 .next
31924 Remotely submitted, fixups applied: use &`control = submission`&.
31925 .endlist
31926
31927
31928
31929 .section "Adding header lines in ACLs" "SECTaddheadacl"
31930 .cindex "header lines" "adding in an ACL"
31931 .cindex "header lines" "position of added lines"
31932 .cindex "&%add_header%& ACL modifier"
31933 The &%add_header%& modifier can be used to add one or more extra header lines
31934 to an incoming message, as in this example:
31935 .code
31936 warn dnslists = sbl.spamhaus.org : \
31937                 dialup.mail-abuse.org
31938      add_header = X-blacklisted-at: $dnslist_domain
31939 .endd
31940 The &%add_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
31941 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
31942 receiving a message). The message must ultimately be accepted for
31943 &%add_header%& to have any significant effect. You can use &%add_header%& with
31944 any ACL verb, including &%deny%& (though this is potentially useful only in a
31945 RCPT ACL).
31946
31947 Headers will not be added to the message if the modifier is used in
31948 DATA, MIME or DKIM ACLs for a message delivered by cutthrough routing.
31949
31950 Leading and trailing newlines are removed from
31951 the data for the &%add_header%& modifier; if it then
31952 contains one or more newlines that
31953 are not followed by a space or a tab, it is assumed to contain multiple header
31954 lines. Each one is checked for valid syntax; &`X-ACL-Warn:`& is added to the
31955 front of any line that is not a valid header line.
31956
31957 Added header lines are accumulated during the MAIL, RCPT, and predata ACLs.
31958 They are added to the message before processing the DATA and MIME ACLs.
31959 However, if an identical header line is requested more than once, only one copy
31960 is actually added to the message. Further header lines may be accumulated
31961 during the DATA and MIME ACLs, after which they are added to the message, again
31962 with duplicates suppressed. Thus, it is possible to add two identical header
31963 lines to an SMTP message, but only if one is added before DATA and one after.
31964 In the case of non-SMTP messages, new headers are accumulated during the
31965 non-SMTP ACLs, and are added to the message after all the ACLs have run. If a
31966 message is rejected after DATA or by the non-SMTP ACL, all added header lines
31967 are included in the entry that is written to the reject log.
31968
31969 .cindex "header lines" "added; visibility of"
31970 Header lines are not visible in string expansions
31971 of message headers
31972 until they are added to the
31973 message. It follows that header lines defined in the MAIL, RCPT, and predata
31974 ACLs are not visible until the DATA ACL and MIME ACLs are run. Similarly,
31975 header lines that are added by the DATA or MIME ACLs are not visible in those
31976 ACLs. Because of this restriction, you cannot use header lines as a way of
31977 passing data between (for example) the MAIL and RCPT ACLs. If you want to do
31978 this, you can use ACL variables, as described in section
31979 &<<SECTaclvariables>>&.
31980
31981 The list of headers yet to be added is given by the &%$headers_added%& variable.
31982
31983 The &%add_header%& modifier acts immediately as it is encountered during the
31984 processing of an ACL. Notice the difference between these two cases:
31985 .display
31986 &`accept add_header = ADDED: some text`&
31987 &`       `&<&'some condition'&>
31988
31989 &`accept `&<&'some condition'&>
31990 &`       add_header = ADDED: some text`&
31991 .endd
31992 In the first case, the header line is always added, whether or not the
31993 condition is true. In the second case, the header line is added only if the
31994 condition is true. Multiple occurrences of &%add_header%& may occur in the same
31995 ACL statement. All those that are encountered before a condition fails are
31996 honoured.
31997
31998 .cindex "&%warn%& ACL verb"
31999 For compatibility with previous versions of Exim, a &%message%& modifier for a
32000 &%warn%& verb acts in the same way as &%add_header%&, except that it takes
32001 effect only if all the conditions are true, even if it appears before some of
32002 them. Furthermore, only the last occurrence of &%message%& is honoured. This
32003 usage of &%message%& is now deprecated. If both &%add_header%& and &%message%&
32004 are present on a &%warn%& verb, both are processed according to their
32005 specifications.
32006
32007 By default, new header lines are added to a message at the end of the existing
32008 header lines. However, you can specify that any particular header line should
32009 be added right at the start (before all the &'Received:'& lines), immediately
32010 after the first block of &'Received:'& lines, or immediately before any line
32011 that is not a &'Received:'& or &'Resent-something:'& header.
32012
32013 This is done by specifying &":at_start:"&, &":after_received:"&, or
32014 &":at_start_rfc:"& (or, for completeness, &":at_end:"&) before the text of the
32015 header line, respectively. (Header text cannot start with a colon, as there has
32016 to be a header name first.) For example:
32017 .code
32018 warn add_header = \
32019        :after_received:X-My-Header: something or other...
32020 .endd
32021 If more than one header line is supplied in a single &%add_header%& modifier,
32022 each one is treated independently and can therefore be placed differently. If
32023 you add more than one line at the start, or after the Received: block, they end
32024 up in reverse order.
32025
32026 &*Warning*&: This facility currently applies only to header lines that are
32027 added in an ACL. It does NOT work for header lines that are added in a
32028 system filter or in a router or transport.
32029
32030
32031
32032 .section "Removing header lines in ACLs" "SECTremoveheadacl"
32033 .cindex "header lines" "removing in an ACL"
32034 .cindex "header lines" "position of removed lines"
32035 .cindex "&%remove_header%& ACL modifier"
32036 The &%remove_header%& modifier can be used to remove one or more header lines
32037 from an incoming message, as in this example:
32038 .code
32039 warn   message        = Remove internal headers
32040        remove_header  = x-route-mail1 : x-route-mail2
32041 .endd
32042 The &%remove_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
32043 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
32044 receiving a message). The message must ultimately be accepted for
32045 &%remove_header%& to have any significant effect. You can use &%remove_header%&
32046 with any ACL verb, including &%deny%&, though this is really not useful for
32047 any verb that doesn't result in a delivered message.
32048
32049 Headers will not be removed from the message if the modifier is used in
32050 DATA, MIME or DKIM ACLs for a message delivered by cutthrough routing.
32051
32052 More than one header can be removed at the same time by using a colon separated
32053 list of header names. The header matching is case insensitive. Wildcards are
32054 not permitted, nor is list expansion performed, so you cannot use hostlists to
32055 create a list of headers, however both connection and message variable expansion
32056 are performed (&%$acl_c_*%& and &%$acl_m_*%&), illustrated in this example:
32057 .code
32058 warn   hosts           = +internal_hosts
32059        set acl_c_ihdrs = x-route-mail1 : x-route-mail2
32060 warn   message         = Remove internal headers
32061        remove_header   = $acl_c_ihdrs
32062 .endd
32063 Header names for removal are accumulated during the MAIL, RCPT, and predata ACLs.
32064 Matching header lines are removed from the message before processing the DATA and MIME ACLs.
32065 If multiple header lines match, all are removed.
32066 There is no harm in attempting to remove the same header twice nor in removing
32067 a non-existent header. Further header lines to be removed may be accumulated
32068 during the DATA and MIME ACLs, after which they are removed from the message,
32069 if present. In the case of non-SMTP messages, headers to be removed are
32070 accumulated during the non-SMTP ACLs, and are removed from the message after
32071 all the ACLs have run. If a message is rejected after DATA or by the non-SMTP
32072 ACL, there really is no effect because there is no logging of what headers
32073 would have been removed.
32074
32075 .cindex "header lines" "removed; visibility of"
32076 Header lines are not visible in string expansions until the DATA phase when it
32077 is received. Any header lines removed in the MAIL, RCPT, and predata ACLs are
32078 not visible in the DATA ACL and MIME ACLs. Similarly, header lines that are
32079 removed by the DATA or MIME ACLs are still visible in those ACLs. Because of
32080 this restriction, you cannot use header lines as a way of controlling data
32081 passed between (for example) the MAIL and RCPT ACLs. If you want to do this,
32082 you should instead use ACL variables, as described in section
32083 &<<SECTaclvariables>>&.
32084
32085 The &%remove_header%& modifier acts immediately as it is encountered during the
32086 processing of an ACL. Notice the difference between these two cases:
32087 .display
32088 &`accept remove_header = X-Internal`&
32089 &`       `&<&'some condition'&>
32090
32091 &`accept `&<&'some condition'&>
32092 &`       remove_header = X-Internal`&
32093 .endd
32094 In the first case, the header line is always removed, whether or not the
32095 condition is true. In the second case, the header line is removed only if the
32096 condition is true. Multiple occurrences of &%remove_header%& may occur in the
32097 same ACL statement. All those that are encountered before a condition fails
32098 are honoured.
32099
32100 &*Warning*&: This facility currently applies only to header lines that are
32101 present during ACL processing. It does NOT remove header lines that are added
32102 in a system filter or in a router or transport.
32103
32104
32105
32106
32107 .section "ACL conditions" "SECTaclconditions"
32108 .cindex "&ACL;" "conditions; list of"
32109 Some of the conditions listed in this section are available only when Exim is
32110 compiled with the content-scanning extension. They are included here briefly
32111 for completeness. More detailed descriptions can be found in the discussion on
32112 content scanning in chapter &<<CHAPexiscan>>&.
32113
32114 Not all conditions are relevant in all circumstances. For example, testing
32115 senders and recipients does not make sense in an ACL that is being run as the
32116 result of the arrival of an ETRN command, and checks on message headers can be
32117 done only in the ACLs specified by &%acl_smtp_data%& and &%acl_not_smtp%&. You
32118 can use the same condition (with different parameters) more than once in the
32119 same ACL statement. This provides a way of specifying an &"and"& conjunction.
32120 The conditions are as follows:
32121
32122
32123 .vlist
32124 .vitem &*acl&~=&~*&<&'name&~of&~acl&~or&~ACL&~string&~or&~file&~name&~'&>
32125 .cindex "&ACL;" "nested"
32126 .cindex "&ACL;" "indirect"
32127 .cindex "&ACL;" "arguments"
32128 .cindex "&%acl%& ACL condition"
32129 The possible values of the argument are the same as for the
32130 &%acl_smtp_%&&'xxx'& options. The named or inline ACL is run. If it returns
32131 &"accept"& the condition is true; if it returns &"deny"& the condition is
32132 false. If it returns &"defer"&, the current ACL returns &"defer"& unless the
32133 condition is on a &%warn%& verb. In that case, a &"defer"& return makes the
32134 condition false. This means that further processing of the &%warn%& verb
32135 ceases, but processing of the ACL continues.
32136
32137 If the argument is a named ACL, up to nine space-separated optional values
32138 can be appended; they appear within the called ACL in $acl_arg1 to $acl_arg9,
32139 and $acl_narg is set to the count of values.
32140 Previous values of these variables are restored after the call returns.
32141 The name and values are expanded separately.
32142 Note that spaces in complex expansions which are used as arguments
32143 will act as argument separators.
32144
32145 If the nested &%acl%& returns &"drop"& and the outer condition denies access,
32146 the connection is dropped. If it returns &"discard"&, the verb must be
32147 &%accept%& or &%discard%&, and the action is taken immediately &-- no further
32148 conditions are tested.
32149
32150 ACLs may be nested up to 20 deep; the limit exists purely to catch runaway
32151 loops. This condition allows you to use different ACLs in different
32152 circumstances. For example, different ACLs can be used to handle RCPT commands
32153 for different local users or different local domains.
32154
32155 .vitem &*authenticated&~=&~*&<&'string&~list'&>
32156 .cindex "&%authenticated%& ACL condition"
32157 .cindex "authentication" "ACL checking"
32158 .cindex "&ACL;" "testing for authentication"
32159 If the SMTP connection is not authenticated, the condition is false. Otherwise,
32160 the name of the authenticator is tested against the list. To test for
32161 authentication by any authenticator, you can set
32162 .code
32163 authenticated = *
32164 .endd
32165
32166 .vitem &*condition&~=&~*&<&'string'&>
32167 .cindex "&%condition%& ACL condition"
32168 .cindex "customizing" "ACL condition"
32169 .cindex "&ACL;" "customized test"
32170 .cindex "&ACL;" "testing, customized"
32171 This feature allows you to make up custom conditions. If the result of
32172 expanding the string is an empty string, the number zero, or one of the strings
32173 &"no"& or &"false"&, the condition is false. If the result is any non-zero
32174 number, or one of the strings &"yes"& or &"true"&, the condition is true. For
32175 any other value, some error is assumed to have occurred, and the ACL returns
32176 &"defer"&. However, if the expansion is forced to fail, the condition is
32177 ignored. The effect is to treat it as true, whether it is positive or
32178 negative.
32179
32180 .vitem &*decode&~=&~*&<&'location'&>
32181 .cindex "&%decode%& ACL condition"
32182 This condition is available only when Exim is compiled with the
32183 content-scanning extension, and it is allowed only in the ACL defined by
32184 &%acl_smtp_mime%&. It causes the current MIME part to be decoded into a file.
32185 If all goes well, the condition is true. It is false only if there are
32186 problems such as a syntax error or a memory shortage. For more details, see
32187 chapter &<<CHAPexiscan>>&.
32188
32189 .vitem &*dnslists&~=&~*&<&'list&~of&~domain&~names&~and&~other&~data'&>
32190 .cindex "&%dnslists%& ACL condition"
32191 .cindex "DNS list" "in ACL"
32192 .cindex "black list (DNS)"
32193 .cindex "&ACL;" "testing a DNS list"
32194 This condition checks for entries in DNS black lists. These are also known as
32195 &"RBL lists"&, after the original Realtime Blackhole List, but note that the
32196 use of the lists at &'mail-abuse.org'& now carries a charge. There are too many
32197 different variants of this condition to describe briefly here. See sections
32198 &<<SECTmorednslists>>&&--&<<SECTmorednslistslast>>& for details.
32199
32200 .vitem &*domains&~=&~*&<&'domain&~list'&>
32201 .cindex "&%domains%& ACL condition"
32202 .cindex "domain" "ACL checking"
32203 .cindex "&ACL;" "testing a recipient domain"
32204 .vindex "&$domain_data$&"
32205 This condition is relevant only after a RCPT command. It checks that the domain
32206 of the recipient address is in the domain list. If percent-hack processing is
32207 enabled, it is done before this test is done. If the check succeeds with a
32208 lookup, the result of the lookup is placed in &$domain_data$& until the next
32209 &%domains%& test.
32210
32211 &*Note carefully*& (because many people seem to fall foul of this): you cannot
32212 use &%domains%& in a DATA ACL.
32213
32214
32215 .vitem &*encrypted&~=&~*&<&'string&~list'&>
32216 .cindex "&%encrypted%& ACL condition"
32217 .cindex "encryption" "checking in an ACL"
32218 .cindex "&ACL;" "testing for encryption"
32219 If the SMTP connection is not encrypted, the condition is false. Otherwise, the
32220 name of the cipher suite in use is tested against the list. To test for
32221 encryption without testing for any specific cipher suite(s), set
32222 .code
32223 encrypted = *
32224 .endd
32225
32226
32227 .vitem &*hosts&~=&~*&<&'host&~list'&>
32228 .cindex "&%hosts%& ACL condition"
32229 .cindex "host" "ACL checking"
32230 .cindex "&ACL;" "testing the client host"
32231 This condition tests that the calling host matches the host list. If you have
32232 name lookups or wildcarded host names and IP addresses in the same host list,
32233 you should normally put the IP addresses first. For example, you could have:
32234 .code
32235 accept hosts = 10.9.8.7 : dbm;/etc/friendly/hosts
32236 .endd
32237 The lookup in this example uses the host name for its key. This is implied by
32238 the lookup type &"dbm"&. (For a host address lookup you would use &"net-dbm"&
32239 and it wouldn't matter which way round you had these two items.)
32240
32241 The reason for the problem with host names lies in the left-to-right way that
32242 Exim processes lists. It can test IP addresses without doing any DNS lookups,
32243 but when it reaches an item that requires a host name, it fails if it cannot
32244 find a host name to compare with the pattern. If the above list is given in the
32245 opposite order, the &%accept%& statement fails for a host whose name cannot be
32246 found, even if its IP address is 10.9.8.7.
32247
32248 If you really do want to do the name check first, and still recognize the IP
32249 address even if the name lookup fails, you can rewrite the ACL like this:
32250 .code
32251 accept hosts = dbm;/etc/friendly/hosts
32252 accept hosts = 10.9.8.7
32253 .endd
32254 The default action on failing to find the host name is to assume that the host
32255 is not in the list, so the first &%accept%& statement fails. The second
32256 statement can then check the IP address.
32257
32258 .vindex "&$host_data$&"
32259 If a &%hosts%& condition is satisfied by means of a lookup, the result
32260 of the lookup is made available in the &$host_data$& variable. This
32261 allows you, for example, to set up a statement like this:
32262 .code
32263 deny  hosts = net-lsearch;/some/file
32264       message = $host_data
32265 .endd
32266 which gives a custom error message for each denied host.
32267
32268 .vitem &*local_parts&~=&~*&<&'local&~part&~list'&>
32269 .cindex "&%local_parts%& ACL condition"
32270 .cindex "local part" "ACL checking"
32271 .cindex "&ACL;" "testing a local part"
32272 .vindex "&$local_part_data$&"
32273 This condition is relevant only after a RCPT command. It checks that the local
32274 part of the recipient address is in the list. If percent-hack processing is
32275 enabled, it is done before this test. If the check succeeds with a lookup, the
32276 result of the lookup is placed in &$local_part_data$&, which remains set until
32277 the next &%local_parts%& test.
32278
32279 .vitem &*malware&~=&~*&<&'option'&>
32280 .cindex "&%malware%& ACL condition"
32281 .cindex "&ACL;" "virus scanning"
32282 .cindex "&ACL;" "scanning for viruses"
32283 This condition is available only when Exim is compiled with the
32284 content-scanning extension
32285 and only after a DATA command.
32286 It causes the incoming message to be scanned for
32287 viruses. For details, see chapter &<<CHAPexiscan>>&.
32288
32289 .vitem &*mime_regex&~=&~*&<&'list&~of&~regular&~expressions'&>
32290 .cindex "&%mime_regex%& ACL condition"
32291 .cindex "&ACL;" "testing by regex matching"
32292 This condition is available only when Exim is compiled with the
32293 content-scanning extension, and it is allowed only in the ACL defined by
32294 &%acl_smtp_mime%&. It causes the current MIME part to be scanned for a match
32295 with any of the regular expressions. For details, see chapter
32296 &<<CHAPexiscan>>&.
32297
32298 .vitem &*ratelimit&~=&~*&<&'parameters'&>
32299 .cindex "rate limiting"
32300 This condition can be used to limit the rate at which a user or host submits
32301 messages. Details are given in section &<<SECTratelimiting>>&.
32302
32303 .vitem &*recipients&~=&~*&<&'address&~list'&>
32304 .cindex "&%recipients%& ACL condition"
32305 .cindex "recipient" "ACL checking"
32306 .cindex "&ACL;" "testing a recipient"
32307 This condition is relevant only after a RCPT command. It checks the entire
32308 recipient address against a list of recipients.
32309
32310 .vitem &*regex&~=&~*&<&'list&~of&~regular&~expressions'&>
32311 .cindex "&%regex%& ACL condition"
32312 .cindex "&ACL;" "testing by regex matching"
32313 This condition is available only when Exim is compiled with the
32314 content-scanning extension, and is available only in the DATA, MIME, and
32315 non-SMTP ACLs. It causes the incoming message to be scanned for a match with
32316 any of the regular expressions. For details, see chapter &<<CHAPexiscan>>&.
32317
32318 .vitem &*sender_domains&~=&~*&<&'domain&~list'&>
32319 .cindex "&%sender_domains%& ACL condition"
32320 .cindex "sender" "ACL checking"
32321 .cindex "&ACL;" "testing a sender domain"
32322 .vindex "&$domain$&"
32323 .vindex "&$sender_address_domain$&"
32324 This condition tests the domain of the sender of the message against the given
32325 domain list. &*Note*&: The domain of the sender address is in
32326 &$sender_address_domain$&. It is &'not'& put in &$domain$& during the testing
32327 of this condition. This is an exception to the general rule for testing domain
32328 lists. It is done this way so that, if this condition is used in an ACL for a
32329 RCPT command, the recipient's domain (which is in &$domain$&) can be used to
32330 influence the sender checking.
32331
32332 &*Warning*&: It is a bad idea to use this condition on its own as a control on
32333 relaying, because sender addresses are easily, and commonly, forged.
32334
32335 .vitem &*senders&~=&~*&<&'address&~list'&>
32336 .cindex "&%senders%& ACL condition"
32337 .cindex "sender" "ACL checking"
32338 .cindex "&ACL;" "testing a sender"
32339 This condition tests the sender of the message against the given list. To test
32340 for a bounce message, which has an empty sender, set
32341 .code
32342 senders = :
32343 .endd
32344 &*Warning*&: It is a bad idea to use this condition on its own as a control on
32345 relaying, because sender addresses are easily, and commonly, forged.
32346
32347 .vitem &*spam&~=&~*&<&'username'&>
32348 .cindex "&%spam%& ACL condition"
32349 .cindex "&ACL;" "scanning for spam"
32350 This condition is available only when Exim is compiled with the
32351 content-scanning extension. It causes the incoming message to be scanned by
32352 SpamAssassin. For details, see chapter &<<CHAPexiscan>>&.
32353
32354 .vitem &*verify&~=&~certificate*&
32355 .cindex "&%verify%& ACL condition"
32356 .cindex "TLS" "client certificate verification"
32357 .cindex "certificate" "verification of client"
32358 .cindex "&ACL;" "certificate verification"
32359 .cindex "&ACL;" "testing a TLS certificate"
32360 This condition is true in an SMTP session if the session is encrypted, and a
32361 certificate was received from the client, and the certificate was verified. The
32362 server requests a certificate only if the client matches &%tls_verify_hosts%&
32363 or &%tls_try_verify_hosts%& (see chapter &<<CHAPTLS>>&).
32364
32365 .vitem &*verify&~=&~csa*&
32366 .cindex "CSA verification"
32367 This condition checks whether the sending host (the client) is authorized to
32368 send email. Details of how this works are given in section
32369 &<<SECTverifyCSA>>&.
32370
32371 .vitem &*verify&~=&~header_names_ascii*&
32372 .cindex "&%verify%& ACL condition"
32373 .cindex "&ACL;" "verifying header names only ASCII"
32374 .cindex "header lines" "verifying header names only ASCII"
32375 .cindex "verifying" "header names only ASCII"
32376 This condition is relevant only in an ACL that is run after a message has been
32377 received.
32378 This usually means an ACL specified by &%acl_smtp_data%& or &%acl_not_smtp%&.
32379 It checks all header names (not the content) to make sure
32380 there are no non-ASCII characters, also excluding control characters.  The
32381 allowable characters are decimal ASCII values 33 through 126.
32382
32383 Exim itself will handle headers with non-ASCII characters, but it can cause
32384 problems for downstream applications, so this option will allow their
32385 detection and rejection in the DATA ACL's.
32386
32387 .vitem &*verify&~=&~header_sender/*&<&'options'&>
32388 .cindex "&%verify%& ACL condition"
32389 .cindex "&ACL;" "verifying sender in the header"
32390 .cindex "header lines" "verifying the sender in"
32391 .cindex "sender" "verifying in header"
32392 .cindex "verifying" "sender in header"
32393 This condition is relevant only in an ACL that is run after a message has been
32394 received, that is, in an ACL specified by &%acl_smtp_data%& or
32395 &%acl_not_smtp%&. It checks that there is a verifiable address in at least one
32396 of the &'Sender:'&, &'Reply-To:'&, or &'From:'& header lines. Such an address
32397 is loosely thought of as a &"sender"& address (hence the name of the test).
32398 However, an address that appears in one of these headers need not be an address
32399 that accepts bounce messages; only sender addresses in envelopes are required
32400 to accept bounces. Therefore, if you use the callout option on this check, you
32401 might want to arrange for a non-empty address in the MAIL command.
32402
32403 Details of address verification and the options are given later, starting at
32404 section &<<SECTaddressverification>>& (callouts are described in section
32405 &<<SECTcallver>>&). You can combine this condition with the &%senders%&
32406 condition to restrict it to bounce messages only:
32407 .code
32408 deny    senders = :
32409        !verify  = header_sender
32410         message = A valid sender header is required for bounces
32411 .endd
32412
32413 .vitem &*verify&~=&~header_syntax*&
32414 .cindex "&%verify%& ACL condition"
32415 .cindex "&ACL;" "verifying header syntax"
32416 .cindex "header lines" "verifying syntax"
32417 .cindex "verifying" "header syntax"
32418 This condition is relevant only in an ACL that is run after a message has been
32419 received, that is, in an ACL specified by &%acl_smtp_data%& or
32420 &%acl_not_smtp%&. It checks the syntax of all header lines that can contain
32421 lists of addresses (&'Sender:'&, &'From:'&, &'Reply-To:'&, &'To:'&, &'Cc:'&,
32422 and &'Bcc:'&), returning true if there are no problems.
32423 Unqualified addresses (local parts without domains) are
32424 permitted only in locally generated messages and from hosts that match
32425 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
32426 appropriate.
32427
32428 Note that this condition is a syntax check only. However, a common spamming
32429 ploy used to be to send syntactically invalid headers such as
32430 .code
32431 To: @
32432 .endd
32433 and this condition can be used to reject such messages, though they are not as
32434 common as they used to be.
32435
32436 .vitem &*verify&~=&~helo*&
32437 .cindex "&%verify%& ACL condition"
32438 .cindex "&ACL;" "verifying HELO/EHLO"
32439 .cindex "HELO" "verifying"
32440 .cindex "EHLO" "verifying"
32441 .cindex "verifying" "EHLO"
32442 .cindex "verifying" "HELO"
32443 This condition is true if a HELO or EHLO command has been received from the
32444 client host, and its contents have been verified. If there has been no previous
32445 attempt to verify the HELO/EHLO contents, it is carried out when this
32446 condition is encountered. See the description of the &%helo_verify_hosts%& and
32447 &%helo_try_verify_hosts%& options for details of how to request verification
32448 independently of this condition, and for detail of the verification.
32449
32450 For SMTP input that does not come over TCP/IP (the &%-bs%& command line
32451 option), this condition is always true.
32452
32453
32454 .vitem &*verify&~=&~not_blind/*&<&'options'&>
32455 .cindex "verifying" "not blind"
32456 .cindex "bcc recipients, verifying none"
32457 This condition checks that there are no blind (bcc) recipients in the message.
32458 Every envelope recipient must appear either in a &'To:'& header line or in a
32459 &'Cc:'& header line for this condition to be true. Local parts are checked
32460 case-sensitively; domains are checked case-insensitively. If &'Resent-To:'& or
32461 &'Resent-Cc:'& header lines exist, they are also checked. This condition can be
32462 used only in a DATA or non-SMTP ACL.
32463
32464 There is one possible option, &`case_insensitive`&.  If this is present then
32465 local parts are checked case-insensitively.
32466
32467 There are, of course, many legitimate messages that make use of blind (bcc)
32468 recipients. This check should not be used on its own for blocking messages.
32469
32470
32471 .vitem &*verify&~=&~recipient/*&<&'options'&>
32472 .cindex "&%verify%& ACL condition"
32473 .cindex "&ACL;" "verifying recipient"
32474 .cindex "recipient" "verifying"
32475 .cindex "verifying" "recipient"
32476 .vindex "&$address_data$&"
32477 This condition is relevant only after a RCPT command. It verifies the current
32478 recipient. Details of address verification are given later, starting at section
32479 &<<SECTaddressverification>>&. After a recipient has been verified, the value
32480 of &$address_data$& is the last value that was set while routing the address.
32481 This applies even if the verification fails. When an address that is being
32482 verified is redirected to a single address, verification continues with the new
32483 address, and in that case, the subsequent value of &$address_data$& is the
32484 value for the child address.
32485
32486 .vitem &*verify&~=&~reverse_host_lookup/*&<&'options'&>
32487 .cindex "&%verify%& ACL condition"
32488 .cindex "&ACL;" "verifying host reverse lookup"
32489 .cindex "host" "verifying reverse lookup"
32490 This condition ensures that a verified host name has been looked up from the IP
32491 address of the client host. (This may have happened already if the host name
32492 was needed for checking a host list, or if the host matched &%host_lookup%&.)
32493 Verification ensures that the host name obtained from a reverse DNS lookup, or
32494 one of its aliases, does, when it is itself looked up in the DNS, yield the
32495 original IP address.
32496
32497 There is one possible option, &`defer_ok`&.  If this is present and a
32498 DNS operation returns a temporary error, the verify condition succeeds.
32499
32500 If this condition is used for a locally generated message (that is, when there
32501 is no client host involved), it always succeeds.
32502
32503 .vitem &*verify&~=&~sender/*&<&'options'&>
32504 .cindex "&%verify%& ACL condition"
32505 .cindex "&ACL;" "verifying sender"
32506 .cindex "sender" "verifying"
32507 .cindex "verifying" "sender"
32508 This condition is relevant only after a MAIL or RCPT command, or after a
32509 message has been received (the &%acl_smtp_data%& or &%acl_not_smtp%& ACLs). If
32510 the message's sender is empty (that is, this is a bounce message), the
32511 condition is true. Otherwise, the sender address is verified.
32512
32513 .vindex "&$address_data$&"
32514 .vindex "&$sender_address_data$&"
32515 If there is data in the &$address_data$& variable at the end of routing, its
32516 value is placed in &$sender_address_data$& at the end of verification. This
32517 value can be used in subsequent conditions and modifiers in the same ACL
32518 statement. It does not persist after the end of the current statement. If you
32519 want to preserve the value for longer, you can save it in an ACL variable.
32520
32521 Details of verification are given later, starting at section
32522 &<<SECTaddressverification>>&. Exim caches the result of sender verification,
32523 to avoid doing it more than once per message.
32524
32525 .vitem &*verify&~=&~sender=*&<&'address'&>&*/*&<&'options'&>
32526 .cindex "&%verify%& ACL condition"
32527 This is a variation of the previous option, in which a modified address is
32528 verified as a sender.
32529
32530 Note that '/' is legal in local-parts; if the address may have such
32531 (eg. is generated from the received message)
32532 they must be protected from the options parsing by doubling:
32533 .code
32534 verify = sender=${listquote{/}{${address:$h_sender:}}}
32535 .endd
32536 .endlist
32537
32538
32539
32540 .section "Using DNS lists" "SECTmorednslists"
32541 .cindex "DNS list" "in ACL"
32542 .cindex "black list (DNS)"
32543 .cindex "&ACL;" "testing a DNS list"
32544 In its simplest form, the &%dnslists%& condition tests whether the calling host
32545 is on at least one of a number of DNS lists by looking up the inverted IP
32546 address in one or more DNS domains. (Note that DNS list domains are not mail
32547 domains, so the &`+`& syntax for named lists doesn't work - it is used for
32548 special options instead.) For example, if the calling host's IP
32549 address is 192.168.62.43, and the ACL statement is
32550 .code
32551 deny dnslists = blackholes.mail-abuse.org : \
32552                 dialups.mail-abuse.org
32553 .endd
32554 the following records are looked up:
32555 .code
32556 43.62.168.192.blackholes.mail-abuse.org
32557 43.62.168.192.dialups.mail-abuse.org
32558 .endd
32559 As soon as Exim finds an existing DNS record, processing of the list stops.
32560 Thus, multiple entries on the list provide an &"or"& conjunction. If you want
32561 to test that a host is on more than one list (an &"and"& conjunction), you can
32562 use two separate conditions:
32563 .code
32564 deny dnslists = blackholes.mail-abuse.org
32565      dnslists = dialups.mail-abuse.org
32566 .endd
32567 If a DNS lookup times out or otherwise fails to give a decisive answer, Exim
32568 behaves as if the host does not match the list item, that is, as if the DNS
32569 record does not exist. If there are further items in the DNS list, they are
32570 processed.
32571
32572 This is usually the required action when &%dnslists%& is used with &%deny%&
32573 (which is the most common usage), because it prevents a DNS failure from
32574 blocking mail. However, you can change this behaviour by putting one of the
32575 following special items in the list:
32576 .display
32577 &`+include_unknown `&   behave as if the item is on the list
32578 &`+exclude_unknown `&   behave as if the item is not on the list (default)
32579 &`+defer_unknown   `&   give a temporary error
32580 .endd
32581 .cindex "&`+include_unknown`&"
32582 .cindex "&`+exclude_unknown`&"
32583 .cindex "&`+defer_unknown`&"
32584 Each of these applies to any subsequent items on the list. For example:
32585 .code
32586 deny dnslists = +defer_unknown : foo.bar.example
32587 .endd
32588 Testing the list of domains stops as soon as a match is found. If you want to
32589 warn for one list and block for another, you can use two different statements:
32590 .code
32591 deny  dnslists = blackholes.mail-abuse.org
32592 warn  dnslists = dialups.mail-abuse.org
32593       message  = X-Warn: sending host is on dialups list
32594 .endd
32595 .cindex caching "of dns lookup"
32596 .cindex DNS TTL
32597 DNS list lookups are cached by Exim for the duration of the SMTP session
32598 (but limited by the DNS return TTL value),
32599 so a lookup based on the IP address is done at most once for any incoming
32600 connection (assuming long-enough TTL).
32601 Exim does not share information between multiple incoming
32602 connections (but your local name server cache should be active).
32603
32604 There are a number of DNS lists to choose from, some commercial, some free,
32605 or free for small deployments.  An overview can be found at
32606 &url(https://en.wikipedia.org/wiki/Comparison_of_DNS_blacklists).
32607
32608
32609
32610 .section "Specifying the IP address for a DNS list lookup" "SECID201"
32611 .cindex "DNS list" "keyed by explicit IP address"
32612 By default, the IP address that is used in a DNS list lookup is the IP address
32613 of the calling host. However, you can specify another IP address by listing it
32614 after the domain name, introduced by a slash. For example:
32615 .code
32616 deny dnslists = black.list.tld/192.168.1.2
32617 .endd
32618 This feature is not very helpful with explicit IP addresses; it is intended for
32619 use with IP addresses that are looked up, for example, the IP addresses of the
32620 MX hosts or nameservers of an email sender address. For an example, see section
32621 &<<SECTmulkeyfor>>& below.
32622
32623
32624
32625
32626 .section "DNS lists keyed on domain names" "SECID202"
32627 .cindex "DNS list" "keyed by domain name"
32628 There are some lists that are keyed on domain names rather than inverted IP
32629 addresses (see, e.g., the &'domain based zones'& link at
32630 &url(http://www.rfc-ignorant.org/)). No reversing of components is used
32631 with these lists. You can change the name that is looked up in a DNS list by
32632 listing it after the domain name, introduced by a slash. For example,
32633 .code
32634 deny  dnslists = dsn.rfc-ignorant.org/$sender_address_domain
32635       message  = Sender's domain is listed at $dnslist_domain
32636 .endd
32637 This particular example is useful only in ACLs that are obeyed after the
32638 RCPT or DATA commands, when a sender address is available. If (for
32639 example) the message's sender is &'user@tld.example'& the name that is looked
32640 up by this example is
32641 .code
32642 tld.example.dsn.rfc-ignorant.org
32643 .endd
32644 A single &%dnslists%& condition can contain entries for both names and IP
32645 addresses. For example:
32646 .code
32647 deny dnslists = sbl.spamhaus.org : \
32648                 dsn.rfc-ignorant.org/$sender_address_domain
32649 .endd
32650 The first item checks the sending host's IP address; the second checks a domain
32651 name. The whole condition is true if either of the DNS lookups succeeds.
32652
32653
32654
32655
32656 .section "Multiple explicit keys for a DNS list" "SECTmulkeyfor"
32657 .cindex "DNS list" "multiple keys for"
32658 The syntax described above for looking up explicitly-defined values (either
32659 names or IP addresses) in a DNS blacklist is a simplification. After the domain
32660 name for the DNS list, what follows the slash can in fact be a list of items.
32661 As with all lists in Exim, the default separator is a colon. However, because
32662 this is a sublist within the list of DNS blacklist domains, it is necessary
32663 either to double the separators like this:
32664 .code
32665 dnslists = black.list.tld/name.1::name.2
32666 .endd
32667 or to change the separator character, like this:
32668 .code
32669 dnslists = black.list.tld/<;name.1;name.2
32670 .endd
32671 If an item in the list is an IP address, it is inverted before the DNS
32672 blacklist domain is appended. If it is not an IP address, no inversion
32673 occurs. Consider this condition:
32674 .code
32675 dnslists = black.list.tld/<;192.168.1.2;a.domain
32676 .endd
32677 The DNS lookups that occur are:
32678 .code
32679 2.1.168.192.black.list.tld
32680 a.domain.black.list.tld
32681 .endd
32682 Once a DNS record has been found (that matches a specific IP return
32683 address, if specified &-- see section &<<SECTaddmatcon>>&), no further lookups
32684 are done. If there is a temporary DNS error, the rest of the sublist of domains
32685 or IP addresses is tried. A temporary error for the whole dnslists item occurs
32686 only if no other DNS lookup in this sublist succeeds. In other words, a
32687 successful lookup for any of the items in the sublist overrides a temporary
32688 error for a previous item.
32689
32690 The ability to supply a list of items after the slash is in some sense just a
32691 syntactic convenience. These two examples have the same effect:
32692 .code
32693 dnslists = black.list.tld/a.domain : black.list.tld/b.domain
32694 dnslists = black.list.tld/a.domain::b.domain
32695 .endd
32696 However, when the data for the list is obtained from a lookup, the second form
32697 is usually much more convenient. Consider this example:
32698 .code
32699 deny dnslists = sbl.spamhaus.org/<|${lookup dnsdb {>|a=<|\
32700                                    ${lookup dnsdb {>|mxh=\
32701                                    $sender_address_domain} }} }
32702      message  = The mail servers for the domain \
32703                 $sender_address_domain \
32704                 are listed at $dnslist_domain ($dnslist_value); \
32705                 see $dnslist_text.
32706 .endd
32707 Note the use of &`>|`& in the dnsdb lookup to specify the separator for
32708 multiple DNS records. The inner dnsdb lookup produces a list of MX hosts
32709 and the outer dnsdb lookup finds the IP addresses for these hosts. The result
32710 of expanding the condition might be something like this:
32711 .code
32712 dnslists = sbl.spamhaus.org/<|192.168.2.3|192.168.5.6|...
32713 .endd
32714 Thus, this example checks whether or not the IP addresses of the sender
32715 domain's mail servers are on the Spamhaus black list.
32716
32717 The key that was used for a successful DNS list lookup is put into the variable
32718 &$dnslist_matched$& (see section &<<SECID204>>&).
32719
32720
32721
32722
32723 .section "Data returned by DNS lists" "SECID203"
32724 .cindex "DNS list" "data returned from"
32725 DNS lists are constructed using address records in the DNS. The original RBL
32726 just used the address 127.0.0.1 on the right hand side of each record, but the
32727 RBL+ list and some other lists use a number of values with different meanings.
32728 The values used on the RBL+ list are:
32729 .display
32730 127.1.0.1  RBL
32731 127.1.0.2  DUL
32732 127.1.0.3  DUL and RBL
32733 127.1.0.4  RSS
32734 127.1.0.5  RSS and RBL
32735 127.1.0.6  RSS and DUL
32736 127.1.0.7  RSS and DUL and RBL
32737 .endd
32738 Section &<<SECTaddmatcon>>& below describes how you can distinguish between
32739 different values. Some DNS lists may return more than one address record;
32740 see section &<<SECThanmuldnsrec>>& for details of how they are checked.
32741
32742 .new
32743 Values returned by a properly running DBSBL should be in the 127.0.0.0/8
32744 range. If a DNSBL operator loses control of the domain, lookups on it
32745 may start returning other addresses.  Because of this, Exim now ignores
32746 returned values outside the 127/8 region.
32747 .wen
32748
32749
32750 .section "Variables set from DNS lists" "SECID204"
32751 .cindex "expansion" "variables, set from DNS list"
32752 .cindex "DNS list" "variables set from"
32753 .vindex "&$dnslist_domain$&"
32754 .vindex "&$dnslist_matched$&"
32755 .vindex "&$dnslist_text$&"
32756 .vindex "&$dnslist_value$&"
32757 When an entry is found in a DNS list, the variable &$dnslist_domain$& contains
32758 the name of the overall domain that matched (for example,
32759 &`spamhaus.example`&), &$dnslist_matched$& contains the key within that domain
32760 (for example, &`192.168.5.3`&), and &$dnslist_value$& contains the data from
32761 the DNS record. When the key is an IP address, it is not reversed in
32762 &$dnslist_matched$& (though it is, of course, in the actual lookup). In simple
32763 cases, for example:
32764 .code
32765 deny dnslists = spamhaus.example
32766 .endd
32767 the key is also available in another variable (in this case,
32768 &$sender_host_address$&). In more complicated cases, however, this is not true.
32769 For example, using a data lookup (as described in section &<<SECTmulkeyfor>>&)
32770 might generate a dnslists lookup like this:
32771 .code
32772 deny dnslists = spamhaus.example/<|192.168.1.2|192.168.6.7|...
32773 .endd
32774 If this condition succeeds, the value in &$dnslist_matched$& might be
32775 &`192.168.6.7`& (for example).
32776
32777 If more than one address record is returned by the DNS lookup, all the IP
32778 addresses are included in &$dnslist_value$&, separated by commas and spaces.
32779 The variable &$dnslist_text$& contains the contents of any associated TXT
32780 record. For lists such as RBL+ the TXT record for a merged entry is often not
32781 very meaningful. See section &<<SECTmordetinf>>& for a way of obtaining more
32782 information.
32783
32784 You can use the DNS list variables in &%message%& or &%log_message%& modifiers
32785 &-- even if these appear before the condition in the ACL, they are not
32786 expanded until after it has failed. For example:
32787 .code
32788 deny    hosts = !+local_networks
32789         message = $sender_host_address is listed \
32790                   at $dnslist_domain
32791         dnslists = rbl-plus.mail-abuse.example
32792 .endd
32793
32794
32795
32796 .section "Additional matching conditions for DNS lists" "SECTaddmatcon"
32797 .cindex "DNS list" "matching specific returned data"
32798 You can add an equals sign and an IP address after a &%dnslists%& domain name
32799 in order to restrict its action to DNS records with a matching right hand side.
32800 For example,
32801 .code
32802 deny dnslists = rblplus.mail-abuse.org=127.0.0.2
32803 .endd
32804 rejects only those hosts that yield 127.0.0.2. Without this additional data,
32805 any address record is considered to be a match. For the moment, we assume
32806 that the DNS lookup returns just one record. Section &<<SECThanmuldnsrec>>&
32807 describes how multiple records are handled.
32808
32809 More than one IP address may be given for checking, using a comma as a
32810 separator. These are alternatives &-- if any one of them matches, the
32811 &%dnslists%& condition is true. For example:
32812 .code
32813 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
32814 .endd
32815 If you want to specify a constraining address list and also specify names or IP
32816 addresses to be looked up, the constraining address list must be specified
32817 first. For example:
32818 .code
32819 deny dnslists = dsn.rfc-ignorant.org\
32820                 =127.0.0.2/$sender_address_domain
32821 .endd
32822
32823 If the character &`&&`& is used instead of &`=`&, the comparison for each
32824 listed IP address is done by a bitwise &"and"& instead of by an equality test.
32825 In other words, the listed addresses are used as bit masks. The comparison is
32826 true if all the bits in the mask are present in the address that is being
32827 tested. For example:
32828 .code
32829 dnslists = a.b.c&0.0.0.3
32830 .endd
32831 matches if the address is &'x.x.x.'&3, &'x.x.x.'&7, &'x.x.x.'&11, etc. If you
32832 want to test whether one bit or another bit is present (as opposed to both
32833 being present), you must use multiple values. For example:
32834 .code
32835 dnslists = a.b.c&0.0.0.1,0.0.0.2
32836 .endd
32837 matches if the final component of the address is an odd number or two times
32838 an odd number.
32839
32840
32841
32842 .section "Negated DNS matching conditions" "SECID205"
32843 You can supply a negative list of IP addresses as part of a &%dnslists%&
32844 condition. Whereas
32845 .code
32846 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
32847 .endd
32848 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
32849 IP address yielded by the list is either 127.0.0.2 or 127.0.0.3"&,
32850 .code
32851 deny  dnslists = a.b.c!=127.0.0.2,127.0.0.3
32852 .endd
32853 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
32854 IP address yielded by the list is not 127.0.0.2 and not 127.0.0.3"&. In other
32855 words, the result of the test is inverted if an exclamation mark appears before
32856 the &`=`& (or the &`&&`&) sign.
32857
32858 &*Note*&: This kind of negation is not the same as negation in a domain,
32859 host, or address list (which is why the syntax is different).
32860
32861 If you are using just one list, the negation syntax does not gain you much. The
32862 previous example is precisely equivalent to
32863 .code
32864 deny  dnslists = a.b.c
32865      !dnslists = a.b.c=127.0.0.2,127.0.0.3
32866 .endd
32867 However, if you are using multiple lists, the negation syntax is clearer.
32868 Consider this example:
32869 .code
32870 deny  dnslists = sbl.spamhaus.org : \
32871                  list.dsbl.org : \
32872                  dnsbl.njabl.org!=127.0.0.3 : \
32873                  relays.ordb.org
32874 .endd
32875 Using only positive lists, this would have to be:
32876 .code
32877 deny  dnslists = sbl.spamhaus.org : \
32878                  list.dsbl.org
32879 deny  dnslists = dnsbl.njabl.org
32880      !dnslists = dnsbl.njabl.org=127.0.0.3
32881 deny  dnslists = relays.ordb.org
32882 .endd
32883 which is less clear, and harder to maintain.
32884
32885 Negation can also be used with a bitwise-and restriction.
32886 The dnslists condition with only be trus if a result is returned
32887 by the lookup which, anded with the restriction, is all zeroes.
32888 For example:
32889 .code
32890 deny dnslists = zen.spamhaus.org!&0.255.255.0
32891 .endd
32892
32893
32894
32895
32896 .section "Handling multiple DNS records from a DNS list" "SECThanmuldnsrec"
32897 A DNS lookup for a &%dnslists%& condition may return more than one DNS record,
32898 thereby providing more than one IP address. When an item in a &%dnslists%& list
32899 is followed by &`=`& or &`&&`& and a list of IP addresses, in order to restrict
32900 the match to specific results from the DNS lookup, there are two ways in which
32901 the checking can be handled. For example, consider the condition:
32902 .code
32903 dnslists = a.b.c=127.0.0.1
32904 .endd
32905 What happens if the DNS lookup for the incoming IP address yields both
32906 127.0.0.1 and 127.0.0.2 by means of two separate DNS records? Is the
32907 condition true because at least one given value was found, or is it false
32908 because at least one of the found values was not listed? And how does this
32909 affect negated conditions? Both possibilities are provided for with the help of
32910 additional separators &`==`& and &`=&&`&.
32911
32912 .ilist
32913 If &`=`& or &`&&`& is used, the condition is true if any one of the looked up
32914 IP addresses matches one of the listed addresses. For the example above, the
32915 condition is true because 127.0.0.1 matches.
32916 .next
32917 If &`==`& or &`=&&`& is used, the condition is true only if every one of the
32918 looked up IP addresses matches one of the listed addresses. If the condition is
32919 changed to:
32920 .code
32921 dnslists = a.b.c==127.0.0.1
32922 .endd
32923 and the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
32924 false because 127.0.0.2 is not listed. You would need to have:
32925 .code
32926 dnslists = a.b.c==127.0.0.1,127.0.0.2
32927 .endd
32928 for the condition to be true.
32929 .endlist
32930
32931 When &`!`& is used to negate IP address matching, it inverts the result, giving
32932 the precise opposite of the behaviour above. Thus:
32933 .ilist
32934 If &`!=`& or &`!&&`& is used, the condition is true if none of the looked up IP
32935 addresses matches one of the listed addresses. Consider:
32936 .code
32937 dnslists = a.b.c!&0.0.0.1
32938 .endd
32939 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
32940 false because 127.0.0.1 matches.
32941 .next
32942 If &`!==`& or &`!=&&`& is used, the condition is true if there is at least one
32943 looked up IP address that does not match. Consider:
32944 .code
32945 dnslists = a.b.c!=&0.0.0.1
32946 .endd
32947 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
32948 true, because 127.0.0.2 does not match. You would need to have:
32949 .code
32950 dnslists = a.b.c!=&0.0.0.1,0.0.0.2
32951 .endd
32952 for the condition to be false.
32953 .endlist
32954 When the DNS lookup yields only a single IP address, there is no difference
32955 between &`=`& and &`==`& and between &`&&`& and &`=&&`&.
32956
32957
32958
32959
32960 .section "Detailed information from merged DNS lists" "SECTmordetinf"
32961 .cindex "DNS list" "information from merged"
32962 When the facility for restricting the matching IP values in a DNS list is used,
32963 the text from the TXT record that is set in &$dnslist_text$& may not reflect
32964 the true reason for rejection. This happens when lists are merged and the IP
32965 address in the A record is used to distinguish them; unfortunately there is
32966 only one TXT record. One way round this is not to use merged lists, but that
32967 can be inefficient because it requires multiple DNS lookups where one would do
32968 in the vast majority of cases when the host of interest is not on any of the
32969 lists.
32970
32971 A less inefficient way of solving this problem is available. If
32972 two domain names, comma-separated, are given, the second is used first to
32973 do an initial check, making use of any IP value restrictions that are set.
32974 If there is a match, the first domain is used, without any IP value
32975 restrictions, to get the TXT record. As a byproduct of this, there is also
32976 a check that the IP being tested is indeed on the first list. The first
32977 domain is the one that is put in &$dnslist_domain$&. For example:
32978 .code
32979 deny   dnslists = \
32980          sbl.spamhaus.org,sbl-xbl.spamhaus.org=127.0.0.2 : \
32981          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
32982        message  = \
32983          rejected because $sender_host_address is blacklisted \
32984          at $dnslist_domain\n$dnslist_text
32985 .endd
32986 For the first blacklist item, this starts by doing a lookup in
32987 &'sbl-xbl.spamhaus.org'& and testing for a 127.0.0.2 return. If there is a
32988 match, it then looks in &'sbl.spamhaus.org'&, without checking the return
32989 value, and as long as something is found, it looks for the corresponding TXT
32990 record. If there is no match in &'sbl-xbl.spamhaus.org'&, nothing more is done.
32991 The second blacklist item is processed similarly.
32992
32993 If you are interested in more than one merged list, the same list must be
32994 given several times, but because the results of the DNS lookups are cached,
32995 the DNS calls themselves are not repeated. For example:
32996 .code
32997 deny dnslists = \
32998          http.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.2 : \
32999          socks.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.3 : \
33000          misc.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.4 : \
33001          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
33002 .endd
33003 In this case there is one lookup in &'dnsbl.sorbs.net'&, and if none of the IP
33004 values matches (or if no record is found), this is the only lookup that is
33005 done. Only if there is a match is one of the more specific lists consulted.
33006
33007
33008
33009 .section "DNS lists and IPv6" "SECTmorednslistslast"
33010 .cindex "IPv6" "DNS black lists"
33011 .cindex "DNS list" "IPv6 usage"
33012 If Exim is asked to do a dnslist lookup for an IPv6 address, it inverts it
33013 nibble by nibble. For example, if the calling host's IP address is
33014 3ffe:ffff:836f:0a00:000a:0800:200a:c031, Exim might look up
33015 .code
33016 1.3.0.c.a.0.0.2.0.0.8.0.a.0.0.0.0.0.a.0.f.6.3.8.
33017   f.f.f.f.e.f.f.3.blackholes.mail-abuse.org
33018 .endd
33019 (split over two lines here to fit on the page). Unfortunately, some of the DNS
33020 lists contain wildcard records, intended for IPv4, that interact badly with
33021 IPv6. For example, the DNS entry
33022 .code
33023 *.3.some.list.example.    A    127.0.0.1
33024 .endd
33025 is probably intended to put the entire 3.0.0.0/8 IPv4 network on the list.
33026 Unfortunately, it also matches the entire 3::/4 IPv6 network.
33027
33028 You can exclude IPv6 addresses from DNS lookups by making use of a suitable
33029 &%condition%& condition, as in this example:
33030 .code
33031 deny   condition = ${if isip4{$sender_host_address}}
33032        dnslists  = some.list.example
33033 .endd
33034
33035 If an explicit key is being used for a DNS lookup and it may be an IPv6
33036 address you should specify alternate list separators for both the outer
33037 (DNS list name) list and inner (lookup keys) list:
33038 .code
33039        dnslists = <; dnsbl.example.com/<|$acl_m_addrslist
33040 .endd
33041
33042 .section "Rate limiting incoming messages" "SECTratelimiting"
33043 .cindex "rate limiting" "client sending"
33044 .cindex "limiting client sending rates"
33045 .oindex "&%smtp_ratelimit_*%&"
33046 The &%ratelimit%& ACL condition can be used to measure and control the rate at
33047 which clients can send email. This is more powerful than the
33048 &%smtp_ratelimit_*%& options, because those options control the rate of
33049 commands in a single SMTP session only, whereas the &%ratelimit%& condition
33050 works across all connections (concurrent and sequential) from the same client
33051 host. The syntax of the &%ratelimit%& condition is:
33052 .display
33053 &`ratelimit =`& <&'m'&> &`/`& <&'p'&> &`/`& <&'options'&> &`/`& <&'key'&>
33054 .endd
33055 If the average client sending rate is less than &'m'& messages per time
33056 period &'p'& then the condition is false; otherwise it is true.
33057
33058 As a side-effect, the &%ratelimit%& condition sets the expansion variable
33059 &$sender_rate$& to the client's computed rate, &$sender_rate_limit$& to the
33060 configured value of &'m'&, and &$sender_rate_period$& to the configured value
33061 of &'p'&.
33062
33063 The parameter &'p'& is the smoothing time constant, in the form of an Exim
33064 time interval, for example, &`8h`& for eight hours. A larger time constant
33065 means that it takes Exim longer to forget a client's past behaviour. The
33066 parameter &'m'& is the maximum number of messages that a client is permitted to
33067 send in each time interval. It also specifies the number of messages permitted
33068 in a fast burst. By increasing both &'m'& and &'p'& but keeping &'m/p'&
33069 constant, you can allow a client to send more messages in a burst without
33070 changing its long-term sending rate limit. Conversely, if &'m'& and &'p'& are
33071 both small, messages must be sent at an even rate.
33072
33073 There is a script in &_util/ratelimit.pl_& which extracts sending rates from
33074 log files, to assist with choosing appropriate settings for &'m'& and &'p'&
33075 when deploying the &%ratelimit%& ACL condition. The script prints usage
33076 instructions when it is run with no arguments.
33077
33078 The key is used to look up the data for calculating the client's average
33079 sending rate. This data is stored in Exim's spool directory, alongside the
33080 retry and other hints databases. The default key is &$sender_host_address$&,
33081 which means Exim computes the sending rate of each client host IP address.
33082 By changing the key you can change how Exim identifies clients for the purpose
33083 of ratelimiting. For example, to limit the sending rate of each authenticated
33084 user, independent of the computer they are sending from, set the key to
33085 &$authenticated_id$&. You must ensure that the lookup key is meaningful; for
33086 example, &$authenticated_id$& is only meaningful if the client has
33087 authenticated (which you can check with the &%authenticated%& ACL condition).
33088
33089 The lookup key does not have to identify clients: If you want to limit the
33090 rate at which a recipient receives messages, you can use the key
33091 &`$local_part@$domain`& with the &%per_rcpt%& option (see below) in a RCPT
33092 ACL.
33093
33094 Each &%ratelimit%& condition can have up to four options. A &%per_*%& option
33095 specifies what Exim measures the rate of, for example, messages or recipients
33096 or bytes. You can adjust the measurement using the &%unique=%& and/or
33097 &%count=%& options. You can also control when Exim updates the recorded rate
33098 using a &%strict%&, &%leaky%&, or &%readonly%& option. The options are
33099 separated by a slash, like the other parameters. They may appear in any order.
33100
33101 Internally, Exim appends the smoothing constant &'p'& onto the lookup key with
33102 any options that alter the meaning of the stored data. The limit &'m'& is not
33103 stored, so you can alter the configured maximum rate and Exim will still
33104 remember clients' past behaviour. If you change the &%per_*%& mode or add or
33105 remove the &%unique=%& option, the lookup key changes so Exim will forget past
33106 behaviour. The lookup key is not affected by changes to the update mode and
33107 the &%count=%& option.
33108
33109
33110 .section "Ratelimit options for what is being measured" "ratoptmea"
33111 .cindex "rate limiting" "per_* options"
33112 The &%per_conn%& option limits the client's connection rate. It is not
33113 normally used in the &%acl_not_smtp%&, &%acl_not_smtp_mime%&, or
33114 &%acl_not_smtp_start%& ACLs.
33115
33116 The &%per_mail%& option limits the client's rate of sending messages. This is
33117 the default if none of the &%per_*%& options is specified. It can be used in
33118 &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&, &%acl_smtp_mime%&,
33119 &%acl_smtp_data%&, or &%acl_not_smtp%&.
33120
33121 The &%per_byte%& option limits the sender's email bandwidth. It can be used in
33122 the same ACLs as the &%per_mail%& option, though it is best to use this option
33123 in the &%acl_smtp_mime%&, &%acl_smtp_data%& or &%acl_not_smtp%& ACLs; if it is
33124 used in an earlier ACL, Exim relies on the SIZE parameter given by the client
33125 in its MAIL command, which may be inaccurate or completely missing. You can
33126 follow the limit &'m'& in the configuration with K, M, or G to specify limits
33127 in kilobytes, megabytes, or gigabytes, respectively.
33128
33129 The &%per_rcpt%& option causes Exim to limit the rate at which recipients are
33130 accepted. It can be used in the &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
33131 &%acl_smtp_mime%&, or &%acl_smtp_data%& ACLs. In
33132 &%acl_smtp_rcpt%& the rate is updated one recipient at a time; in the other
33133 ACLs the rate is updated with the total (accepted) recipient count in one go. Note that
33134 in either case the rate limiting engine will see a message with many
33135 recipients as a large high-speed burst.
33136
33137 The &%per_addr%& option is like the &%per_rcpt%& option, except it counts the
33138 number of different recipients that the client has sent messages to in the
33139 last time period. That is, if the client repeatedly sends messages to the same
33140 recipient, its measured rate is not increased. This option can only be used in
33141 &%acl_smtp_rcpt%&.
33142
33143 The &%per_cmd%& option causes Exim to recompute the rate every time the
33144 condition is processed. This can be used to limit the rate of any SMTP
33145 command. If it is used in multiple ACLs it can limit the aggregate rate of
33146 multiple different commands.
33147
33148 The &%count=%& option can be used to alter how much Exim adds to the client's
33149 measured rate. For example, the &%per_byte%& option is equivalent to
33150 &`per_mail/count=$message_size`&. If there is no &%count=%& option, Exim
33151 increases the measured rate by one (except for the &%per_rcpt%& option in ACLs
33152 other than &%acl_smtp_rcpt%&). The count does not have to be an integer.
33153
33154 The &%unique=%& option is described in section &<<ratoptuniq>>& below.
33155
33156
33157 .section "Ratelimit update modes" "ratoptupd"
33158 .cindex "rate limiting" "reading data without updating"
33159 You can specify one of three options with the &%ratelimit%& condition to
33160 control when its database is updated. This section describes the &%readonly%&
33161 mode, and the next section describes the &%strict%& and &%leaky%& modes.
33162
33163 If the &%ratelimit%& condition is used in &%readonly%& mode, Exim looks up a
33164 previously-computed rate to check against the limit.
33165
33166 For example, you can test the client's sending rate and deny it access (when
33167 it is too fast) in the connect ACL. If the client passes this check then it
33168 can go on to send a message, in which case its recorded rate will be updated
33169 in the MAIL ACL. Subsequent connections from the same client will check this
33170 new rate.
33171 .code
33172 acl_check_connect:
33173  deny ratelimit = 100 / 5m / readonly
33174       log_message = RATE CHECK: $sender_rate/$sender_rate_period \
33175                   (max $sender_rate_limit)
33176 # ...
33177 acl_check_mail:
33178  warn ratelimit = 100 / 5m / strict
33179       log_message = RATE UPDATE: $sender_rate/$sender_rate_period \
33180                   (max $sender_rate_limit)
33181 .endd
33182
33183 If Exim encounters multiple &%ratelimit%& conditions with the same key when
33184 processing a message then it may increase the client's measured rate more than
33185 it should. For example, this will happen if you check the &%per_rcpt%& option
33186 in both &%acl_smtp_rcpt%& and &%acl_smtp_data%&. However it's OK to check the
33187 same &%ratelimit%& condition multiple times in the same ACL. You can avoid any
33188 multiple update problems by using the &%readonly%& option on later ratelimit
33189 checks.
33190
33191 The &%per_*%& options described above do not make sense in some ACLs. If you
33192 use a &%per_*%& option in an ACL where it is not normally permitted then the
33193 update mode defaults to &%readonly%& and you cannot specify the &%strict%& or
33194 &%leaky%& modes. In other ACLs the default update mode is &%leaky%& (see the
33195 next section) so you must specify the &%readonly%& option explicitly.
33196
33197
33198 .section "Ratelimit options for handling fast clients" "ratoptfast"
33199 .cindex "rate limiting" "strict and leaky modes"
33200 If a client's average rate is greater than the maximum, the rate limiting
33201 engine can react in two possible ways, depending on the presence of the
33202 &%strict%& or &%leaky%& update modes. This is independent of the other
33203 counter-measures (such as rejecting the message) that may be specified by the
33204 rest of the ACL.
33205
33206 The &%leaky%& (default) option means that the client's recorded rate is not
33207 updated if it is above the limit. The effect of this is that Exim measures the
33208 client's average rate of successfully sent email,
33209 up to the given limit.
33210 This is appropriate if the countermeasure when the condition is true
33211 consists of refusing the message, and
33212 is generally the better choice if you have clients that retry automatically.
33213 If the action when true is anything more complex then this option is
33214 likely not what is wanted.
33215
33216 The &%strict%& option means that the client's recorded rate is always
33217 updated. The effect of this is that Exim measures the client's average rate
33218 of attempts to send email, which can be much higher than the maximum it is
33219 actually allowed. If the client is over the limit it may be subjected to
33220 counter-measures by the ACL. It must slow down and allow sufficient time to
33221 pass that its computed rate falls below the maximum before it can send email
33222 again. The time (the number of smoothing periods) it must wait and not
33223 attempt to send mail can be calculated with this formula:
33224 .code
33225         ln(peakrate/maxrate)
33226 .endd
33227
33228
33229 .section "Limiting the rate of different events" "ratoptuniq"
33230 .cindex "rate limiting" "counting unique events"
33231 The &%ratelimit%& &%unique=%& option controls a mechanism for counting the
33232 rate of different events. For example, the &%per_addr%& option uses this
33233 mechanism to count the number of different recipients that the client has
33234 sent messages to in the last time period; it is equivalent to
33235 &`per_rcpt/unique=$local_part@$domain`&. You could use this feature to
33236 measure the rate that a client uses different sender addresses with the
33237 options &`per_mail/unique=$sender_address`&.
33238
33239 For each &%ratelimit%& key Exim stores the set of &%unique=%& values that it
33240 has seen for that key. The whole set is thrown away when it is older than the
33241 rate smoothing period &'p'&, so each different event is counted at most once
33242 per period. In the &%leaky%& update mode, an event that causes the client to
33243 go over the limit is not added to the set, in the same way that the client's
33244 recorded rate is not updated in the same situation.
33245
33246 When you combine the &%unique=%& and &%readonly%& options, the specific
33247 &%unique=%& value is ignored, and Exim just retrieves the client's stored
33248 rate.
33249
33250 The &%unique=%& mechanism needs more space in the ratelimit database than the
33251 other &%ratelimit%& options in order to store the event set. The number of
33252 unique values is potentially as large as the rate limit, so the extra space
33253 required increases with larger limits.
33254
33255 The uniqueification is not perfect: there is a small probability that Exim
33256 will think a new event has happened before. If the sender's rate is less than
33257 the limit, Exim should be more than 99.9% correct. However in &%strict%& mode
33258 the measured rate can go above the limit, in which case Exim may under-count
33259 events by a significant margin. Fortunately, if the rate is high enough (2.7
33260 times the limit) that the false positive rate goes above 9%, then Exim will
33261 throw away the over-full event set before the measured rate falls below the
33262 limit. Therefore the only harm should be that exceptionally high sending rates
33263 are logged incorrectly; any countermeasures you configure will be as effective
33264 as intended.
33265
33266
33267 .section "Using rate limiting" "useratlim"
33268 Exim's other ACL facilities are used to define what counter-measures are taken
33269 when the rate limit is exceeded. This might be anything from logging a warning
33270 (for example, while measuring existing sending rates in order to define
33271 policy), through time delays to slow down fast senders, up to rejecting the
33272 message. For example:
33273 .code
33274 # Log all senders' rates
33275 warn ratelimit = 0 / 1h / strict
33276      log_message = Sender rate $sender_rate / $sender_rate_period
33277
33278 # Slow down fast senders; note the need to truncate $sender_rate
33279 # at the decimal point.
33280 warn ratelimit = 100 / 1h / per_rcpt / strict
33281      delay     = ${eval: ${sg{$sender_rate}{[.].*}{}} - \
33282                    $sender_rate_limit }s
33283
33284 # Keep authenticated users under control
33285 deny authenticated = *
33286      ratelimit = 100 / 1d / strict / $authenticated_id
33287
33288 # System-wide rate limit
33289 defer ratelimit = 10 / 1s / $primary_hostname
33290       message = Sorry, too busy. Try again later.
33291
33292 # Restrict incoming rate from each host, with a default
33293 # set using a macro and special cases looked up in a table.
33294 defer ratelimit = ${lookup {$sender_host_address} \
33295                    cdb {DB/ratelimits.cdb} \
33296                    {$value} {RATELIMIT} }
33297       message = Sender rate exceeds $sender_rate_limit \
33298                messages per $sender_rate_period
33299 .endd
33300 &*Warning*&: If you have a busy server with a lot of &%ratelimit%& tests,
33301 especially with the &%per_rcpt%& option, you may suffer from a performance
33302 bottleneck caused by locking on the ratelimit hints database. Apart from
33303 making your ACLs less complicated, you can reduce the problem by using a
33304 RAM disk for Exim's hints directory (usually &_/var/spool/exim/db/_&). However
33305 this means that Exim will lose its hints data after a reboot (including retry
33306 hints, the callout cache, and ratelimit data).
33307
33308
33309
33310 .section "Address verification" "SECTaddressverification"
33311 .cindex "verifying address" "options for"
33312 .cindex "policy control" "address verification"
33313 Several of the &%verify%& conditions described in section
33314 &<<SECTaclconditions>>& cause addresses to be verified. Section
33315 &<<SECTsenaddver>>& discusses the reporting of sender verification failures.
33316 The verification conditions can be followed by options that modify the
33317 verification process. The options are separated from the keyword and from each
33318 other by slashes, and some of them contain parameters. For example:
33319 .code
33320 verify = sender/callout
33321 verify = recipient/defer_ok/callout=10s,defer_ok
33322 .endd
33323 The first stage of address verification, which always happens, is to run the
33324 address through the routers, in &"verify mode"&. Routers can detect the
33325 difference between verification and routing for delivery, and their actions can
33326 be varied by a number of generic options such as &%verify%& and &%verify_only%&
33327 (see chapter &<<CHAProutergeneric>>&). If routing fails, verification fails.
33328 The available options are as follows:
33329
33330 .ilist
33331 If the &%callout%& option is specified, successful routing to one or more
33332 remote hosts is followed by a &"callout"& to those hosts as an additional
33333 check. Callouts and their sub-options are discussed in the next section.
33334 .next
33335 If there is a defer error while doing verification routing, the ACL
33336 normally returns &"defer"&. However, if you include &%defer_ok%& in the
33337 options, the condition is forced to be true instead. Note that this is a main
33338 verification option as well as a suboption for callouts.
33339 .next
33340 The &%no_details%& option is covered in section &<<SECTsenaddver>>&, which
33341 discusses the reporting of sender address verification failures.
33342 .next
33343 The &%success_on_redirect%& option causes verification always to succeed
33344 immediately after a successful redirection. By default, if a redirection
33345 generates just one address, that address is also verified. See further
33346 discussion in section &<<SECTredirwhilveri>>&.
33347 .new
33348 .next
33349 If the &%quota%& option is specified for recipient verify,
33350 successful routing to an appendfile transport is followed by a call into
33351 the transport to evaluate the quota status for the recipient.
33352 No actual delivery is done, but verification will succeed if the quota
33353 is sufficient for the message (if the sender gave a message size) or
33354 not already exceeded (otherwise).
33355 .wen
33356 .endlist
33357
33358 .cindex "verifying address" "differentiating failures"
33359 .vindex "&$recipient_verify_failure$&"
33360 .vindex "&$sender_verify_failure$&"
33361 .vindex "&$acl_verify_message$&"
33362 After an address verification failure, &$acl_verify_message$& contains the
33363 error message that is associated with the failure. It can be preserved by
33364 coding like this:
33365 .code
33366 warn  !verify = sender
33367        set acl_m0 = $acl_verify_message
33368 .endd
33369 If you are writing your own custom rejection message or log message when
33370 denying access, you can use this variable to include information about the
33371 verification failure.
33372 This variable is cleared at the end of processing the ACL verb.
33373
33374 In addition, &$sender_verify_failure$& or &$recipient_verify_failure$& (as
33375 appropriate) contains one of the following words:
33376
33377 .ilist
33378 &%qualify%&: The address was unqualified (no domain), and the message
33379 was neither local nor came from an exempted host.
33380 .next
33381 &%route%&: Routing failed.
33382 .next
33383 &%mail%&: Routing succeeded, and a callout was attempted; rejection
33384 occurred at or before the MAIL command (that is, on initial
33385 connection, HELO, or MAIL).
33386 .next
33387 &%recipient%&: The RCPT command in a callout was rejected.
33388 .next
33389 &%postmaster%&: The postmaster check in a callout was rejected.
33390 .new
33391 .next
33392 &%quota%&: The quota check for a local recipient did non pass.
33393 .endlist
33394
33395 The main use of these variables is expected to be to distinguish between
33396 rejections of MAIL and rejections of RCPT in callouts.
33397
33398 The above variables may also be set after a &*successful*&
33399 address verification to:
33400
33401 .ilist
33402 &%random%&: A random local-part callout succeeded
33403 .endlist
33404
33405
33406
33407
33408 .section "Callout verification" "SECTcallver"
33409 .cindex "verifying address" "by callout"
33410 .cindex "callout" "verification"
33411 .cindex "SMTP" "callout verification"
33412 For non-local addresses, routing verifies the domain, but is unable to do any
33413 checking of the local part. There are situations where some means of verifying
33414 the local part is desirable. One way this can be done is to make an SMTP
33415 &'callback'& to a delivery host for the sender address or a &'callforward'& to
33416 a subsequent host for a recipient address, to see if the host accepts the
33417 address. We use the term &'callout'& to cover both cases. Note that for a
33418 sender address, the callback is not to the client host that is trying to
33419 deliver the message, but to one of the hosts that accepts incoming mail for the
33420 sender's domain.
33421
33422 Exim does not do callouts by default. If you want them to happen, you must
33423 request them by setting appropriate options on the &%verify%& condition, as
33424 described below. This facility should be used with care, because it can add a
33425 lot of resource usage to the cost of verifying an address. However, Exim does
33426 cache the results of callouts, which helps to reduce the cost. Details of
33427 caching are in section &<<SECTcallvercache>>&.
33428
33429 Recipient callouts are usually used only between hosts that are controlled by
33430 the same administration. For example, a corporate gateway host could use
33431 callouts to check for valid recipients on an internal mailserver. A successful
33432 callout does not guarantee that a real delivery to the address would succeed;
33433 on the other hand, a failing callout does guarantee that a delivery would fail.
33434
33435 If the &%callout%& option is present on a condition that verifies an address, a
33436 second stage of verification occurs if the address is successfully routed to
33437 one or more remote hosts. The usual case is routing by a &(dnslookup)& or a
33438 &(manualroute)& router, where the router specifies the hosts. However, if a
33439 router that does not set up hosts routes to an &(smtp)& transport with a
33440 &%hosts%& setting, the transport's hosts are used. If an &(smtp)& transport has
33441 &%hosts_override%& set, its hosts are always used, whether or not the router
33442 supplies a host list.
33443 Callouts are only supported on &(smtp)& transports.
33444
33445 The port that is used is taken from the transport, if it is specified and is a
33446 remote transport. (For routers that do verification only, no transport need be
33447 specified.) Otherwise, the default SMTP port is used. If a remote transport
33448 specifies an outgoing interface, this is used; otherwise the interface is not
33449 specified. Likewise, the text that is used for the HELO command is taken from
33450 the transport's &%helo_data%& option; if there is no transport, the value of
33451 &$smtp_active_hostname$& is used.
33452
33453 For a sender callout check, Exim makes SMTP connections to the remote hosts, to
33454 test whether a bounce message could be delivered to the sender address. The
33455 following SMTP commands are sent:
33456 .display
33457 &`HELO `&<&'local host name'&>
33458 &`MAIL FROM:<>`&
33459 &`RCPT TO:`&<&'the address to be tested'&>
33460 &`QUIT`&
33461 .endd
33462 LHLO is used instead of HELO if the transport's &%protocol%& option is
33463 set to &"lmtp"&.
33464
33465 The callout may use EHLO, AUTH and/or STARTTLS given appropriate option
33466 settings.
33467
33468 A recipient callout check is similar. By default, it also uses an empty address
33469 for the sender. This default is chosen because most hosts do not make use of
33470 the sender address when verifying a recipient. Using the same address means
33471 that a single cache entry can be used for each recipient. Some sites, however,
33472 do make use of the sender address when verifying. These are catered for by the
33473 &%use_sender%& and &%use_postmaster%& options, described in the next section.
33474
33475 If the response to the RCPT command is a 2&'xx'& code, the verification
33476 succeeds. If it is 5&'xx'&, the verification fails. For any other condition,
33477 Exim tries the next host, if any. If there is a problem with all the remote
33478 hosts, the ACL yields &"defer"&, unless the &%defer_ok%& parameter of the
33479 &%callout%& option is given, in which case the condition is forced to succeed.
33480
33481 .cindex "SMTP" "output flushing, disabling for callout"
33482 A callout may take a little time. For this reason, Exim normally flushes SMTP
33483 output before performing a callout in an ACL, to avoid unexpected timeouts in
33484 clients when the SMTP PIPELINING extension is in use. The flushing can be
33485 disabled by using a &%control%& modifier to set &%no_callout_flush%&.
33486
33487
33488
33489
33490 .section "Additional parameters for callouts" "CALLaddparcall"
33491 .cindex "callout" "additional parameters for"
33492 The &%callout%& option can be followed by an equals sign and a number of
33493 optional parameters, separated by commas. For example:
33494 .code
33495 verify = recipient/callout=10s,defer_ok
33496 .endd
33497 The old syntax, which had &%callout_defer_ok%& and &%check_postmaster%& as
33498 separate verify options, is retained for backwards compatibility, but is now
33499 deprecated. The additional parameters for &%callout%& are as follows:
33500
33501
33502 .vlist
33503 .vitem <&'a&~time&~interval'&>
33504 .cindex "callout" "timeout, specifying"
33505 This specifies the timeout that applies for the callout attempt to each host.
33506 For example:
33507 .code
33508 verify = sender/callout=5s
33509 .endd
33510 The default is 30 seconds. The timeout is used for each response from the
33511 remote host. It is also used for the initial connection, unless overridden by
33512 the &%connect%& parameter.
33513
33514
33515 .vitem &*connect&~=&~*&<&'time&~interval'&>
33516 .cindex "callout" "connection timeout, specifying"
33517 This parameter makes it possible to set a different (usually smaller) timeout
33518 for making the SMTP connection. For example:
33519 .code
33520 verify = sender/callout=5s,connect=1s
33521 .endd
33522 If not specified, this timeout defaults to the general timeout value.
33523
33524 .vitem &*defer_ok*&
33525 .cindex "callout" "defer, action on"
33526 When this parameter is present, failure to contact any host, or any other kind
33527 of temporary error, is treated as success by the ACL. However, the cache is not
33528 updated in this circumstance.
33529
33530 .vitem &*fullpostmaster*&
33531 .cindex "callout" "full postmaster check"
33532 This operates like the &%postmaster%& option (see below), but if the check for
33533 &'postmaster@domain'& fails, it tries just &'postmaster'&, without a domain, in
33534 accordance with the specification in RFC 2821. The RFC states that the
33535 unqualified address &'postmaster'& should be accepted.
33536
33537
33538 .vitem &*mailfrom&~=&~*&<&'email&~address'&>
33539 .cindex "callout" "sender when verifying header"
33540 When verifying addresses in header lines using the &%header_sender%&
33541 verification option, Exim behaves by default as if the addresses are envelope
33542 sender addresses from a message. Callout verification therefore tests to see
33543 whether a bounce message could be delivered, by using an empty address in the
33544 MAIL command. However, it is arguable that these addresses might never be used
33545 as envelope senders, and could therefore justifiably reject bounce messages
33546 (empty senders). The &%mailfrom%& callout parameter allows you to specify what
33547 address to use in the MAIL command. For example:
33548 .code
33549 require  verify = header_sender/callout=mailfrom=abcd@x.y.z
33550 .endd
33551 This parameter is available only for the &%header_sender%& verification option.
33552
33553
33554 .vitem &*maxwait&~=&~*&<&'time&~interval'&>
33555 .cindex "callout" "overall timeout, specifying"
33556 This parameter sets an overall timeout for performing a callout verification.
33557 For example:
33558 .code
33559 verify = sender/callout=5s,maxwait=30s
33560 .endd
33561 This timeout defaults to four times the callout timeout for individual SMTP
33562 commands. The overall timeout applies when there is more than one host that can
33563 be tried. The timeout is checked before trying the next host. This prevents
33564 very long delays if there are a large number of hosts and all are timing out
33565 (for example, when network connections are timing out).
33566
33567
33568 .vitem &*no_cache*&
33569 .cindex "callout" "cache, suppressing"
33570 .cindex "caching callout, suppressing"
33571 When this parameter is given, the callout cache is neither read nor updated.
33572
33573 .vitem &*postmaster*&
33574 .cindex "callout" "postmaster; checking"
33575 When this parameter is set, a successful callout check is followed by a similar
33576 check for the local part &'postmaster'& at the same domain. If this address is
33577 rejected, the callout fails (but see &%fullpostmaster%& above). The result of
33578 the postmaster check is recorded in a cache record; if it is a failure, this is
33579 used to fail subsequent callouts for the domain without a connection being
33580 made, until the cache record expires.
33581
33582 .vitem &*postmaster_mailfrom&~=&~*&<&'email&~address'&>
33583 The postmaster check uses an empty sender in the MAIL command by default.
33584 You can use this parameter to do a postmaster check using a different address.
33585 For example:
33586 .code
33587 require  verify = sender/callout=postmaster_mailfrom=abc@x.y.z
33588 .endd
33589 If both &%postmaster%& and &%postmaster_mailfrom%& are present, the rightmost
33590 one overrides. The &%postmaster%& parameter is equivalent to this example:
33591 .code
33592 require  verify = sender/callout=postmaster_mailfrom=
33593 .endd
33594 &*Warning*&: The caching arrangements for postmaster checking do not take
33595 account of the sender address. It is assumed that either the empty address or
33596 a fixed non-empty address will be used. All that Exim remembers is that the
33597 postmaster check for the domain succeeded or failed.
33598
33599
33600 .vitem &*random*&
33601 .cindex "callout" "&""random""& check"
33602 When this parameter is set, before doing the normal callout check, Exim does a
33603 check for a &"random"& local part at the same domain. The local part is not
33604 really random &-- it is defined by the expansion of the option
33605 &%callout_random_local_part%&, which defaults to
33606 .code
33607 $primary_hostname-$tod_epoch-testing
33608 .endd
33609 The idea here is to try to determine whether the remote host accepts all local
33610 parts without checking. If it does, there is no point in doing callouts for
33611 specific local parts. If the &"random"& check succeeds, the result is saved in
33612 a cache record, and used to force the current and subsequent callout checks to
33613 succeed without a connection being made, until the cache record expires.
33614
33615 .vitem &*use_postmaster*&
33616 .cindex "callout" "sender for recipient check"
33617 This parameter applies to recipient callouts only. For example:
33618 .code
33619 deny  !verify = recipient/callout=use_postmaster
33620 .endd
33621 .vindex "&$qualify_domain$&"
33622 It causes a non-empty postmaster address to be used in the MAIL command when
33623 performing the callout for the recipient, and also for a &"random"& check if
33624 that is configured. The local part of the address is &`postmaster`& and the
33625 domain is the contents of &$qualify_domain$&.
33626
33627 .vitem &*use_sender*&
33628 This option applies to recipient callouts only. For example:
33629 .code
33630 require  verify = recipient/callout=use_sender
33631 .endd
33632 It causes the message's actual sender address to be used in the MAIL
33633 command when performing the callout, instead of an empty address. There is no
33634 need to use this option unless you know that the called hosts make use of the
33635 sender when checking recipients. If used indiscriminately, it reduces the
33636 usefulness of callout caching.
33637
33638 .vitem &*hold*&
33639 This option applies to recipient callouts only. For example:
33640 .code
33641 require  verify = recipient/callout=use_sender,hold
33642 .endd
33643 It causes the connection to be held open and used for any further recipients
33644 and for eventual delivery (should that be done quickly).
33645 Doing this saves on TCP and SMTP startup costs, and TLS costs also
33646 when that is used for the connections.
33647 The advantage is only gained if there are no callout cache hits
33648 (which could be enforced by the no_cache option),
33649 if the use_sender option is used,
33650 if neither the random nor the use_postmaster option is used,
33651 and if no other callouts intervene.
33652 .endlist
33653
33654 If you use any of the parameters that set a non-empty sender for the MAIL
33655 command (&%mailfrom%&, &%postmaster_mailfrom%&, &%use_postmaster%&, or
33656 &%use_sender%&), you should think about possible loops. Recipient checking is
33657 usually done between two hosts that are under the same management, and the host
33658 that receives the callouts is not normally configured to do callouts itself.
33659 Therefore, it is normally safe to use &%use_postmaster%& or &%use_sender%& in
33660 these circumstances.
33661
33662 However, if you use a non-empty sender address for a callout to an arbitrary
33663 host, there is the likelihood that the remote host will itself initiate a
33664 callout check back to your host. As it is checking what appears to be a message
33665 sender, it is likely to use an empty address in MAIL, thus avoiding a
33666 callout loop. However, to be on the safe side it would be best to set up your
33667 own ACLs so that they do not do sender verification checks when the recipient
33668 is the address you use for header sender or postmaster callout checking.
33669
33670 Another issue to think about when using non-empty senders for callouts is
33671 caching. When you set &%mailfrom%& or &%use_sender%&, the cache record is keyed
33672 by the sender/recipient combination; thus, for any given recipient, many more
33673 actual callouts are performed than when an empty sender or postmaster is used.
33674
33675
33676
33677
33678 .section "Callout caching" "SECTcallvercache"
33679 .cindex "hints database" "callout cache"
33680 .cindex "callout" "cache, description of"
33681 .cindex "caching" "callout"
33682 Exim caches the results of callouts in order to reduce the amount of resources
33683 used, unless you specify the &%no_cache%& parameter with the &%callout%&
33684 option. A hints database called &"callout"& is used for the cache. Two
33685 different record types are used: one records the result of a callout check for
33686 a specific address, and the other records information that applies to the
33687 entire domain (for example, that it accepts the local part &'postmaster'&).
33688
33689 When an original callout fails, a detailed SMTP error message is given about
33690 the failure. However, for subsequent failures use the cache data, this message
33691 is not available.
33692
33693 The expiry times for negative and positive address cache records are
33694 independent, and can be set by the global options &%callout_negative_expire%&
33695 (default 2h) and &%callout_positive_expire%& (default 24h), respectively.
33696
33697 If a host gives a negative response to an SMTP connection, or rejects any
33698 commands up to and including
33699 .code
33700 MAIL FROM:<>
33701 .endd
33702 (but not including the MAIL command with a non-empty address),
33703 any callout attempt is bound to fail. Exim remembers such failures in a
33704 domain cache record, which it uses to fail callouts for the domain without
33705 making new connections, until the domain record times out. There are two
33706 separate expiry times for domain cache records:
33707 &%callout_domain_negative_expire%& (default 3h) and
33708 &%callout_domain_positive_expire%& (default 7d).
33709
33710 Domain records expire when the negative expiry time is reached if callouts
33711 cannot be made for the domain, or if the postmaster check failed.
33712 Otherwise, they expire when the positive expiry time is reached. This
33713 ensures that, for example, a host that stops accepting &"random"& local parts
33714 will eventually be noticed.
33715
33716 The callout caching mechanism is based on the domain of the address that is
33717 being tested. If the domain routes to several hosts, it is assumed that their
33718 behaviour will be the same.
33719
33720
33721
33722 .new
33723 .section "Quota caching" "SECTquotacache"
33724 .cindex "hints database" "quota cache"
33725 .cindex "quota" "cache, description of"
33726 .cindex "caching" "quota"
33727 Exim caches the results of quota verification
33728 in order to reduce the amount of resources used.
33729 The &"callout"& hints database is used.
33730
33731 The default cache periods are five minutes for a positive (good) result
33732 and one hour for a negative result.
33733 To change the periods the &%quota%& option can be followed by an equals sign
33734 and a number of optional paramemters, separated by commas.
33735 For example:
33736 .code
33737 verify = recipient/quota=cachepos=1h,cacheneg=1d
33738 .endd
33739 Possible parameters are:
33740 .vlist
33741 .vitem &*cachepos&~=&~*&<&'time&~interval'&>
33742 .cindex "quota cache" "positive entry expiry, specifying"
33743 Set the lifetime for a positive cache entry.
33744 A value of zero seconds is legitimate.
33745
33746 .vitem &*cacheneg&~=&~*&<&'time&~interval'&>
33747 .cindex "quota cache" "negative entry expiry, specifying"
33748 As above, for a negative entry.
33749
33750 .vitem &*no_cache*&
33751 Set both positive and negative lifetimes to zero.
33752 .wen
33753
33754 .section "Sender address verification reporting" "SECTsenaddver"
33755 .cindex "verifying" "suppressing error details"
33756 See section &<<SECTaddressverification>>& for a general discussion of
33757 verification. When sender verification fails in an ACL, the details of the
33758 failure are given as additional output lines before the 550 response to the
33759 relevant SMTP command (RCPT or DATA). For example, if sender callout is in use,
33760 you might see:
33761 .code
33762 MAIL FROM:<xyz@abc.example>
33763 250 OK
33764 RCPT TO:<pqr@def.example>
33765 550-Verification failed for <xyz@abc.example>
33766 550-Called:   192.168.34.43
33767 550-Sent:     RCPT TO:<xyz@abc.example>
33768 550-Response: 550 Unknown local part xyz in <xyz@abc.example>
33769 550 Sender verification failed
33770 .endd
33771 If more than one RCPT command fails in the same way, the details are given
33772 only for the first of them. However, some administrators do not want to send
33773 out this much information. You can suppress the details by adding
33774 &`/no_details`& to the ACL statement that requests sender verification. For
33775 example:
33776 .code
33777 verify = sender/no_details
33778 .endd
33779
33780 .section "Redirection while verifying" "SECTredirwhilveri"
33781 .cindex "verifying" "redirection while"
33782 .cindex "address redirection" "while verifying"
33783 A dilemma arises when a local address is redirected by aliasing or forwarding
33784 during verification: should the generated addresses themselves be verified,
33785 or should the successful expansion of the original address be enough to verify
33786 it? By default, Exim takes the following pragmatic approach:
33787
33788 .ilist
33789 When an incoming address is redirected to just one child address, verification
33790 continues with the child address, and if that fails to verify, the original
33791 verification also fails.
33792 .next
33793 When an incoming address is redirected to more than one child address,
33794 verification does not continue. A success result is returned.
33795 .endlist
33796
33797 This seems the most reasonable behaviour for the common use of aliasing as a
33798 way of redirecting different local parts to the same mailbox. It means, for
33799 example, that a pair of alias entries of the form
33800 .code
33801 A.Wol:   aw123
33802 aw123:   :fail: Gone away, no forwarding address
33803 .endd
33804 work as expected, with both local parts causing verification failure. When a
33805 redirection generates more than one address, the behaviour is more like a
33806 mailing list, where the existence of the alias itself is sufficient for
33807 verification to succeed.
33808
33809 It is possible, however, to change the default behaviour so that all successful
33810 redirections count as successful verifications, however many new addresses are
33811 generated. This is specified by the &%success_on_redirect%& verification
33812 option. For example:
33813 .code
33814 require verify = recipient/success_on_redirect/callout=10s
33815 .endd
33816 In this example, verification succeeds if a router generates a new address, and
33817 the callout does not occur, because no address was routed to a remote host.
33818
33819 When verification is being tested via the &%-bv%& option, the treatment of
33820 redirections is as just described, unless the &%-v%& or any debugging option is
33821 also specified. In that case, full verification is done for every generated
33822 address and a report is output for each of them.
33823
33824
33825
33826 .section "Client SMTP authorization (CSA)" "SECTverifyCSA"
33827 .cindex "CSA" "verifying"
33828 Client SMTP Authorization is a system that allows a site to advertise
33829 which machines are and are not permitted to send email. This is done by placing
33830 special SRV records in the DNS; these are looked up using the client's HELO
33831 domain. At the time of writing, CSA is still an Internet Draft. Client SMTP
33832 Authorization checks in Exim are performed by the ACL condition:
33833 .code
33834 verify = csa
33835 .endd
33836 This fails if the client is not authorized. If there is a DNS problem, or if no
33837 valid CSA SRV record is found, or if the client is authorized, the condition
33838 succeeds. These three cases can be distinguished using the expansion variable
33839 &$csa_status$&, which can take one of the values &"fail"&, &"defer"&,
33840 &"unknown"&, or &"ok"&. The condition does not itself defer because that would
33841 be likely to cause problems for legitimate email.
33842
33843 The error messages produced by the CSA code include slightly more
33844 detail. If &$csa_status$& is &"defer"&, this may be because of problems
33845 looking up the CSA SRV record, or problems looking up the CSA target
33846 address record. There are four reasons for &$csa_status$& being &"fail"&:
33847
33848 .ilist
33849 The client's host name is explicitly not authorized.
33850 .next
33851 The client's IP address does not match any of the CSA target IP addresses.
33852 .next
33853 The client's host name is authorized but it has no valid target IP addresses
33854 (for example, the target's addresses are IPv6 and the client is using IPv4).
33855 .next
33856 The client's host name has no CSA SRV record but a parent domain has asserted
33857 that all subdomains must be explicitly authorized.
33858 .endlist
33859
33860 The &%csa%& verification condition can take an argument which is the domain to
33861 use for the DNS query. The default is:
33862 .code
33863 verify = csa/$sender_helo_name
33864 .endd
33865 This implementation includes an extension to CSA. If the query domain
33866 is an address literal such as [192.0.2.95], or if it is a bare IP
33867 address, Exim searches for CSA SRV records in the reverse DNS as if
33868 the HELO domain was (for example) &'95.2.0.192.in-addr.arpa'&. Therefore it is
33869 meaningful to say:
33870 .code
33871 verify = csa/$sender_host_address
33872 .endd
33873 In fact, this is the check that Exim performs if the client does not say HELO.
33874 This extension can be turned off by setting the main configuration option
33875 &%dns_csa_use_reverse%& to be false.
33876
33877 If a CSA SRV record is not found for the domain itself, a search
33878 is performed through its parent domains for a record which might be
33879 making assertions about subdomains. The maximum depth of this search is limited
33880 using the main configuration option &%dns_csa_search_limit%&, which is 5 by
33881 default. Exim does not look for CSA SRV records in a top level domain, so the
33882 default settings handle HELO domains as long as seven
33883 (&'hostname.five.four.three.two.one.com'&). This encompasses the vast majority
33884 of legitimate HELO domains.
33885
33886 The &'dnsdb'& lookup also has support for CSA. Although &'dnsdb'& also supports
33887 direct SRV lookups, this is not sufficient because of the extra parent domain
33888 search behaviour of CSA, and (as with PTR lookups) &'dnsdb'& also turns IP
33889 addresses into lookups in the reverse DNS space. The result of a successful
33890 lookup such as:
33891 .code
33892 ${lookup dnsdb {csa=$sender_helo_name}}
33893 .endd
33894 has two space-separated fields: an authorization code and a target host name.
33895 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
33896 authorization required but absent, or &"?"& for unknown.
33897
33898
33899
33900
33901 .section "Bounce address tag validation" "SECTverifyPRVS"
33902 .cindex "BATV, verifying"
33903 Bounce address tag validation (BATV) is a scheme whereby the envelope senders
33904 of outgoing messages have a cryptographic, timestamped &"tag"& added to them.
33905 Genuine incoming bounce messages should therefore always be addressed to
33906 recipients that have a valid tag. This scheme is a way of detecting unwanted
33907 bounce messages caused by sender address forgeries (often called &"collateral
33908 spam"&), because the recipients of such messages do not include valid tags.
33909
33910 There are two expansion items to help with the implementation of the BATV
33911 &"prvs"& (private signature) scheme in an Exim configuration. This scheme signs
33912 the original envelope sender address by using a simple key to add a hash of the
33913 address and some time-based randomizing information. The &%prvs%& expansion
33914 item creates a signed address, and the &%prvscheck%& expansion item checks one.
33915 The syntax of these expansion items is described in section
33916 &<<SECTexpansionitems>>&.
33917 The validity period on signed addresses is seven days.
33918
33919 As an example, suppose the secret per-address keys are stored in an MySQL
33920 database. A query to look up the key for an address could be defined as a macro
33921 like this:
33922 .code
33923 PRVSCHECK_SQL = ${lookup mysql{SELECT secret FROM batv_prvs \
33924                 WHERE sender='${quote_mysql:$prvscheck_address}'\
33925                 }{$value}}
33926 .endd
33927 Suppose also that the senders who make use of BATV are defined by an address
33928 list called &%batv_senders%&. Then, in the ACL for RCPT commands, you could
33929 use this:
33930 .code
33931 # Bounces: drop unsigned addresses for BATV senders
33932 deny senders = :
33933      recipients = +batv_senders
33934      message = This address does not send an unsigned reverse path
33935
33936 # Bounces: In case of prvs-signed address, check signature.
33937 deny senders = :
33938      condition  = ${prvscheck {$local_part@$domain}\
33939                   {PRVSCHECK_SQL}{1}}
33940      !condition = $prvscheck_result
33941      message = Invalid reverse path signature.
33942 .endd
33943 The first statement rejects recipients for bounce messages that are addressed
33944 to plain BATV sender addresses, because it is known that BATV senders do not
33945 send out messages with plain sender addresses. The second statement rejects
33946 recipients that are prvs-signed, but with invalid signatures (either because
33947 the key is wrong, or the signature has timed out).
33948
33949 A non-prvs-signed address is not rejected by the second statement, because the
33950 &%prvscheck%& expansion yields an empty string if its first argument is not a
33951 prvs-signed address, thus causing the &%condition%& condition to be false. If
33952 the first argument is a syntactically valid prvs-signed address, the yield is
33953 the third string (in this case &"1"&), whether or not the cryptographic and
33954 timeout checks succeed. The &$prvscheck_result$& variable contains the result
33955 of the checks (empty for failure, &"1"& for success).
33956
33957 There is one more issue you must consider when implementing prvs-signing:
33958 you have to ensure that the routers accept prvs-signed addresses and
33959 deliver them correctly. The easiest way to handle this is to use a &(redirect)&
33960 router to remove the signature with a configuration along these lines:
33961 .code
33962 batv_redirect:
33963   driver = redirect
33964   data = ${prvscheck {$local_part@$domain}{PRVSCHECK_SQL}}
33965 .endd
33966 This works because, if the third argument of &%prvscheck%& is empty, the result
33967 of the expansion of a prvs-signed address is the decoded value of the original
33968 address. This router should probably be the first of your routers that handles
33969 local addresses.
33970
33971 To create BATV-signed addresses in the first place, a transport of this form
33972 can be used:
33973 .code
33974 external_smtp_batv:
33975   driver = smtp
33976   return_path = ${prvs {$return_path} \
33977                        {${lookup mysql{SELECT \
33978                        secret FROM batv_prvs WHERE \
33979                        sender='${quote_mysql:$sender_address}'} \
33980                        {$value}fail}}}
33981 .endd
33982 If no key can be found for the existing return path, no signing takes place.
33983
33984
33985
33986 .section "Using an ACL to control relaying" "SECTrelaycontrol"
33987 .cindex "&ACL;" "relay control"
33988 .cindex "relaying" "control by ACL"
33989 .cindex "policy control" "relay control"
33990 An MTA is said to &'relay'& a message if it receives it from some host and
33991 delivers it directly to another host as a result of a remote address contained
33992 within it. Redirecting a local address via an alias or forward file and then
33993 passing the message on to another host is not relaying,
33994 .cindex "&""percent hack""&"
33995 but a redirection as a result of the &"percent hack"& is.
33996
33997 Two kinds of relaying exist, which are termed &"incoming"& and &"outgoing"&.
33998 A host which is acting as a gateway or an MX backup is concerned with incoming
33999 relaying from arbitrary hosts to a specific set of domains. On the other hand,
34000 a host which is acting as a smart host for a number of clients is concerned
34001 with outgoing relaying from those clients to the Internet at large. Often the
34002 same host is fulfilling both functions,
34003 . ///
34004 . as illustrated in the diagram below,
34005 . ///
34006 but in principle these two kinds of relaying are entirely independent. What is
34007 not wanted is the transmission of mail from arbitrary remote hosts through your
34008 system to arbitrary domains.
34009
34010
34011 You can implement relay control by means of suitable statements in the ACL that
34012 runs for each RCPT command. For convenience, it is often easiest to use
34013 Exim's named list facility to define the domains and hosts involved. For
34014 example, suppose you want to do the following:
34015
34016 .ilist
34017 Deliver a number of domains to mailboxes on the local host (or process them
34018 locally in some other way). Let's say these are &'my.dom1.example'& and
34019 &'my.dom2.example'&.
34020 .next
34021 Relay mail for a number of other domains for which you are the secondary MX.
34022 These might be &'friend1.example'& and &'friend2.example'&.
34023 .next
34024 Relay mail from the hosts on your local LAN, to whatever domains are involved.
34025 Suppose your LAN is 192.168.45.0/24.
34026 .endlist
34027
34028
34029 In the main part of the configuration, you put the following definitions:
34030 .code
34031 domainlist local_domains    = my.dom1.example : my.dom2.example
34032 domainlist relay_to_domains = friend1.example : friend2.example
34033 hostlist   relay_from_hosts = 192.168.45.0/24
34034 .endd
34035 Now you can use these definitions in the ACL that is run for every RCPT
34036 command:
34037 .code
34038 acl_check_rcpt:
34039   accept domains = +local_domains : +relay_to_domains
34040   accept hosts   = +relay_from_hosts
34041 .endd
34042 The first statement accepts any RCPT command that contains an address in
34043 the local or relay domains. For any other domain, control passes to the second
34044 statement, which accepts the command only if it comes from one of the relay
34045 hosts. In practice, you will probably want to make your ACL more sophisticated
34046 than this, for example, by including sender and recipient verification. The
34047 default configuration includes a more comprehensive example, which is described
34048 in chapter &<<CHAPdefconfil>>&.
34049
34050
34051
34052 .section "Checking a relay configuration" "SECTcheralcon"
34053 .cindex "relaying" "checking control of"
34054 You can check the relay characteristics of your configuration in the same way
34055 that you can test any ACL behaviour for an incoming SMTP connection, by using
34056 the &%-bh%& option to run a fake SMTP session with which you interact.
34057 .ecindex IIDacl
34058
34059
34060
34061 . ////////////////////////////////////////////////////////////////////////////
34062 . ////////////////////////////////////////////////////////////////////////////
34063
34064 .chapter "Content scanning at ACL time" "CHAPexiscan"
34065 .scindex IIDcosca "content scanning" "at ACL time"
34066 The extension of Exim to include content scanning at ACL time, formerly known
34067 as &"exiscan"&, was originally implemented as a patch by Tom Kistner. The code
34068 was integrated into the main source for Exim release 4.50, and Tom continues to
34069 maintain it. Most of the wording of this chapter is taken from Tom's
34070 specification.
34071
34072 It is also possible to scan the content of messages at other times. The
34073 &[local_scan()]& function (see chapter &<<CHAPlocalscan>>&) allows for content
34074 scanning after all the ACLs have run. A transport filter can be used to scan
34075 messages at delivery time (see the &%transport_filter%& option, described in
34076 chapter &<<CHAPtransportgeneric>>&).
34077
34078 If you want to include the ACL-time content-scanning features when you compile
34079 Exim, you need to arrange for WITH_CONTENT_SCAN to be defined in your
34080 &_Local/Makefile_&. When you do that, the Exim binary is built with:
34081
34082 .ilist
34083 Two additional ACLs (&%acl_smtp_mime%& and &%acl_not_smtp_mime%&) that are run
34084 for all MIME parts for SMTP and non-SMTP messages, respectively.
34085 .next
34086 Additional ACL conditions and modifiers: &%decode%&, &%malware%&,
34087 &%mime_regex%&, &%regex%&, and &%spam%&. These can be used in the ACL that is
34088 run at the end of message reception (the &%acl_smtp_data%& ACL).
34089 .next
34090 An additional control feature (&"no_mbox_unspool"&) that saves spooled copies
34091 of messages, or parts of messages, for debugging purposes.
34092 .next
34093 Additional expansion variables that are set in the new ACL and by the new
34094 conditions.
34095 .next
34096 Two new main configuration options: &%av_scanner%& and &%spamd_address%&.
34097 .endlist
34098
34099 Content-scanning is continually evolving, and new features are still being
34100 added. While such features are still unstable and liable to incompatible
34101 changes, they are made available in Exim by setting options whose names begin
34102 EXPERIMENTAL_ in &_Local/Makefile_&. Such features are not documented in
34103 this manual. You can find out about them by reading the file called
34104 &_doc/experimental.txt_&.
34105
34106 All the content-scanning facilities work on a MBOX copy of the message that is
34107 temporarily created in a file called:
34108 .display
34109 <&'spool_directory'&>&`/scan/`&<&'message_id'&>/<&'message_id'&>&`.eml`&
34110 .endd
34111 The &_.eml_& extension is a friendly hint to virus scanners that they can
34112 expect an MBOX-like structure inside that file. The file is created when the
34113 first content scanning facility is called. Subsequent calls to content
34114 scanning conditions open the same file again. The directory is recursively
34115 removed when the &%acl_smtp_data%& ACL has finished running, unless
34116 .code
34117 control = no_mbox_unspool
34118 .endd
34119 has been encountered. When the MIME ACL decodes files, they are put into the
34120 same directory by default.
34121
34122
34123
34124 .section "Scanning for viruses" "SECTscanvirus"
34125 .cindex "virus scanning"
34126 .cindex "content scanning" "for viruses"
34127 .cindex "content scanning" "the &%malware%& condition"
34128 The &%malware%& ACL condition lets you connect virus scanner software to Exim.
34129 It supports a &"generic"& interface to scanners called via the shell, and
34130 specialized interfaces for &"daemon"& type virus scanners, which are resident
34131 in memory and thus are much faster.
34132
34133 Since message data needs to have arrived,
34134 the condition may be only called in ACL defined by
34135 &%acl_smtp_data%&,
34136 &%acl_smtp_data_prdr%&,
34137 &%acl_smtp_mime%& or
34138 &%acl_smtp_dkim%&
34139
34140 A timeout of 2 minutes is applied to a scanner call (by default);
34141 if it expires then a defer action is taken.
34142
34143 .oindex "&%av_scanner%&"
34144 You can set the &%av_scanner%& option in the main part of the configuration
34145 to specify which scanner to use, together with any additional options that
34146 are needed. The basic syntax is as follows:
34147 .display
34148 &`av_scanner = <`&&'scanner-type'&&`>:<`&&'option1'&&`>:<`&&'option2'&&`>:[...]`&
34149 .endd
34150 If you do not set &%av_scanner%&, it defaults to
34151 .code
34152 av_scanner = sophie:/var/run/sophie
34153 .endd
34154 If the value of &%av_scanner%& starts with a dollar character, it is expanded
34155 before use.
34156 The usual list-parsing of the content (see &<<SECTlistconstruct>>&) applies.
34157 The following scanner types are supported in this release,
34158 though individual ones can be included or not at build time:
34159
34160 .vlist
34161 .vitem &%avast%&
34162 .cindex "virus scanners" "avast"
34163 This is the scanner daemon of Avast. It has been tested with Avast Core
34164 Security (currently at version 2.2.0).
34165 You can get a trial version at &url(https://www.avast.com) or for Linux
34166 at &url(https://www.avast.com/linux-server-antivirus).
34167 This scanner type takes one option,
34168 which can be either a full path to a UNIX socket,
34169 or host and port specifiers separated by white space.
34170 The host may be a name or an IP address; the port is either a
34171 single number or a pair of numbers with a dash between.
34172 A list of options may follow. These options are interpreted on the
34173 Exim's side of the malware scanner, or are given on separate lines to
34174 the daemon as options before the main scan command.
34175
34176 .cindex &`pass_unscanned`& "avast"
34177 If &`pass_unscanned`&
34178 is set, any files the Avast scanner can't scan (e.g.
34179 decompression bombs, or invalid archives) are considered clean. Use with
34180 care.
34181
34182 For example:
34183 .code
34184 av_scanner = avast:/var/run/avast/scan.sock:FLAGS -fullfiles:SENSITIVITY -pup
34185 av_scanner = avast:/var/run/avast/scan.sock:pass_unscanned:FLAGS -fullfiles:SENSITIVITY -pup
34186 av_scanner = avast:192.168.2.22 5036
34187 .endd
34188 If you omit the argument, the default path
34189 &_/var/run/avast/scan.sock_&
34190 is used.
34191 If you use a remote host,
34192 you need to make Exim's spool directory available to it,
34193 as the scanner is passed a file path, not file contents.
34194 For information about available commands and their options you may use
34195 .code
34196 $ socat UNIX:/var/run/avast/scan.sock STDIO:
34197     FLAGS
34198     SENSITIVITY
34199     PACK
34200 .endd
34201
34202 If the scanner returns a temporary failure (e.g. license issues, or
34203 permission problems), the message is deferred and a paniclog entry is
34204 written.  The usual &`defer_ok`& option is available.
34205
34206 .vitem &%aveserver%&
34207 .cindex "virus scanners" "Kaspersky"
34208 This is the scanner daemon of Kaspersky Version 5. You can get a trial version
34209 at &url(https://www.kaspersky.com/). This scanner type takes one option,
34210 which is the path to the daemon's UNIX socket. The default is shown in this
34211 example:
34212 .code
34213 av_scanner = aveserver:/var/run/aveserver
34214 .endd
34215
34216
34217 .vitem &%clamd%&
34218 .cindex "virus scanners" "clamd"
34219 This daemon-type scanner is GPL and free. You can get it at
34220 &url(https://www.clamav.net/). Some older versions of clamd do not seem to
34221 unpack MIME containers, so it used to be recommended to unpack MIME attachments
34222 in the MIME ACL. This is no longer believed to be necessary.
34223
34224 The options are a list of server specifiers, which may be
34225 a UNIX socket specification,
34226 a TCP socket specification,
34227 or a (global) option.
34228
34229 A socket specification consists of a space-separated list.
34230 For a Unix socket the first element is a full path for the socket,
34231 for a TCP socket the first element is the IP address
34232 and the second a port number,
34233 Any further elements are per-server (non-global) options.
34234 These per-server options are supported:
34235 .code
34236 retry=<timespec>        Retry on connect fail
34237 .endd
34238
34239 The &`retry`& option specifies a time after which a single retry for
34240 a failed connect is made.  The default is to not retry.
34241
34242 If a Unix socket file is specified, only one server is supported.
34243
34244 Examples:
34245 .code
34246 av_scanner = clamd:/opt/clamd/socket
34247 av_scanner = clamd:192.0.2.3 1234
34248 av_scanner = clamd:192.0.2.3 1234:local
34249 av_scanner = clamd:192.0.2.3 1234 retry=10s
34250 av_scanner = clamd:192.0.2.3 1234 : 192.0.2.4 1234
34251 .endd
34252 If the value of av_scanner points to a UNIX socket file or contains the
34253 &`local`&
34254 option, then the ClamAV interface will pass a filename containing the data
34255 to be scanned, which should normally result in less I/O happening and be
34256 more efficient.  Normally in the TCP case, the data is streamed to ClamAV as
34257 Exim does not assume that there is a common filesystem with the remote host.
34258
34259 The final example shows that multiple TCP targets can be specified.  Exim will
34260 randomly use one for each incoming email (i.e. it load balances them).  Note
34261 that only TCP targets may be used if specifying a list of scanners; a UNIX
34262 socket cannot be mixed in with TCP targets.  If one of the servers becomes
34263 unavailable, Exim will try the remaining one(s) until it finds one that works.
34264 When a clamd server becomes unreachable, Exim will log a message.  Exim does
34265 not keep track of scanner state between multiple messages, and the scanner
34266 selection is random, so the message will get logged in the mainlog for each
34267 email that the down scanner gets chosen first (message wrapped to be readable):
34268 .code
34269 2013-10-09 14:30:39 1VTumd-0000Y8-BQ malware acl condition:
34270    clamd: connection to localhost, port 3310 failed
34271    (Connection refused)
34272 .endd
34273
34274 If the option is unset, the default is &_/tmp/clamd_&. Thanks to David Saez for
34275 contributing the code for this scanner.
34276
34277 .vitem &%cmdline%&
34278 .cindex "virus scanners" "command line interface"
34279 This is the keyword for the generic command line scanner interface. It can be
34280 used to attach virus scanners that are invoked from the shell. This scanner
34281 type takes 3 mandatory options:
34282
34283 .olist
34284 The full path and name of the scanner binary, with all command line options,
34285 and a placeholder (&`%s`&) for the directory to scan.
34286
34287 .next
34288 A regular expression to match against the STDOUT and STDERR output of the
34289 virus scanner. If the expression matches, a virus was found. You must make
34290 absolutely sure that this expression matches on &"virus found"&. This is called
34291 the &"trigger"& expression.
34292
34293 .next
34294 Another regular expression, containing exactly one pair of parentheses, to
34295 match the name of the virus found in the scanners output. This is called the
34296 &"name"& expression.
34297 .endlist olist
34298
34299 For example, Sophos Sweep reports a virus on a line like this:
34300 .code
34301 Virus 'W32/Magistr-B' found in file ./those.bat
34302 .endd
34303 For the trigger expression, we can match the phrase &"found in file"&. For the
34304 name expression, we want to extract the W32/Magistr-B string, so we can match
34305 for the single quotes left and right of it. Altogether, this makes the
34306 configuration setting:
34307 .code
34308 av_scanner = cmdline:\
34309              /path/to/sweep -ss -all -rec -archive %s:\
34310              found in file:'(.+)'
34311 .endd
34312 .vitem &%drweb%&
34313 .cindex "virus scanners" "DrWeb"
34314 The DrWeb daemon scanner (&url(https://www.sald.ru/)) interface
34315 takes one option,
34316 either a full path to a UNIX socket,
34317 or host and port specifiers separated by white space.
34318 The host may be a name or an IP address; the port is either a
34319 single number or a pair of numbers with a dash between.
34320 For example:
34321 .code
34322 av_scanner = drweb:/var/run/drwebd.sock
34323 av_scanner = drweb:192.168.2.20 31337
34324 .endd
34325 If you omit the argument, the default path &_/usr/local/drweb/run/drwebd.sock_&
34326 is used. Thanks to Alex Miller for contributing the code for this scanner.
34327
34328 .vitem &%f-protd%&
34329 .cindex "virus scanners" "f-protd"
34330 The f-protd scanner is accessed via HTTP over TCP.
34331 One argument is taken, being a space-separated hostname and port number
34332 (or port-range).
34333 For example:
34334 .code
34335 av_scanner = f-protd:localhost 10200-10204
34336 .endd
34337 If you omit the argument, the default values shown above are used.
34338
34339 .vitem &%f-prot6d%&
34340 .cindex "virus scanners" "f-prot6d"
34341 The f-prot6d scanner is accessed using the FPSCAND protocol over TCP.
34342 One argument is taken, being a space-separated hostname and port number.
34343 For example:
34344 .code
34345 av_scanner = f-prot6d:localhost 10200
34346 .endd
34347 If you omit the argument, the default values show above are used.
34348
34349 .vitem &%fsecure%&
34350 .cindex "virus scanners" "F-Secure"
34351 The F-Secure daemon scanner (&url(https://www.f-secure.com/)) takes one
34352 argument which is the path to a UNIX socket. For example:
34353 .code
34354 av_scanner = fsecure:/path/to/.fsav
34355 .endd
34356 If no argument is given, the default is &_/var/run/.fsav_&. Thanks to Johan
34357 Thelmen for contributing the code for this scanner.
34358
34359 .vitem &%kavdaemon%&
34360 .cindex "virus scanners" "Kaspersky"
34361 This is the scanner daemon of Kaspersky Version 4. This version of the
34362 Kaspersky scanner is outdated. Please upgrade (see &%aveserver%& above). This
34363 scanner type takes one option, which is the path to the daemon's UNIX socket.
34364 For example:
34365 .code
34366 av_scanner = kavdaemon:/opt/AVP/AvpCtl
34367 .endd
34368 The default path is &_/var/run/AvpCtl_&.
34369
34370 .vitem &%mksd%&
34371 .cindex "virus scanners" "mksd"
34372 This was a daemon type scanner that is aimed mainly at Polish users,
34373 though some documentation was available in English.
34374 The history can be shown at &url(https://en.wikipedia.org/wiki/Mks_vir)
34375 and this appears to be a candidate for removal from Exim, unless
34376 we are informed of other virus scanners which use the same protocol
34377 to integrate.
34378 The only option for this scanner type is
34379 the maximum number of processes used simultaneously to scan the attachments,
34380 provided that mksd has
34381 been run with at least the same number of child processes. For example:
34382 .code
34383 av_scanner = mksd:2
34384 .endd
34385 You can safely omit this option (the default value is 1).
34386
34387 .vitem &%sock%&
34388 .cindex "virus scanners" "simple socket-connected"
34389 This is a general-purpose way of talking to simple scanner daemons
34390 running on the local machine.
34391 There are four options:
34392 an address (which may be an IP address and port, or the path of a Unix socket),
34393 a commandline to send (may include a single %s which will be replaced with
34394 the path to the mail file to be scanned),
34395 an RE to trigger on from the returned data,
34396 and an RE to extract malware_name from the returned data.
34397 For example:
34398 .code
34399 av_scanner = sock:127.0.0.1 6001:%s:(SPAM|VIRUS):(.*)$
34400 .endd
34401 Note that surrounding whitespace is stripped from each option, meaning
34402 there is no way to specify a trailing newline.
34403 The socket specifier and both regular-expressions are required.
34404 Default for the commandline is &_%s\n_& (note this does have a trailing newline);
34405 specify an empty element to get this.
34406
34407 .vitem &%sophie%&
34408 .cindex "virus scanners" "Sophos and Sophie"
34409 Sophie is a daemon that uses Sophos' &%libsavi%& library to scan for viruses.
34410 You can get Sophie at &url(http://sophie.sourceforge.net/). The only option
34411 for this scanner type is the path to the UNIX socket that Sophie uses for
34412 client communication. For example:
34413 .code
34414 av_scanner = sophie:/tmp/sophie
34415 .endd
34416 The default path is &_/var/run/sophie_&, so if you are using this, you can omit
34417 the option.
34418 .endlist
34419
34420 When &%av_scanner%& is correctly set, you can use the &%malware%& condition in
34421 the DATA ACL. &*Note*&: You cannot use the &%malware%& condition in the MIME
34422 ACL.
34423
34424 The &%av_scanner%& option is expanded each time &%malware%& is called. This
34425 makes it possible to use different scanners. See further below for an example.
34426 The &%malware%& condition caches its results, so when you use it multiple times
34427 for the same message, the actual scanning process is only carried out once.
34428 However, using expandable items in &%av_scanner%& disables this caching, in
34429 which case each use of the &%malware%& condition causes a new scan of the
34430 message.
34431
34432 The &%malware%& condition takes a right-hand argument that is expanded before
34433 use and taken as a list, slash-separated by default.
34434 The first element can then be one of
34435
34436 .ilist
34437 &"true"&, &"*"&, or &"1"&, in which case the message is scanned for viruses.
34438 The condition succeeds if a virus was found, and fail otherwise. This is the
34439 recommended usage.
34440 .next
34441 &"false"& or &"0"& or an empty string, in which case no scanning is done and
34442 the condition fails immediately.
34443 .next
34444 A regular expression, in which case the message is scanned for viruses. The
34445 condition succeeds if a virus is found and its name matches the regular
34446 expression. This allows you to take special actions on certain types of virus.
34447 Note that &"/"& characters in the RE must be doubled due to the list-processing,
34448 unless the separator is changed (in the usual way &<<SECTlistsepchange>>&).
34449 .endlist
34450
34451 You can append a &`defer_ok`& element to the &%malware%& argument list to accept
34452 messages even if there is a problem with the virus scanner.
34453 Otherwise, such a problem causes the ACL to defer.
34454
34455 You can append a &`tmo=<val>`& element to the &%malware%& argument list to
34456 specify a non-default timeout.  The default is two minutes.
34457 For example:
34458 .code
34459 malware = * / defer_ok / tmo=10s
34460 .endd
34461 A timeout causes the ACL to defer.
34462
34463 .vindex "&$callout_address$&"
34464 When a connection is made to the scanner the expansion variable &$callout_address$&
34465 is set to record the actual address used.
34466
34467 .vindex "&$malware_name$&"
34468 When a virus is found, the condition sets up an expansion variable called
34469 &$malware_name$& that contains the name of the virus. You can use it in a
34470 &%message%& modifier that specifies the error returned to the sender, and/or in
34471 logging data.
34472
34473 Beware the interaction of Exim's &%message_size_limit%& with any size limits
34474 imposed by your anti-virus scanner.
34475
34476 Here is a very simple scanning example:
34477 .code
34478 deny malware = *
34479      message = This message contains malware ($malware_name)
34480 .endd
34481 The next example accepts messages when there is a problem with the scanner:
34482 .code
34483 deny malware = */defer_ok
34484      message = This message contains malware ($malware_name)
34485 .endd
34486 The next example shows how to use an ACL variable to scan with both sophie and
34487 aveserver. It assumes you have set:
34488 .code
34489 av_scanner = $acl_m0
34490 .endd
34491 in the main Exim configuration.
34492 .code
34493 deny set acl_m0 = sophie
34494      malware = *
34495      message = This message contains malware ($malware_name)
34496
34497 deny set acl_m0 = aveserver
34498      malware = *
34499      message = This message contains malware ($malware_name)
34500 .endd
34501
34502
34503 .section "Scanning with SpamAssassin and Rspamd" "SECTscanspamass"
34504 .cindex "content scanning" "for spam"
34505 .cindex "spam scanning"
34506 .cindex "SpamAssassin"
34507 .cindex "Rspamd"
34508 The &%spam%& ACL condition calls SpamAssassin's &%spamd%& daemon to get a spam
34509 score and a report for the message.
34510 Support is also provided for Rspamd.
34511
34512 For more information about installation and configuration of SpamAssassin or
34513 Rspamd refer to their respective websites at
34514 &url(https://spamassassin.apache.org/) and &url(https://www.rspamd.com/)
34515
34516 SpamAssassin can be installed with CPAN by running:
34517 .code
34518 perl -MCPAN -e 'install Mail::SpamAssassin'
34519 .endd
34520 SpamAssassin has its own set of configuration files. Please review its
34521 documentation to see how you can tweak it. The default installation should work
34522 nicely, however.
34523
34524 .oindex "&%spamd_address%&"
34525 By default, SpamAssassin listens on 127.0.0.1, TCP port 783 and if you
34526 intend to use an instance running on the local host you do not need to set
34527 &%spamd_address%&. If you intend to use another host or port for SpamAssassin,
34528 you must set the &%spamd_address%& option in the global part of the Exim
34529 configuration as follows (example):
34530 .code
34531 spamd_address = 192.168.99.45 783
34532 .endd
34533 The SpamAssassin protocol relies on a TCP half-close from the client.
34534 If your SpamAssassin client side is running a Linux system with an
34535 iptables firewall, consider setting
34536 &%net.netfilter.nf_conntrack_tcp_timeout_close_wait%& to at least the
34537 timeout, Exim uses when waiting for a response from the SpamAssassin
34538 server (currently defaulting to 120s).  With a lower value the Linux
34539 connection tracking may consider your half-closed connection as dead too
34540 soon.
34541
34542
34543 To use Rspamd (which by default listens on all local addresses
34544 on TCP port 11333)
34545 you should add &%variant=rspamd%& after the address/port pair, for example:
34546 .code
34547 spamd_address = 127.0.0.1 11333 variant=rspamd
34548 .endd
34549
34550 As of version 2.60, &%SpamAssassin%& also supports communication over UNIX
34551 sockets. If you want to us these, supply &%spamd_address%& with an absolute
34552 filename instead of an address/port pair:
34553 .code
34554 spamd_address = /var/run/spamd_socket
34555 .endd
34556 You can have multiple &%spamd%& servers to improve scalability. These can
34557 reside on other hardware reachable over the network. To specify multiple
34558 &%spamd%& servers, put multiple address/port pairs in the &%spamd_address%&
34559 option, separated with colons (the separator can be changed in the usual way &<<SECTlistsepchange>>&):
34560 .code
34561 spamd_address = 192.168.2.10 783 : \
34562                 192.168.2.11 783 : \
34563                 192.168.2.12 783
34564 .endd
34565 Up to 32 &%spamd%& servers are supported.
34566 When a server fails to respond to the connection attempt, all other
34567 servers are tried until one succeeds. If no server responds, the &%spam%&
34568 condition defers.
34569
34570 Unix and TCP socket specifications may be mixed in any order.
34571 Each element of the list is a list itself, space-separated by default
34572 and changeable in the usual way (&<<SECTlistsepchange>>&);
34573 take care to not double the separator.
34574
34575 For TCP socket specifications a host name or IP (v4 or v6, but
34576 subject to list-separator quoting rules) address can be used,
34577 and the port can be one or a dash-separated pair.
34578 In the latter case, the range is tried in strict order.
34579
34580 Elements after the first for Unix sockets, or second for TCP socket,
34581 are options.
34582 The supported options are:
34583 .code
34584 pri=<priority>      Selection priority
34585 weight=<value>      Selection bias
34586 time=<start>-<end>  Use only between these times of day
34587 retry=<timespec>    Retry on connect fail
34588 tmo=<timespec>      Connection time limit
34589 variant=rspamd      Use Rspamd rather than SpamAssassin protocol
34590 .endd
34591
34592 The &`pri`& option specifies a priority for the server within the list,
34593 higher values being tried first.
34594 The default priority is 1.
34595
34596 The &`weight`& option specifies a selection bias.
34597 Within a priority set
34598 servers are queried in a random fashion, weighted by this value.
34599 The default value for selection bias is 1.
34600
34601 Time specifications for the &`time`& option are <hour>.<minute>.<second>
34602 in the local time zone; each element being one or more digits.
34603 Either the seconds or both minutes and seconds, plus the leading &`.`&
34604 characters, may be omitted and will be taken as zero.
34605
34606 Timeout specifications for the &`retry`& and &`tmo`& options
34607 are the usual Exim time interval standard, e.g. &`20s`& or &`1m`&.
34608
34609 The &`tmo`& option specifies an overall timeout for communication.
34610 The default value is two minutes.
34611
34612 The &`retry`& option specifies a time after which a single retry for
34613 a failed connect is made.
34614 The default is to not retry.
34615
34616 The &%spamd_address%& variable is expanded before use if it starts with
34617 a dollar sign. In this case, the expansion may return a string that is
34618 used as the list so that multiple spamd servers can be the result of an
34619 expansion.
34620
34621 .vindex "&$callout_address$&"
34622 When a connection is made to the server the expansion variable &$callout_address$&
34623 is set to record the actual address used.
34624
34625 .section "Calling SpamAssassin from an Exim ACL" "SECID206"
34626 Here is a simple example of the use of the &%spam%& condition in a DATA ACL:
34627 .code
34628 deny spam = joe
34629      message = This message was classified as SPAM
34630 .endd
34631 The right-hand side of the &%spam%& condition specifies a name. This is
34632 relevant if you have set up multiple SpamAssassin profiles. If you do not want
34633 to scan using a specific profile, but rather use the SpamAssassin system-wide
34634 default profile, you can scan for an unknown name, or simply use &"nobody"&.
34635 Rspamd does not use this setting. However, you must put something on the
34636 right-hand side.
34637
34638 The name allows you to use per-domain or per-user antispam profiles in
34639 principle, but this is not straightforward in practice, because a message may
34640 have multiple recipients, not necessarily all in the same domain. Because the
34641 &%spam%& condition has to be called from a DATA-time ACL in order to be able to
34642 read the contents of the message, the variables &$local_part$& and &$domain$&
34643 are not set.
34644 Careful enforcement of single-recipient messages
34645 (e.g. by responding with defer in the recipient ACL for all recipients
34646 after the first),
34647 or the use of PRDR,
34648 .cindex "PRDR" "use for per-user SpamAssassin profiles"
34649 are needed to use this feature.
34650
34651 The right-hand side of the &%spam%& condition is expanded before being used, so
34652 you can put lookups or conditions there. When the right-hand side evaluates to
34653 &"0"& or &"false"&, no scanning is done and the condition fails immediately.
34654
34655
34656 Scanning with SpamAssassin uses a lot of resources. If you scan every message,
34657 large ones may cause significant performance degradation. As most spam messages
34658 are quite small, it is recommended that you do not scan the big ones. For
34659 example:
34660 .code
34661 deny condition = ${if < {$message_size}{10K}}
34662      spam = nobody
34663      message = This message was classified as SPAM
34664 .endd
34665
34666 The &%spam%& condition returns true if the threshold specified in the user's
34667 SpamAssassin profile has been matched or exceeded. If you want to use the
34668 &%spam%& condition for its side effects (see the variables below), you can make
34669 it always return &"true"& by appending &`:true`& to the username.
34670
34671 .cindex "spam scanning" "returned variables"
34672 When the &%spam%& condition is run, it sets up a number of expansion
34673 variables.
34674 Except for &$spam_report$&,
34675 these variables are saved with the received message so are
34676 available for use at delivery time.
34677
34678 .vlist
34679 .vitem &$spam_score$&
34680 The spam score of the message, for example, &"3.4"& or &"30.5"&. This is useful
34681 for inclusion in log or reject messages.
34682
34683 .vitem &$spam_score_int$&
34684 The spam score of the message, multiplied by ten, as an integer value. For
34685 example &"34"& or &"305"&. It may appear to disagree with &$spam_score$&
34686 because &$spam_score$& is rounded and &$spam_score_int$& is truncated.
34687 The integer value is useful for numeric comparisons in conditions.
34688
34689 .vitem &$spam_bar$&
34690 A string consisting of a number of &"+"& or &"-"& characters, representing the
34691 integer part of the spam score value. A spam score of 4.4 would have a
34692 &$spam_bar$& value of &"++++"&. This is useful for inclusion in warning
34693 headers, since MUAs can match on such strings. The maximum length of the
34694 spam bar is 50 characters.
34695
34696 .vitem &$spam_report$&
34697 A multiline text table, containing the full SpamAssassin report for the
34698 message. Useful for inclusion in headers or reject messages.
34699 This variable is only usable in a DATA-time ACL.
34700 Beware that SpamAssassin may return non-ASCII characters, especially
34701 when running in country-specific locales, which are not legal
34702 unencoded in headers.
34703
34704 .vitem &$spam_action$&
34705 For SpamAssassin either 'reject' or 'no action' depending on the
34706 spam score versus threshold.
34707 For Rspamd, the recommended action.
34708
34709 .endlist
34710
34711 The &%spam%& condition caches its results unless expansion in
34712 spamd_address was used. If you call it again with the same user name, it
34713 does not scan again, but rather returns the same values as before.
34714
34715 The &%spam%& condition returns DEFER if there is any error while running
34716 the message through SpamAssassin or if the expansion of spamd_address
34717 failed. If you want to treat DEFER as FAIL (to pass on to the next ACL
34718 statement block), append &`/defer_ok`& to the right-hand side of the
34719 spam condition, like this:
34720 .code
34721 deny spam    = joe/defer_ok
34722      message = This message was classified as SPAM
34723 .endd
34724 This causes messages to be accepted even if there is a problem with &%spamd%&.
34725
34726 Here is a longer, commented example of the use of the &%spam%&
34727 condition:
34728 .code
34729 # put headers in all messages (no matter if spam or not)
34730 warn  spam = nobody:true
34731       add_header = X-Spam-Score: $spam_score ($spam_bar)
34732       add_header = X-Spam-Report: $spam_report
34733
34734 # add second subject line with *SPAM* marker when message
34735 # is over threshold
34736 warn  spam = nobody
34737       add_header = Subject: *SPAM* $h_Subject:
34738
34739 # reject spam at high scores (> 12)
34740 deny  spam = nobody:true
34741       condition = ${if >{$spam_score_int}{120}{1}{0}}
34742       message = This message scored $spam_score spam points.
34743 .endd
34744
34745
34746
34747 .section "Scanning MIME parts" "SECTscanmimepart"
34748 .cindex "content scanning" "MIME parts"
34749 .cindex "MIME content scanning"
34750 .oindex "&%acl_smtp_mime%&"
34751 .oindex "&%acl_not_smtp_mime%&"
34752 The &%acl_smtp_mime%& global option specifies an ACL that is called once for
34753 each MIME part of an SMTP message, including multipart types, in the sequence
34754 of their position in the message. Similarly, the &%acl_not_smtp_mime%& option
34755 specifies an ACL that is used for the MIME parts of non-SMTP messages. These
34756 options may both refer to the same ACL if you want the same processing in both
34757 cases.
34758
34759 These ACLs are called (possibly many times) just before the &%acl_smtp_data%&
34760 ACL in the case of an SMTP message, or just before the &%acl_not_smtp%& ACL in
34761 the case of a non-SMTP message. However, a MIME ACL is called only if the
34762 message contains a &'Content-Type:'& header line. When a call to a MIME
34763 ACL does not yield &"accept"&, ACL processing is aborted and the appropriate
34764 result code is sent to the client. In the case of an SMTP message, the
34765 &%acl_smtp_data%& ACL is not called when this happens.
34766
34767 You cannot use the &%malware%& or &%spam%& conditions in a MIME ACL; these can
34768 only be used in the DATA or non-SMTP ACLs. However, you can use the &%regex%&
34769 condition to match against the raw MIME part. You can also use the
34770 &%mime_regex%& condition to match against the decoded MIME part (see section
34771 &<<SECTscanregex>>&).
34772
34773 At the start of a MIME ACL, a number of variables are set from the header
34774 information for the relevant MIME part. These are described below. The contents
34775 of the MIME part are not by default decoded into a disk file except for MIME
34776 parts whose content-type is &"message/rfc822"&. If you want to decode a MIME
34777 part into a disk file, you can use the &%decode%& condition. The general
34778 syntax is:
34779 .display
34780 &`decode = [/`&<&'path'&>&`/]`&<&'filename'&>
34781 .endd
34782 The right hand side is expanded before use. After expansion,
34783 the value can be:
34784
34785 .olist
34786 &"0"& or &"false"&, in which case no decoding is done.
34787 .next
34788 The string &"default"&. In that case, the file is put in the temporary
34789 &"default"& directory <&'spool_directory'&>&_/scan/_&<&'message_id'&>&_/_& with
34790 a sequential filename consisting of the message id and a sequence number. The
34791 full path and name is available in &$mime_decoded_filename$& after decoding.
34792 .next
34793 A full path name starting with a slash. If the full name is an existing
34794 directory, it is used as a replacement for the default directory. The filename
34795 is then sequentially assigned. If the path does not exist, it is used as
34796 the full path and filename.
34797 .next
34798 If the string does not start with a slash, it is used as the
34799 filename, and the default path is then used.
34800 .endlist
34801 The &%decode%& condition normally succeeds. It is only false for syntax
34802 errors or unusual circumstances such as memory shortages. You can easily decode
34803 a file with its original, proposed filename using
34804 .code
34805 decode = $mime_filename
34806 .endd
34807 However, you should keep in mind that &$mime_filename$& might contain
34808 anything. If you place files outside of the default path, they are not
34809 automatically unlinked.
34810
34811 For RFC822 attachments (these are messages attached to messages, with a
34812 content-type of &"message/rfc822"&), the ACL is called again in the same manner
34813 as for the primary message, only that the &$mime_is_rfc822$& expansion
34814 variable is set (see below). Attached messages are always decoded to disk
34815 before being checked, and the files are unlinked once the check is done.
34816
34817 The MIME ACL supports the &%regex%& and &%mime_regex%& conditions. These can be
34818 used to match regular expressions against raw and decoded MIME parts,
34819 respectively. They are described in section &<<SECTscanregex>>&.
34820
34821 .cindex "MIME content scanning" "returned variables"
34822 The following list describes all expansion variables that are
34823 available in the MIME ACL:
34824
34825 .vlist
34826 .vitem &$mime_anomaly_level$& &&&
34827        &$mime_anomaly_text$&
34828 .vindex &$mime_anomaly_level$&
34829 .vindex &$mime_anomaly_text$&
34830 If there are problems decoding, these variables contain information on
34831 the detected issue.
34832
34833 .vitem &$mime_boundary$&
34834 .vindex &$mime_boundary$&
34835 If the current part is a multipart (see &$mime_is_multipart$& below), it should
34836 have a boundary string, which is stored in this variable. If the current part
34837 has no boundary parameter in the &'Content-Type:'& header, this variable
34838 contains the empty string.
34839
34840 .vitem &$mime_charset$&
34841 .vindex &$mime_charset$&
34842 This variable contains the character set identifier, if one was found in the
34843 &'Content-Type:'& header. Examples for charset identifiers are:
34844 .code
34845 us-ascii
34846 gb2312 (Chinese)
34847 iso-8859-1
34848 .endd
34849 Please note that this value is not normalized, so you should do matches
34850 case-insensitively.
34851
34852 .vitem &$mime_content_description$&
34853 .vindex &$mime_content_description$&
34854 This variable contains the normalized content of the &'Content-Description:'&
34855 header. It can contain a human-readable description of the parts content. Some
34856 implementations repeat the filename for attachments here, but they are usually
34857 only used for display purposes.
34858
34859 .vitem &$mime_content_disposition$&
34860 .vindex &$mime_content_disposition$&
34861 This variable contains the normalized content of the &'Content-Disposition:'&
34862 header. You can expect strings like &"attachment"& or &"inline"& here.
34863
34864 .vitem &$mime_content_id$&
34865 .vindex &$mime_content_id$&
34866 This variable contains the normalized content of the &'Content-ID:'& header.
34867 This is a unique ID that can be used to reference a part from another part.
34868
34869 .vitem &$mime_content_size$&
34870 .vindex &$mime_content_size$&
34871 This variable is set only after the &%decode%& modifier (see above) has been
34872 successfully run. It contains the size of the decoded part in kilobytes. The
34873 size is always rounded up to full kilobytes, so only a completely empty part
34874 has a &$mime_content_size$& of zero.
34875
34876 .vitem &$mime_content_transfer_encoding$&
34877 .vindex &$mime_content_transfer_encoding$&
34878 This variable contains the normalized content of the
34879 &'Content-transfer-encoding:'& header. This is a symbolic name for an encoding
34880 type. Typical values are &"base64"& and &"quoted-printable"&.
34881
34882 .vitem &$mime_content_type$&
34883 .vindex &$mime_content_type$&
34884 If the MIME part has a &'Content-Type:'& header, this variable contains its
34885 value, lowercased, and without any options (like &"name"& or &"charset"&). Here
34886 are some examples of popular MIME types, as they may appear in this variable:
34887 .code
34888 text/plain
34889 text/html
34890 application/octet-stream
34891 image/jpeg
34892 audio/midi
34893 .endd
34894 If the MIME part has no &'Content-Type:'& header, this variable contains the
34895 empty string.
34896
34897 .vitem &$mime_decoded_filename$&
34898 .vindex &$mime_decoded_filename$&
34899 This variable is set only after the &%decode%& modifier (see above) has been
34900 successfully run. It contains the full path and filename of the file
34901 containing the decoded data.
34902 .endlist
34903
34904 .cindex "RFC 2047"
34905 .vlist
34906 .vitem &$mime_filename$&
34907 .vindex &$mime_filename$&
34908 This is perhaps the most important of the MIME variables. It contains a
34909 proposed filename for an attachment, if one was found in either the
34910 &'Content-Type:'& or &'Content-Disposition:'& headers. The filename will be
34911 RFC2047
34912 or RFC2231
34913 decoded, but no additional sanity checks are done.
34914  If no filename was
34915 found, this variable contains the empty string.
34916
34917 .vitem &$mime_is_coverletter$&
34918 .vindex &$mime_is_coverletter$&
34919 This variable attempts to differentiate the &"cover letter"& of an e-mail from
34920 attached data. It can be used to clamp down on flashy or unnecessarily encoded
34921 content in the cover letter, while not restricting attachments at all.
34922
34923 The variable contains 1 (true) for a MIME part believed to be part of the
34924 cover letter, and 0 (false) for an attachment. At present, the algorithm is as
34925 follows:
34926
34927 .olist
34928 The outermost MIME part of a message is always a cover letter.
34929
34930 .next
34931 If a multipart/alternative or multipart/related MIME part is a cover letter,
34932 so are all MIME subparts within that multipart.
34933
34934 .next
34935 If any other multipart is a cover letter, the first subpart is a cover letter,
34936 and the rest are attachments.
34937
34938 .next
34939 All parts contained within an attachment multipart are attachments.
34940 .endlist olist
34941
34942 As an example, the following will ban &"HTML mail"& (including that sent with
34943 alternative plain text), while allowing HTML files to be attached. HTML
34944 coverletter mail attached to non-HTML coverletter mail will also be allowed:
34945 .code
34946 deny !condition = $mime_is_rfc822
34947      condition = $mime_is_coverletter
34948      condition = ${if eq{$mime_content_type}{text/html}{1}{0}}
34949      message = HTML mail is not accepted here
34950 .endd
34951
34952 .vitem &$mime_is_multipart$&
34953 .vindex &$mime_is_multipart$&
34954 This variable has the value 1 (true) when the current part has the main type
34955 &"multipart"&, for example, &"multipart/alternative"& or &"multipart/mixed"&.
34956 Since multipart entities only serve as containers for other parts, you may not
34957 want to carry out specific actions on them.
34958
34959 .vitem &$mime_is_rfc822$&
34960 .vindex &$mime_is_rfc822$&
34961 This variable has the value 1 (true) if the current part is not a part of the
34962 checked message itself, but part of an attached message. Attached message
34963 decoding is fully recursive.
34964
34965 .vitem &$mime_part_count$&
34966 .vindex &$mime_part_count$&
34967 This variable is a counter that is raised for each processed MIME part. It
34968 starts at zero for the very first part (which is usually a multipart). The
34969 counter is per-message, so it is reset when processing RFC822 attachments (see
34970 &$mime_is_rfc822$&). The counter stays set after &%acl_smtp_mime%& is
34971 complete, so you can use it in the DATA ACL to determine the number of MIME
34972 parts of a message. For non-MIME messages, this variable contains the value -1.
34973 .endlist
34974
34975
34976
34977 .section "Scanning with regular expressions" "SECTscanregex"
34978 .cindex "content scanning" "with regular expressions"
34979 .cindex "regular expressions" "content scanning with"
34980 You can specify your own custom regular expression matches on the full body of
34981 the message, or on individual MIME parts.
34982
34983 The &%regex%& condition takes one or more regular expressions as arguments and
34984 matches them against the full message (when called in the DATA ACL) or a raw
34985 MIME part (when called in the MIME ACL). The &%regex%& condition matches
34986 linewise, with a maximum line length of 32K characters. That means you cannot
34987 have multiline matches with the &%regex%& condition.
34988
34989 The &%mime_regex%& condition can be called only in the MIME ACL. It matches up
34990 to 32K of decoded content (the whole content at once, not linewise). If the
34991 part has not been decoded with the &%decode%& modifier earlier in the ACL, it
34992 is decoded automatically when &%mime_regex%& is executed (using default path
34993 and filename values). If the decoded data is larger than  32K, only the first
34994 32K characters are checked.
34995
34996 The regular expressions are passed as a colon-separated list. To include a
34997 literal colon, you must double it. Since the whole right-hand side string is
34998 expanded before being used, you must also escape dollar signs and backslashes
34999 with more backslashes, or use the &`\N`& facility to disable expansion.
35000 Here is a simple example that contains two regular expressions:
35001 .code
35002 deny regex = [Mm]ortgage : URGENT BUSINESS PROPOSAL
35003      message = contains blacklisted regex ($regex_match_string)
35004 .endd
35005 The conditions returns true if any one of the regular expressions matches. The
35006 &$regex_match_string$& expansion variable is then set up and contains the
35007 matching regular expression.
35008 The expansion variables &$regex1$& &$regex2$& etc
35009 are set to any substrings captured by the regular expression.
35010
35011 &*Warning*&: With large messages, these conditions can be fairly
35012 CPU-intensive.
35013
35014 .ecindex IIDcosca
35015
35016
35017
35018
35019 . ////////////////////////////////////////////////////////////////////////////
35020 . ////////////////////////////////////////////////////////////////////////////
35021
35022 .chapter "Adding a local scan function to Exim" "CHAPlocalscan" &&&
35023          "Local scan function"
35024 .scindex IIDlosca "&[local_scan()]& function" "description of"
35025 .cindex "customizing" "input scan using C function"
35026 .cindex "policy control" "by local scan function"
35027 In these days of email worms, viruses, and ever-increasing spam, some sites
35028 want to apply a lot of checking to messages before accepting them.
35029
35030 The content scanning extension (chapter &<<CHAPexiscan>>&) has facilities for
35031 passing messages to external virus and spam scanning software. You can also do
35032 a certain amount in Exim itself through string expansions and the &%condition%&
35033 condition in the ACL that runs after the SMTP DATA command or the ACL for
35034 non-SMTP messages (see chapter &<<CHAPACL>>&), but this has its limitations.
35035
35036 To allow for further customization to a site's own requirements, there is the
35037 possibility of linking Exim with a private message scanning function, written
35038 in C. If you want to run code that is written in something other than C, you
35039 can of course use a little C stub to call it.
35040
35041 The local scan function is run once for every incoming message, at the point
35042 when Exim is just about to accept the message.
35043 It can therefore be used to control non-SMTP messages from local processes as
35044 well as messages arriving via SMTP.
35045
35046 Exim applies a timeout to calls of the local scan function, and there is an
35047 option called &%local_scan_timeout%& for setting it. The default is 5 minutes.
35048 Zero means &"no timeout"&.
35049 Exim also sets up signal handlers for SIGSEGV, SIGILL, SIGFPE, and SIGBUS
35050 before calling the local scan function, so that the most common types of crash
35051 are caught. If the timeout is exceeded or one of those signals is caught, the
35052 incoming message is rejected with a temporary error if it is an SMTP message.
35053 For a non-SMTP message, the message is dropped and Exim ends with a non-zero
35054 code. The incident is logged on the main and reject logs.
35055
35056
35057
35058 .section "Building Exim to use a local scan function" "SECID207"
35059 .cindex "&[local_scan()]& function" "building Exim to use"
35060 To make use of the local scan function feature, you must tell Exim where your
35061 function is before building Exim, by setting
35062 both HAVE_LOCAL_SCAN and
35063 LOCAL_SCAN_SOURCE in your
35064 &_Local/Makefile_&. A recommended place to put it is in the &_Local_&
35065 directory, so you might set
35066 .code
35067 HAVE_LOCAL_SCAN=yes
35068 LOCAL_SCAN_SOURCE=Local/local_scan.c
35069 .endd
35070 for example. The function must be called &[local_scan()]&;
35071 the source file(s) for it should first #define LOCAL_SCAN
35072 and then #include "local_scan.h".
35073 It is called by
35074 Exim after it has received a message, when the success return code is about to
35075 be sent. This is after all the ACLs have been run. The return code from your
35076 function controls whether the message is actually accepted or not. There is a
35077 commented template function (that just accepts the message) in the file
35078 _src/local_scan.c_.
35079
35080 If you want to make use of Exim's runtime configuration file to set options
35081 for your &[local_scan()]& function, you must also set
35082 .code
35083 LOCAL_SCAN_HAS_OPTIONS=yes
35084 .endd
35085 in &_Local/Makefile_& (see section &<<SECTconoptloc>>& below).
35086
35087
35088
35089
35090 .section "API for local_scan()" "SECTapiforloc"
35091 .cindex "&[local_scan()]& function" "API description"
35092 .cindex &%dlfunc%& "API description"
35093 You must include this line near the start of your code:
35094 .code
35095 #define LOCAL_SCAN
35096 #include "local_scan.h"
35097 .endd
35098 This header file defines a number of variables and other values, and the
35099 prototype for the function itself. Exim is coded to use unsigned char values
35100 almost exclusively, and one of the things this header defines is a shorthand
35101 for &`unsigned char`& called &`uschar`&.
35102 It also makes available the following macro definitions, to simplify casting character
35103 strings and pointers to character strings:
35104 .code
35105 #define CS   (char *)
35106 #define CCS  (const char *)
35107 #define CSS  (char **)
35108 #define US   (unsigned char *)
35109 #define CUS  (const unsigned char *)
35110 #define USS  (unsigned char **)
35111 .endd
35112 The function prototype for &[local_scan()]& is:
35113 .code
35114 extern int local_scan(int fd, uschar **return_text);
35115 .endd
35116 The arguments are as follows:
35117
35118 .ilist
35119 &%fd%& is a file descriptor for the file that contains the body of the message
35120 (the -D file). The file is open for reading and writing, but updating it is not
35121 recommended. &*Warning*&: You must &'not'& close this file descriptor.
35122
35123 The descriptor is positioned at character 19 of the file, which is the first
35124 character of the body itself, because the first 19 characters are the message
35125 id followed by &`-D`& and a newline. If you rewind the file, you should use the
35126 macro SPOOL_DATA_START_OFFSET to reset to the start of the data, just in
35127 case this changes in some future version.
35128 .next
35129 &%return_text%& is an address which you can use to return a pointer to a text
35130 string at the end of the function. The value it points to on entry is NULL.
35131 .endlist
35132
35133 The function must return an &%int%& value which is one of the following macros:
35134
35135 .vlist
35136 .vitem &`LOCAL_SCAN_ACCEPT`&
35137 .vindex "&$local_scan_data$&"
35138 The message is accepted. If you pass back a string of text, it is saved with
35139 the message, and made available in the variable &$local_scan_data$&. No
35140 newlines are permitted (if there are any, they are turned into spaces) and the
35141 maximum length of text is 1000 characters.
35142
35143 .vitem &`LOCAL_SCAN_ACCEPT_FREEZE`&
35144 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
35145 queued without immediate delivery, and is frozen.
35146
35147 .vitem &`LOCAL_SCAN_ACCEPT_QUEUE`&
35148 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
35149 queued without immediate delivery.
35150
35151 .vitem &`LOCAL_SCAN_REJECT`&
35152 The message is rejected; the returned text is used as an error message which is
35153 passed back to the sender and which is also logged. Newlines are permitted &--
35154 they cause a multiline response for SMTP rejections, but are converted to
35155 &`\n`& in log lines. If no message is given, &"Administrative prohibition"& is
35156 used.
35157
35158 .vitem &`LOCAL_SCAN_TEMPREJECT`&
35159 The message is temporarily rejected; the returned text is used as an error
35160 message as for LOCAL_SCAN_REJECT. If no message is given, &"Temporary local
35161 problem"& is used.
35162
35163 .vitem &`LOCAL_SCAN_REJECT_NOLOGHDR`&
35164 This behaves as LOCAL_SCAN_REJECT, except that the header of the rejected
35165 message is not written to the reject log. It has the effect of unsetting the
35166 &%rejected_header%& log selector for just this rejection. If
35167 &%rejected_header%& is already unset (see the discussion of the
35168 &%log_selection%& option in section &<<SECTlogselector>>&), this code is the
35169 same as LOCAL_SCAN_REJECT.
35170
35171 .vitem &`LOCAL_SCAN_TEMPREJECT_NOLOGHDR`&
35172 This code is a variation of LOCAL_SCAN_TEMPREJECT in the same way that
35173 LOCAL_SCAN_REJECT_NOLOGHDR is a variation of LOCAL_SCAN_REJECT.
35174 .endlist
35175
35176 If the message is not being received by interactive SMTP, rejections are
35177 reported by writing to &%stderr%& or by sending an email, as configured by the
35178 &%-oe%& command line options.
35179
35180
35181
35182 .section "Configuration options for local_scan()" "SECTconoptloc"
35183 .cindex "&[local_scan()]& function" "configuration options"
35184 It is possible to have option settings in the main configuration file
35185 that set values in static variables in the &[local_scan()]& module. If you
35186 want to do this, you must have the line
35187 .code
35188 LOCAL_SCAN_HAS_OPTIONS=yes
35189 .endd
35190 in your &_Local/Makefile_& when you build Exim. (This line is in
35191 &_OS/Makefile-Default_&, commented out). Then, in the &[local_scan()]& source
35192 file, you must define static variables to hold the option values, and a table
35193 to define them.
35194
35195 The table must be a vector called &%local_scan_options%&, of type
35196 &`optionlist`&. Each entry is a triplet, consisting of a name, an option type,
35197 and a pointer to the variable that holds the value. The entries must appear in
35198 alphabetical order. Following &%local_scan_options%& you must also define a
35199 variable called &%local_scan_options_count%& that contains the number of
35200 entries in the table. Here is a short example, showing two kinds of option:
35201 .code
35202 static int my_integer_option = 42;
35203 static uschar *my_string_option = US"a default string";
35204
35205 optionlist local_scan_options[] = {
35206   { "my_integer", opt_int,       &my_integer_option },
35207   { "my_string",  opt_stringptr, &my_string_option }
35208 };
35209
35210 int local_scan_options_count =
35211   sizeof(local_scan_options)/sizeof(optionlist);
35212 .endd
35213 The values of the variables can now be changed from Exim's runtime
35214 configuration file by including a local scan section as in this example:
35215 .code
35216 begin local_scan
35217 my_integer = 99
35218 my_string = some string of text...
35219 .endd
35220 The available types of option data are as follows:
35221
35222 .vlist
35223 .vitem &*opt_bool*&
35224 This specifies a boolean (true/false) option. The address should point to a
35225 variable of type &`BOOL`&, which will be set to TRUE or FALSE, which are macros
35226 that are defined as &"1"& and &"0"&, respectively. If you want to detect
35227 whether such a variable has been set at all, you can initialize it to
35228 TRUE_UNSET. (BOOL variables are integers underneath, so can hold more than two
35229 values.)
35230
35231 .vitem &*opt_fixed*&
35232 This specifies a fixed point number, such as is used for load averages.
35233 The address should point to a variable of type &`int`&. The value is stored
35234 multiplied by 1000, so, for example, 1.4142 is truncated and stored as 1414.
35235
35236 .vitem &*opt_int*&
35237 This specifies an integer; the address should point to a variable of type
35238 &`int`&. The value may be specified in any of the integer formats accepted by
35239 Exim.
35240
35241 .vitem &*opt_mkint*&
35242 This is the same as &%opt_int%&, except that when such a value is output in a
35243 &%-bP%& listing, if it is an exact number of kilobytes or megabytes, it is
35244 printed with the suffix K or M.
35245
35246 .vitem &*opt_octint*&
35247 This also specifies an integer, but the value is always interpreted as an
35248 octal integer, whether or not it starts with the digit zero, and it is
35249 always output in octal.
35250
35251 .vitem &*opt_stringptr*&
35252 This specifies a string value; the address must be a pointer to a
35253 variable that points to a string (for example, of type &`uschar *`&).
35254
35255 .vitem &*opt_time*&
35256 This specifies a time interval value. The address must point to a variable of
35257 type &`int`&. The value that is placed there is a number of seconds.
35258 .endlist
35259
35260 If the &%-bP%& command line option is followed by &`local_scan`&, Exim prints
35261 out the values of all the &[local_scan()]& options.
35262
35263
35264
35265 .section "Available Exim variables" "SECID208"
35266 .cindex "&[local_scan()]& function" "available Exim variables"
35267 The header &_local_scan.h_& gives you access to a number of C variables. These
35268 are the only ones that are guaranteed to be maintained from release to release.
35269 Note, however, that you can obtain the value of any Exim expansion variable,
35270 including &$recipients$&, by calling &'expand_string()'&. The exported
35271 C variables are as follows:
35272
35273 .vlist
35274 .vitem &*int&~body_linecount*&
35275 This variable contains the number of lines in the message's body.
35276 It is not valid if the &%spool_files_wireformat%& option is used.
35277
35278 .vitem &*int&~body_zerocount*&
35279 This variable contains the number of binary zero bytes in the message's body.
35280 It is not valid if the &%spool_files_wireformat%& option is used.
35281
35282 .vitem &*unsigned&~int&~debug_selector*&
35283 This variable is set to zero when no debugging is taking place. Otherwise, it
35284 is a bitmap of debugging selectors. Two bits are identified for use in
35285 &[local_scan()]&; they are defined as macros:
35286
35287 .ilist
35288 The &`D_v`& bit is set when &%-v%& was present on the command line. This is a
35289 testing option that is not privileged &-- any caller may set it. All the
35290 other selector bits can be set only by admin users.
35291
35292 .next
35293 The &`D_local_scan`& bit is provided for use by &[local_scan()]&; it is set
35294 by the &`+local_scan`& debug selector. It is not included in the default set
35295 of debugging bits.
35296 .endlist ilist
35297
35298 Thus, to write to the debugging output only when &`+local_scan`& has been
35299 selected, you should use code like this:
35300 .code
35301 if ((debug_selector & D_local_scan) != 0)
35302   debug_printf("xxx", ...);
35303 .endd
35304 .vitem &*uschar&~*expand_string_message*&
35305 After a failing call to &'expand_string()'& (returned value NULL), the
35306 variable &%expand_string_message%& contains the error message, zero-terminated.
35307
35308 .vitem &*header_line&~*header_list*&
35309 A pointer to a chain of header lines. The &%header_line%& structure is
35310 discussed below.
35311
35312 .vitem &*header_line&~*header_last*&
35313 A pointer to the last of the header lines.
35314
35315 .vitem &*uschar&~*headers_charset*&
35316 The value of the &%headers_charset%& configuration option.
35317
35318 .vitem &*BOOL&~host_checking*&
35319 This variable is TRUE during a host checking session that is initiated by the
35320 &%-bh%& command line option.
35321
35322 .vitem &*uschar&~*interface_address*&
35323 The IP address of the interface that received the message, as a string. This
35324 is NULL for locally submitted messages.
35325
35326 .vitem &*int&~interface_port*&
35327 The port on which this message was received. When testing with the &%-bh%&
35328 command line option, the value of this variable is -1 unless a port has been
35329 specified via the &%-oMi%& option.
35330
35331 .vitem &*uschar&~*message_id*&
35332 This variable contains Exim's message id for the incoming message (the value of
35333 &$message_exim_id$&) as a zero-terminated string.
35334
35335 .vitem &*uschar&~*received_protocol*&
35336 The name of the protocol by which the message was received.
35337
35338 .vitem &*int&~recipients_count*&
35339 The number of accepted recipients.
35340
35341 .vitem &*recipient_item&~*recipients_list*&
35342 .cindex "recipient" "adding in local scan"
35343 .cindex "recipient" "removing in local scan"
35344 The list of accepted recipients, held in a vector of length
35345 &%recipients_count%&. The &%recipient_item%& structure is discussed below. You
35346 can add additional recipients by calling &'receive_add_recipient()'& (see
35347 below). You can delete recipients by removing them from the vector and
35348 adjusting the value in &%recipients_count%&. In particular, by setting
35349 &%recipients_count%& to zero you remove all recipients. If you then return the
35350 value &`LOCAL_SCAN_ACCEPT`&, the message is accepted, but immediately
35351 blackholed. To replace the recipients, you can set &%recipients_count%& to zero
35352 and then call &'receive_add_recipient()'& as often as needed.
35353
35354 .vitem &*uschar&~*sender_address*&
35355 The envelope sender address. For bounce messages this is the empty string.
35356
35357 .vitem &*uschar&~*sender_host_address*&
35358 The IP address of the sending host, as a string. This is NULL for
35359 locally-submitted messages.
35360
35361 .vitem &*uschar&~*sender_host_authenticated*&
35362 The name of the authentication mechanism that was used, or NULL if the message
35363 was not received over an authenticated SMTP connection.
35364
35365 .vitem &*uschar&~*sender_host_name*&
35366 The name of the sending host, if known.
35367
35368 .vitem &*int&~sender_host_port*&
35369 The port on the sending host.
35370
35371 .vitem &*BOOL&~smtp_input*&
35372 This variable is TRUE for all SMTP input, including BSMTP.
35373
35374 .vitem &*BOOL&~smtp_batched_input*&
35375 This variable is TRUE for BSMTP input.
35376
35377 .vitem &*int&~store_pool*&
35378 The contents of this variable control which pool of memory is used for new
35379 requests. See section &<<SECTmemhanloc>>& for details.
35380 .endlist
35381
35382
35383 .section "Structure of header lines" "SECID209"
35384 The &%header_line%& structure contains the members listed below.
35385 You can add additional header lines by calling the &'header_add()'& function
35386 (see below). You can cause header lines to be ignored (deleted) by setting
35387 their type to *.
35388
35389
35390 .vlist
35391 .vitem &*struct&~header_line&~*next*&
35392 A pointer to the next header line, or NULL for the last line.
35393
35394 .vitem &*int&~type*&
35395 A code identifying certain headers that Exim recognizes. The codes are printing
35396 characters, and are documented in chapter &<<CHAPspool>>& of this manual.
35397 Notice in particular that any header line whose type is * is not transmitted
35398 with the message. This flagging is used for header lines that have been
35399 rewritten, or are to be removed (for example, &'Envelope-sender:'& header
35400 lines.) Effectively, * means &"deleted"&.
35401
35402 .vitem &*int&~slen*&
35403 The number of characters in the header line, including the terminating and any
35404 internal newlines.
35405
35406 .vitem &*uschar&~*text*&
35407 A pointer to the text of the header. It always ends with a newline, followed by
35408 a zero byte. Internal newlines are preserved.
35409 .endlist
35410
35411
35412
35413 .section "Structure of recipient items" "SECID210"
35414 The &%recipient_item%& structure contains these members:
35415
35416 .vlist
35417 .vitem &*uschar&~*address*&
35418 This is a pointer to the recipient address as it was received.
35419
35420 .vitem &*int&~pno*&
35421 This is used in later Exim processing when top level addresses are created by
35422 the &%one_time%& option. It is not relevant at the time &[local_scan()]& is run
35423 and must always contain -1 at this stage.
35424
35425 .vitem &*uschar&~*errors_to*&
35426 If this value is not NULL, bounce messages caused by failing to deliver to the
35427 recipient are sent to the address it contains. In other words, it overrides the
35428 envelope sender for this one recipient. (Compare the &%errors_to%& generic
35429 router option.) If a &[local_scan()]& function sets an &%errors_to%& field to
35430 an unqualified address, Exim qualifies it using the domain from
35431 &%qualify_recipient%&. When &[local_scan()]& is called, the &%errors_to%& field
35432 is NULL for all recipients.
35433 .endlist
35434
35435
35436
35437 .section "Available Exim functions" "SECID211"
35438 .cindex "&[local_scan()]& function" "available Exim functions"
35439 The header &_local_scan.h_& gives you access to a number of Exim functions.
35440 These are the only ones that are guaranteed to be maintained from release to
35441 release:
35442
35443 .vlist
35444 .vitem "&*pid_t&~child_open(uschar&~**argv,&~uschar&~**envp,&~int&~newumask,&&&
35445        &~int&~*infdptr,&~int&~*outfdptr, &~&~BOOL&~make_leader)*&"
35446
35447 This function creates a child process that runs the command specified by
35448 &%argv%&. The environment for the process is specified by &%envp%&, which can
35449 be NULL if no environment variables are to be passed. A new umask is supplied
35450 for the process in &%newumask%&.
35451
35452 Pipes to the standard input and output of the new process are set up
35453 and returned to the caller via the &%infdptr%& and &%outfdptr%& arguments. The
35454 standard error is cloned to the standard output. If there are any file
35455 descriptors &"in the way"& in the new process, they are closed. If the final
35456 argument is TRUE, the new process is made into a process group leader.
35457
35458 The function returns the pid of the new process, or -1 if things go wrong.
35459
35460 .vitem &*int&~child_close(pid_t&~pid,&~int&~timeout)*&
35461 This function waits for a child process to terminate, or for a timeout (in
35462 seconds) to expire. A timeout value of zero means wait as long as it takes. The
35463 return value is as follows:
35464
35465 .ilist
35466 >= 0
35467
35468 The process terminated by a normal exit and the value is the process
35469 ending status.
35470
35471 .next
35472 < 0 and > &--256
35473
35474 The process was terminated by a signal and the value is the negation of the
35475 signal number.
35476
35477 .next
35478 &--256
35479
35480 The process timed out.
35481 .next
35482 &--257
35483
35484 The was some other error in wait(); &%errno%& is still set.
35485 .endlist
35486
35487 .vitem &*pid_t&~child_open_exim(int&~*fd)*&
35488 This function provide you with a means of submitting a new message to
35489 Exim. (Of course, you can also call &_/usr/sbin/sendmail_& yourself if you
35490 want, but this packages it all up for you.) The function creates a pipe,
35491 forks a subprocess that is running
35492 .code
35493 exim -t -oem -oi -f <>
35494 .endd
35495 and returns to you (via the &`int *`& argument) a file descriptor for the pipe
35496 that is connected to the standard input. The yield of the function is the PID
35497 of the subprocess. You can then write a message to the file descriptor, with
35498 recipients in &'To:'&, &'Cc:'&, and/or &'Bcc:'& header lines.
35499
35500 When you have finished, call &'child_close()'& to wait for the process to
35501 finish and to collect its ending status. A timeout value of zero is usually
35502 fine in this circumstance. Unless you have made a mistake with the recipient
35503 addresses, you should get a return code of zero.
35504
35505
35506 .vitem &*pid_t&~child_open_exim2(int&~*fd,&~uschar&~*sender,&~uschar&~&&&
35507        *sender_authentication)*&
35508 This function is a more sophisticated version of &'child_open()'&. The command
35509 that it runs is:
35510 .display
35511 &`exim -t -oem -oi -f `&&'sender'&&` -oMas `&&'sender_authentication'&
35512 .endd
35513 The third argument may be NULL, in which case the &%-oMas%& option is omitted.
35514
35515
35516 .vitem &*void&~debug_printf(char&~*,&~...)*&
35517 This is Exim's debugging function, with arguments as for &'(printf()'&. The
35518 output is written to the standard error stream. If no debugging is selected,
35519 calls to &'debug_printf()'& have no effect. Normally, you should make calls
35520 conditional on the &`local_scan`& debug selector by coding like this:
35521 .code
35522 if ((debug_selector & D_local_scan) != 0)
35523   debug_printf("xxx", ...);
35524 .endd
35525
35526 .vitem &*uschar&~*expand_string(uschar&~*string)*&
35527 This is an interface to Exim's string expansion code. The return value is the
35528 expanded string, or NULL if there was an expansion failure.
35529 The C variable &%expand_string_message%& contains an error message after an
35530 expansion failure. If expansion does not change the string, the return value is
35531 the pointer to the input string. Otherwise, the return value points to a new
35532 block of memory that was obtained by a call to &'store_get()'&. See section
35533 &<<SECTmemhanloc>>& below for a discussion of memory handling.
35534
35535 .vitem &*void&~header_add(int&~type,&~char&~*format,&~...)*&
35536 This function allows you to an add additional header line at the end of the
35537 existing ones. The first argument is the type, and should normally be a space
35538 character. The second argument is a format string and any number of
35539 substitution arguments as for &[sprintf()]&. You may include internal newlines
35540 if you want, and you must ensure that the string ends with a newline.
35541
35542 .vitem "&*void&~header_add_at_position(BOOL&~after,&~uschar&~*name,&~&&&
35543         BOOL&~topnot,&~int&~type,&~char&~*format, &~&~...)*&"
35544 This function adds a new header line at a specified point in the header
35545 chain. The header itself is specified as for &'header_add()'&.
35546
35547 If &%name%& is NULL, the new header is added at the end of the chain if
35548 &%after%& is true, or at the start if &%after%& is false. If &%name%& is not
35549 NULL, the header lines are searched for the first non-deleted header that
35550 matches the name. If one is found, the new header is added before it if
35551 &%after%& is false. If &%after%& is true, the new header is added after the
35552 found header and any adjacent subsequent ones with the same name (even if
35553 marked &"deleted"&). If no matching non-deleted header is found, the &%topnot%&
35554 option controls where the header is added. If it is true, addition is at the
35555 top; otherwise at the bottom. Thus, to add a header after all the &'Received:'&
35556 headers, or at the top if there are no &'Received:'& headers, you could use
35557 .code
35558 header_add_at_position(TRUE, US"Received", TRUE,
35559   ' ', "X-xxx: ...");
35560 .endd
35561 Normally, there is always at least one non-deleted &'Received:'& header, but
35562 there may not be if &%received_header_text%& expands to an empty string.
35563
35564
35565 .vitem &*void&~header_remove(int&~occurrence,&~uschar&~*name)*&
35566 This function removes header lines. If &%occurrence%& is zero or negative, all
35567 occurrences of the header are removed. If occurrence is greater than zero, that
35568 particular instance of the header is removed. If no header(s) can be found that
35569 match the specification, the function does nothing.
35570
35571
35572 .vitem "&*BOOL&~header_testname(header_line&~*hdr,&~uschar&~*name,&~&&&
35573         int&~length,&~BOOL&~notdel)*&"
35574 This function tests whether the given header has the given name. It is not just
35575 a string comparison, because white space is permitted between the name and the
35576 colon. If the &%notdel%& argument is true, a false return is forced for all
35577 &"deleted"& headers; otherwise they are not treated specially. For example:
35578 .code
35579 if (header_testname(h, US"X-Spam", 6, TRUE)) ...
35580 .endd
35581 .vitem &*uschar&~*lss_b64encode(uschar&~*cleartext,&~int&~length)*&
35582 .cindex "base64 encoding" "functions for &[local_scan()]& use"
35583 This function base64-encodes a string, which is passed by address and length.
35584 The text may contain bytes of any value, including zero. The result is passed
35585 back in dynamic memory that is obtained by calling &'store_get()'&. It is
35586 zero-terminated.
35587
35588 .vitem &*int&~lss_b64decode(uschar&~*codetext,&~uschar&~**cleartext)*&
35589 This function decodes a base64-encoded string. Its arguments are a
35590 zero-terminated base64-encoded string and the address of a variable that is set
35591 to point to the result, which is in dynamic memory. The length of the decoded
35592 string is the yield of the function. If the input is invalid base64 data, the
35593 yield is -1. A zero byte is added to the end of the output string to make it
35594 easy to interpret as a C string (assuming it contains no zeros of its own). The
35595 added zero byte is not included in the returned count.
35596
35597 .vitem &*int&~lss_match_domain(uschar&~*domain,&~uschar&~*list)*&
35598 This function checks for a match in a domain list. Domains are always
35599 matched caselessly. The return value is one of the following:
35600 .display
35601 &`OK     `& match succeeded
35602 &`FAIL   `& match failed
35603 &`DEFER  `& match deferred
35604 .endd
35605 DEFER is usually caused by some kind of lookup defer, such as the
35606 inability to contact a database.
35607
35608 .vitem "&*int&~lss_match_local_part(uschar&~*localpart,&~uschar&~*list,&~&&&
35609         BOOL&~caseless)*&"
35610 This function checks for a match in a local part list. The third argument
35611 controls case-sensitivity. The return values are as for
35612 &'lss_match_domain()'&.
35613
35614 .vitem "&*int&~lss_match_address(uschar&~*address,&~uschar&~*list,&~&&&
35615         BOOL&~caseless)*&"
35616 This function checks for a match in an address list. The third argument
35617 controls the case-sensitivity of the local part match. The domain is always
35618 matched caselessly. The return values are as for &'lss_match_domain()'&.
35619
35620 .vitem "&*int&~lss_match_host(uschar&~*host_name,&~uschar&~*host_address,&~&&&
35621         uschar&~*list)*&"
35622 This function checks for a match in a host list. The most common usage is
35623 expected to be
35624 .code
35625 lss_match_host(sender_host_name, sender_host_address, ...)
35626 .endd
35627 .vindex "&$sender_host_address$&"
35628 An empty address field matches an empty item in the host list. If the host name
35629 is NULL, the name corresponding to &$sender_host_address$& is automatically
35630 looked up if a host name is required to match an item in the list. The return
35631 values are as for &'lss_match_domain()'&, but in addition, &'lss_match_host()'&
35632 returns ERROR in the case when it had to look up a host name, but the lookup
35633 failed.
35634
35635 .vitem "&*void&~log_write(unsigned&~int&~selector,&~int&~which,&~char&~&&&
35636         *format,&~...)*&"
35637 This function writes to Exim's log files. The first argument should be zero (it
35638 is concerned with &%log_selector%&). The second argument can be &`LOG_MAIN`& or
35639 &`LOG_REJECT`& or &`LOG_PANIC`& or the inclusive &"or"& of any combination of
35640 them. It specifies to which log or logs the message is written. The remaining
35641 arguments are a format and relevant insertion arguments. The string should not
35642 contain any newlines, not even at the end.
35643
35644
35645 .vitem &*void&~receive_add_recipient(uschar&~*address,&~int&~pno)*&
35646 This function adds an additional recipient to the message. The first argument
35647 is the recipient address. If it is unqualified (has no domain), it is qualified
35648 with the &%qualify_recipient%& domain. The second argument must always be -1.
35649
35650 This function does not allow you to specify a private &%errors_to%& address (as
35651 described with the structure of &%recipient_item%& above), because it pre-dates
35652 the addition of that field to the structure. However, it is easy to add such a
35653 value afterwards. For example:
35654 .code
35655  receive_add_recipient(US"monitor@mydom.example", -1);
35656  recipients_list[recipients_count-1].errors_to =
35657    US"postmaster@mydom.example";
35658 .endd
35659
35660 .vitem &*BOOL&~receive_remove_recipient(uschar&~*recipient)*&
35661 This is a convenience function to remove a named recipient from the list of
35662 recipients. It returns true if a recipient was removed, and false if no
35663 matching recipient could be found. The argument must be a complete email
35664 address.
35665 .endlist
35666
35667
35668 .cindex "RFC 2047"
35669 .vlist
35670 .vitem "&*uschar&~rfc2047_decode(uschar&~*string,&~BOOL&~lencheck,&&&
35671   &~uschar&~*target,&~int&~zeroval,&~int&~*lenptr, &~&~uschar&~**error)*&"
35672 This function decodes strings that are encoded according to RFC 2047. Typically
35673 these are the contents of header lines. First, each &"encoded word"& is decoded
35674 from the Q or B encoding into a byte-string. Then, if provided with the name of
35675 a charset encoding, and if the &[iconv()]& function is available, an attempt is
35676 made  to translate the result to the named character set. If this fails, the
35677 binary string is returned with an error message.
35678
35679 The first argument is the string to be decoded. If &%lencheck%& is TRUE, the
35680 maximum MIME word length is enforced. The third argument is the target
35681 encoding, or NULL if no translation is wanted.
35682
35683 .cindex "binary zero" "in RFC 2047 decoding"
35684 .cindex "RFC 2047" "binary zero in"
35685 If a binary zero is encountered in the decoded string, it is replaced by the
35686 contents of the &%zeroval%& argument. For use with Exim headers, the value must
35687 not be 0 because header lines are handled as zero-terminated strings.
35688
35689 The function returns the result of processing the string, zero-terminated; if
35690 &%lenptr%& is not NULL, the length of the result is set in the variable to
35691 which it points. When &%zeroval%& is 0, &%lenptr%& should not be NULL.
35692
35693 If an error is encountered, the function returns NULL and uses the &%error%&
35694 argument to return an error message. The variable pointed to by &%error%& is
35695 set to NULL if there is no error; it may be set non-NULL even when the function
35696 returns a non-NULL value if decoding was successful, but there was a problem
35697 with translation.
35698
35699
35700 .vitem &*int&~smtp_fflush(void)*&
35701 This function is used in conjunction with &'smtp_printf()'&, as described
35702 below.
35703
35704 .vitem &*void&~smtp_printf(char&~*,BOOL,&~...)*&
35705 The arguments of this function are almost like &[printf()]&; it writes to the SMTP
35706 output stream. You should use this function only when there is an SMTP output
35707 stream, that is, when the incoming message is being received via interactive
35708 SMTP. This is the case when &%smtp_input%& is TRUE and &%smtp_batched_input%&
35709 is FALSE. If you want to test for an incoming message from another host (as
35710 opposed to a local process that used the &%-bs%& command line option), you can
35711 test the value of &%sender_host_address%&, which is non-NULL when a remote host
35712 is involved.
35713
35714 If an SMTP TLS connection is established, &'smtp_printf()'& uses the TLS
35715 output function, so it can be used for all forms of SMTP connection.
35716
35717 The second argument is used to request that the data be buffered
35718 (when TRUE) or flushed (along with any previously buffered, when FALSE).
35719 This is advisory only, but likely to save on system-calls and packets
35720 sent when a sequence of calls to the function are made.
35721
35722 The argument was added in Exim version 4.90 - changing the API/ABI.
35723 Nobody noticed until 4.93 was imminent, at which point the
35724 ABI version number was incremented.
35725
35726 Strings that are written by &'smtp_printf()'& from within &[local_scan()]&
35727 must start with an appropriate response code: 550 if you are going to return
35728 LOCAL_SCAN_REJECT, 451 if you are going to return
35729 LOCAL_SCAN_TEMPREJECT, and 250 otherwise. Because you are writing the
35730 initial lines of a multi-line response, the code must be followed by a hyphen
35731 to indicate that the line is not the final response line. You must also ensure
35732 that the lines you write terminate with CRLF. For example:
35733 .code
35734 smtp_printf("550-this is some extra info\r\n");
35735 return LOCAL_SCAN_REJECT;
35736 .endd
35737 Note that you can also create multi-line responses by including newlines in
35738 the data returned via the &%return_text%& argument. The added value of using
35739 &'smtp_printf()'& is that, for instance, you could introduce delays between
35740 multiple output lines.
35741
35742 The &'smtp_printf()'& function does not return any error indication, because it
35743 does not
35744 guarantee a flush of
35745 pending output, and therefore does not test
35746 the state of the stream. (In the main code of Exim, flushing and error
35747 detection is done when Exim is ready for the next SMTP input command.) If
35748 you want to flush the output and check for an error (for example, the
35749 dropping of a TCP/IP connection), you can call &'smtp_fflush()'&, which has no
35750 arguments. It flushes the output stream, and returns a non-zero value if there
35751 is an error.
35752
35753 .vitem &*void&~*store_get(int,BOOL)*&
35754 This function accesses Exim's internal store (memory) manager. It gets a new
35755 chunk of memory whose size is given by the first argument.
35756 The second argument should be given as TRUE if the memory will be used for
35757 data possibly coming from an attacker (eg. the message content),
35758 FALSE if it is locally-sourced.
35759 Exim bombs out if it ever
35760 runs out of memory. See the next section for a discussion of memory handling.
35761
35762 .vitem &*void&~*store_get_perm(int,BOOL)*&
35763 This function is like &'store_get()'&, but it always gets memory from the
35764 permanent pool. See the next section for a discussion of memory handling.
35765
35766 .vitem &*uschar&~*string_copy(uschar&~*string)*&
35767 See below.
35768
35769 .vitem &*uschar&~*string_copyn(uschar&~*string,&~int&~length)*&
35770 See below.
35771
35772 .vitem &*uschar&~*string_sprintf(char&~*format,&~...)*&
35773 These three functions create strings using Exim's dynamic memory facilities.
35774 The first makes a copy of an entire string. The second copies up to a maximum
35775 number of characters, indicated by the second argument. The third uses a format
35776 and insertion arguments to create a new string. In each case, the result is a
35777 pointer to a new string in the current memory pool. See the next section for
35778 more discussion.
35779 .endlist
35780
35781
35782
35783 .section "More about Exim's memory handling" "SECTmemhanloc"
35784 .cindex "&[local_scan()]& function" "memory handling"
35785 No function is provided for freeing memory, because that is never needed.
35786 The dynamic memory that Exim uses when receiving a message is automatically
35787 recycled if another message is received by the same process (this applies only
35788 to incoming SMTP connections &-- other input methods can supply only one
35789 message at a time). After receiving the last message, a reception process
35790 terminates.
35791
35792 Because it is recycled, the normal dynamic memory cannot be used for holding
35793 data that must be preserved over a number of incoming messages on the same SMTP
35794 connection. However, Exim in fact uses two pools of dynamic memory; the second
35795 one is not recycled, and can be used for this purpose.
35796
35797 If you want to allocate memory that remains available for subsequent messages
35798 in the same SMTP connection, you should set
35799 .code
35800 store_pool = POOL_PERM
35801 .endd
35802 before calling the function that does the allocation. There is no need to
35803 restore the value if you do not need to; however, if you do want to revert to
35804 the normal pool, you can either restore the previous value of &%store_pool%& or
35805 set it explicitly to POOL_MAIN.
35806
35807 The pool setting applies to all functions that get dynamic memory, including
35808 &'expand_string()'&, &'store_get()'&, and the &'string_xxx()'& functions.
35809 There is also a convenience function called &'store_get_perm()'& that gets a
35810 block of memory from the permanent pool while preserving the value of
35811 &%store_pool%&.
35812 .ecindex IIDlosca
35813
35814
35815
35816
35817 . ////////////////////////////////////////////////////////////////////////////
35818 . ////////////////////////////////////////////////////////////////////////////
35819
35820 .chapter "System-wide message filtering" "CHAPsystemfilter"
35821 .scindex IIDsysfil1 "filter" "system filter"
35822 .scindex IIDsysfil2 "filtering all mail"
35823 .scindex IIDsysfil3 "system filter"
35824 The previous chapters (on ACLs and the local scan function) describe checks
35825 that can be applied to messages before they are accepted by a host. There is
35826 also a mechanism for checking messages once they have been received, but before
35827 they are delivered. This is called the &'system filter'&.
35828
35829 The system filter operates in a similar manner to users' filter files, but it
35830 is run just once per message (however many recipients the message has).
35831 It should not normally be used as a substitute for routing, because &%deliver%&
35832 commands in a system router provide new envelope recipient addresses.
35833 The system filter must be an Exim filter. It cannot be a Sieve filter.
35834
35835 The system filter is run at the start of a delivery attempt, before any routing
35836 is done. If a message fails to be completely delivered at the first attempt,
35837 the system filter is run again at the start of every retry.
35838 If you want your filter to do something only once per message, you can make use
35839 of the &%first_delivery%& condition in an &%if%& command in the filter to
35840 prevent it happening on retries.
35841
35842 .vindex "&$domain$&"
35843 .vindex "&$local_part$&"
35844 &*Warning*&: Because the system filter runs just once, variables that are
35845 specific to individual recipient addresses, such as &$local_part$& and
35846 &$domain$&, are not set, and the &"personal"& condition is not meaningful. If
35847 you want to run a centrally-specified filter for each recipient address
35848 independently, you can do so by setting up a suitable &(redirect)& router, as
35849 described in section &<<SECTperaddfil>>& below.
35850
35851
35852 .section "Specifying a system filter" "SECID212"
35853 .cindex "uid (user id)" "system filter"
35854 .cindex "gid (group id)" "system filter"
35855 The name of the file that contains the system filter must be specified by
35856 setting &%system_filter%&. If you want the filter to run under a uid and gid
35857 other than root, you must also set &%system_filter_user%& and
35858 &%system_filter_group%& as appropriate. For example:
35859 .code
35860 system_filter = /etc/mail/exim.filter
35861 system_filter_user = exim
35862 .endd
35863 If a system filter generates any deliveries directly to files or pipes (via the
35864 &%save%& or &%pipe%& commands), transports to handle these deliveries must be
35865 specified by setting &%system_filter_file_transport%& and
35866 &%system_filter_pipe_transport%&, respectively. Similarly,
35867 &%system_filter_reply_transport%& must be set to handle any messages generated
35868 by the &%reply%& command.
35869
35870
35871 .section "Testing a system filter" "SECID213"
35872 You can run simple tests of a system filter in the same way as for a user
35873 filter, but you should use &%-bF%& rather than &%-bf%&, so that features that
35874 are permitted only in system filters are recognized.
35875
35876 If you want to test the combined effect of a system filter and a user filter,
35877 you can use both &%-bF%& and &%-bf%& on the same command line.
35878
35879
35880
35881 .section "Contents of a system filter" "SECID214"
35882 The language used to specify system filters is the same as for users' filter
35883 files. It is described in the separate end-user document &'Exim's interface to
35884 mail filtering'&. However, there are some additional features that are
35885 available only in system filters; these are described in subsequent sections.
35886 If they are encountered in a user's filter file or when testing with &%-bf%&,
35887 they cause errors.
35888
35889 .cindex "frozen messages" "manual thaw; testing in filter"
35890 There are two special conditions which, though available in users' filter
35891 files, are designed for use in system filters. The condition &%first_delivery%&
35892 is true only for the first attempt at delivering a message, and
35893 &%manually_thawed%& is true only if the message has been frozen, and
35894 subsequently thawed by an admin user. An explicit forced delivery counts as a
35895 manual thaw, but thawing as a result of the &%auto_thaw%& setting does not.
35896
35897 &*Warning*&: If a system filter uses the &%first_delivery%& condition to
35898 specify an &"unseen"& (non-significant) delivery, and that delivery does not
35899 succeed, it will not be tried again.
35900 If you want Exim to retry an unseen delivery until it succeeds, you should
35901 arrange to set it up every time the filter runs.
35902
35903 When a system filter finishes running, the values of the variables &$n0$& &--
35904 &$n9$& are copied into &$sn0$& &-- &$sn9$& and are thereby made available to
35905 users' filter files. Thus a system filter can, for example, set up &"scores"&
35906 to which users' filter files can refer.
35907
35908
35909
35910 .section "Additional variable for system filters" "SECID215"
35911 .vindex "&$recipients$&"
35912 The expansion variable &$recipients$&, containing a list of all the recipients
35913 of the message (separated by commas and white space), is available in system
35914 filters. It is not available in users' filters for privacy reasons.
35915
35916
35917
35918 .section "Defer, freeze, and fail commands for system filters" "SECID216"
35919 .cindex "freezing messages"
35920 .cindex "message" "freezing"
35921 .cindex "message" "forced failure"
35922 .cindex "&%fail%&" "in system filter"
35923 .cindex "&%freeze%& in system filter"
35924 .cindex "&%defer%& in system filter"
35925 There are three extra commands (&%defer%&, &%freeze%& and &%fail%&) which are
35926 always available in system filters, but are not normally enabled in users'
35927 filters. (See the &%allow_defer%&, &%allow_freeze%& and &%allow_fail%& options
35928 for the &(redirect)& router.) These commands can optionally be followed by the
35929 word &%text%& and a string containing an error message, for example:
35930 .code
35931 fail text "this message looks like spam to me"
35932 .endd
35933 The keyword &%text%& is optional if the next character is a double quote.
35934
35935 The &%defer%& command defers delivery of the original recipients of the
35936 message. The &%fail%& command causes all the original recipients to be failed,
35937 and a bounce message to be created. The &%freeze%& command suspends all
35938 delivery attempts for the original recipients. In all cases, any new deliveries
35939 that are specified by the filter are attempted as normal after the filter has
35940 run.
35941
35942 The &%freeze%& command is ignored if the message has been manually unfrozen and
35943 not manually frozen since. This means that automatic freezing by a system
35944 filter can be used as a way of checking out suspicious messages. If a message
35945 is found to be all right, manually unfreezing it allows it to be delivered.
35946
35947 .cindex "log" "&%fail%& command log line"
35948 .cindex "&%fail%&" "log line; reducing"
35949 The text given with a fail command is used as part of the bounce message as
35950 well as being written to the log. If the message is quite long, this can fill
35951 up a lot of log space when such failures are common. To reduce the size of the
35952 log message, Exim interprets the text in a special way if it starts with the
35953 two characters &`<<`& and contains &`>>`& later. The text between these two
35954 strings is written to the log, and the rest of the text is used in the bounce
35955 message. For example:
35956 .code
35957 fail "<<filter test 1>>Your message is rejected \
35958      because it contains attachments that we are \
35959      not prepared to receive."
35960 .endd
35961
35962 .cindex "loop" "caused by &%fail%&"
35963 Take great care with the &%fail%& command when basing the decision to fail on
35964 the contents of the message, because the bounce message will of course include
35965 the contents of the original message and will therefore trigger the &%fail%&
35966 command again (causing a mail loop) unless steps are taken to prevent this.
35967 Testing the &%error_message%& condition is one way to prevent this. You could
35968 use, for example
35969 .code
35970 if $message_body contains "this is spam" and not error_message
35971 then fail text "spam is not wanted here" endif
35972 .endd
35973 though of course that might let through unwanted bounce messages. The
35974 alternative is clever checking of the body and/or headers to detect bounces
35975 generated by the filter.
35976
35977 The interpretation of a system filter file ceases after a
35978 &%defer%&,
35979 &%freeze%&, or &%fail%& command is obeyed. However, any deliveries that were
35980 set up earlier in the filter file are honoured, so you can use a sequence such
35981 as
35982 .code
35983 mail ...
35984 freeze
35985 .endd
35986 to send a specified message when the system filter is freezing (or deferring or
35987 failing) a message. The normal deliveries for the message do not, of course,
35988 take place.
35989
35990
35991
35992 .section "Adding and removing headers in a system filter" "SECTaddremheasys"
35993 .cindex "header lines" "adding; in system filter"
35994 .cindex "header lines" "removing; in system filter"
35995 .cindex "filter" "header lines; adding/removing"
35996 Two filter commands that are available only in system filters are:
35997 .code
35998 headers add <string>
35999 headers remove <string>
36000 .endd
36001 The argument for the &%headers add%& is a string that is expanded and then
36002 added to the end of the message's headers. It is the responsibility of the
36003 filter maintainer to make sure it conforms to RFC 2822 syntax. Leading white
36004 space is ignored, and if the string is otherwise empty, or if the expansion is
36005 forced to fail, the command has no effect.
36006
36007 You can use &"\n"& within the string, followed by white space, to specify
36008 continued header lines. More than one header may be added in one command by
36009 including &"\n"& within the string without any following white space. For
36010 example:
36011 .code
36012 headers add "X-header-1: ....\n  \
36013              continuation of X-header-1 ...\n\
36014              X-header-2: ...."
36015 .endd
36016 Note that the header line continuation white space after the first newline must
36017 be placed before the backslash that continues the input string, because white
36018 space after input continuations is ignored.
36019
36020 The argument for &%headers remove%& is a colon-separated list of header names.
36021 This command applies only to those headers that are stored with the message;
36022 those that are added at delivery time (such as &'Envelope-To:'& and
36023 &'Return-Path:'&) cannot be removed by this means. If there is more than one
36024 header with the same name, they are all removed.
36025
36026 The &%headers%& command in a system filter makes an immediate change to the set
36027 of header lines that was received with the message (with possible additions
36028 from ACL processing). Subsequent commands in the system filter operate on the
36029 modified set, which also forms the basis for subsequent message delivery.
36030 Unless further modified during routing or transporting, this set of headers is
36031 used for all recipients of the message.
36032
36033 During routing and transporting, the variables that refer to the contents of
36034 header lines refer only to those lines that are in this set. Thus, header lines
36035 that are added by a system filter are visible to users' filter files and to all
36036 routers and transports. This contrasts with the manipulation of header lines by
36037 routers and transports, which is not immediate, but which instead is saved up
36038 until the message is actually being written (see section
36039 &<<SECTheadersaddrem>>&).
36040
36041 If the message is not delivered at the first attempt, header lines that were
36042 added by the system filter are stored with the message, and so are still
36043 present at the next delivery attempt. Header lines that were removed are still
36044 present, but marked &"deleted"& so that they are not transported with the
36045 message. For this reason, it is usual to make the &%headers%& command
36046 conditional on &%first_delivery%& so that the set of header lines is not
36047 modified more than once.
36048
36049 Because header modification in a system filter acts immediately, you have to
36050 use an indirect approach if you want to modify the contents of a header line.
36051 For example:
36052 .code
36053 headers add "Old-Subject: $h_subject:"
36054 headers remove "Subject"
36055 headers add "Subject: new subject (was: $h_old-subject:)"
36056 headers remove "Old-Subject"
36057 .endd
36058
36059
36060
36061 .section "Setting an errors address in a system filter" "SECID217"
36062 .cindex "envelope from"
36063 .cindex "envelope sender"
36064 In a system filter, if a &%deliver%& command is followed by
36065 .code
36066 errors_to <some address>
36067 .endd
36068 in order to change the envelope sender (and hence the error reporting) for that
36069 delivery, any address may be specified. (In a user filter, only the current
36070 user's address can be set.) For example, if some mail is being monitored, you
36071 might use
36072 .code
36073 unseen deliver monitor@spying.example errors_to root@local.example
36074 .endd
36075 to take a copy which would not be sent back to the normal error reporting
36076 address if its delivery failed.
36077
36078
36079
36080 .section "Per-address filtering" "SECTperaddfil"
36081 .vindex "&$domain_data$&"
36082 .vindex "&$local_part_data$&"
36083 In contrast to the system filter, which is run just once per message for each
36084 delivery attempt, it is also possible to set up a system-wide filtering
36085 operation that runs once for each recipient address. In this case, variables
36086 such as &$local_part_data$& and &$domain_data$& can be used,
36087 and indeed, the choice of filter file could be made dependent on them.
36088 This is an example of a router which implements such a filter:
36089 .code
36090 central_filter:
36091   check_local_user
36092   driver = redirect
36093   domains = +local_domains
36094   file = /central/filters/$local_part_data
36095   no_verify
36096   allow_filter
36097   allow_freeze
36098 .endd
36099 The filter is run in a separate process under its own uid. Therefore, either
36100 &%check_local_user%& must be set (as above), in which case the filter is run as
36101 the local user, or the &%user%& option must be used to specify which user to
36102 use. If both are set, &%user%& overrides.
36103
36104 Care should be taken to ensure that none of the commands in the filter file
36105 specify a significant delivery if the message is to go on to be delivered to
36106 its intended recipient. The router will not then claim to have dealt with the
36107 address, so it will be passed on to subsequent routers to be delivered in the
36108 normal way.
36109 .ecindex IIDsysfil1
36110 .ecindex IIDsysfil2
36111 .ecindex IIDsysfil3
36112
36113
36114
36115
36116
36117
36118 . ////////////////////////////////////////////////////////////////////////////
36119 . ////////////////////////////////////////////////////////////////////////////
36120
36121 .chapter "Message processing" "CHAPmsgproc"
36122 .scindex IIDmesproc "message" "general processing"
36123 Exim performs various transformations on the sender and recipient addresses of
36124 all messages that it handles, and also on the messages' header lines. Some of
36125 these are optional and configurable, while others always take place. All of
36126 this processing, except rewriting as a result of routing, and the addition or
36127 removal of header lines while delivering, happens when a message is received,
36128 before it is placed on Exim's queue.
36129
36130 Some of the automatic processing takes place by default only for
36131 &"locally-originated"& messages. This adjective is used to describe messages
36132 that are not received over TCP/IP, but instead are passed to an Exim process on
36133 its standard input. This includes the interactive &"local SMTP"& case that is
36134 set up by the &%-bs%& command line option.
36135
36136 &*Note*&: Messages received over TCP/IP on the loopback interface (127.0.0.1
36137 or ::1) are not considered to be locally-originated. Exim does not treat the
36138 loopback interface specially in any way.
36139
36140 If you want the loopback interface to be treated specially, you must ensure
36141 that there are appropriate entries in your ACLs.
36142
36143
36144
36145
36146 .section "Submission mode for non-local messages" "SECTsubmodnon"
36147 .cindex "message" "submission"
36148 .cindex "submission mode"
36149 Processing that happens automatically for locally-originated messages (unless
36150 &%suppress_local_fixups%& is set) can also be requested for messages that are
36151 received over TCP/IP. The term &"submission mode"& is used to describe this
36152 state. Submission mode is set by the modifier
36153 .code
36154 control = submission
36155 .endd
36156 in a MAIL, RCPT, or pre-data ACL for an incoming message (see sections
36157 &<<SECTACLmodi>>& and &<<SECTcontrols>>&). This makes Exim treat the message as
36158 a local submission, and is normally used when the source of the message is
36159 known to be an MUA running on a client host (as opposed to an MTA). For
36160 example, to set submission mode for messages originating on the IPv4 loopback
36161 interface, you could include the following in the MAIL ACL:
36162 .code
36163 warn  hosts = 127.0.0.1
36164       control = submission
36165 .endd
36166 .cindex "&%sender_retain%& submission option"
36167 There are some options that can be used when setting submission mode. A slash
36168 is used to separate options. For example:
36169 .code
36170 control = submission/sender_retain
36171 .endd
36172 Specifying &%sender_retain%& has the effect of setting &%local_sender_retain%&
36173 true and &%local_from_check%& false for the current incoming message. The first
36174 of these allows an existing &'Sender:'& header in the message to remain, and
36175 the second suppresses the check to ensure that &'From:'& matches the
36176 authenticated sender. With this setting, Exim still fixes up messages by adding
36177 &'Date:'& and &'Message-ID:'& header lines if they are missing, but makes no
36178 attempt to check sender authenticity in header lines.
36179
36180 When &%sender_retain%& is not set, a submission mode setting may specify a
36181 domain to be used when generating a &'From:'& or &'Sender:'& header line. For
36182 example:
36183 .code
36184 control = submission/domain=some.domain
36185 .endd
36186 The domain may be empty. How this value is used is described in sections
36187 &<<SECTthefrohea>>& and &<<SECTthesenhea>>&. There is also a &%name%& option
36188 that allows you to specify the user's full name for inclusion in a created
36189 &'Sender:'& or &'From:'& header line. For example:
36190 .code
36191 accept authenticated = *
36192        control = submission/domain=wonderland.example/\
36193                             name=${lookup {$authenticated_id} \
36194                                    lsearch {/etc/exim/namelist}}
36195 .endd
36196 Because the name may contain any characters, including slashes, the &%name%&
36197 option must be given last. The remainder of the string is used as the name. For
36198 the example above, if &_/etc/exim/namelist_& contains:
36199 .code
36200 bigegg:  Humpty Dumpty
36201 .endd
36202 then when the sender has authenticated as &'bigegg'&, the generated &'Sender:'&
36203 line would be:
36204 .code
36205 Sender: Humpty Dumpty <bigegg@wonderland.example>
36206 .endd
36207 .cindex "return path" "in submission mode"
36208 By default, submission mode forces the return path to the same address as is
36209 used to create the &'Sender:'& header. However, if &%sender_retain%& is
36210 specified, the return path is also left unchanged.
36211
36212 &*Note*&: The changes caused by submission mode take effect after the predata
36213 ACL. This means that any sender checks performed before the fix-ups use the
36214 untrusted sender address specified by the user, not the trusted sender address
36215 specified by submission mode. Although this might be slightly unexpected, it
36216 does mean that you can configure ACL checks to spot that a user is trying to
36217 spoof another's address.
36218
36219 .section "Line endings" "SECTlineendings"
36220 .cindex "line endings"
36221 .cindex "carriage return"
36222 .cindex "linefeed"
36223 RFC 2821 specifies that CRLF (two characters: carriage-return, followed by
36224 linefeed) is the line ending for messages transmitted over the Internet using
36225 SMTP over TCP/IP. However, within individual operating systems, different
36226 conventions are used. For example, Unix-like systems use just LF, but others
36227 use CRLF or just CR.
36228
36229 Exim was designed for Unix-like systems, and internally, it stores messages
36230 using the system's convention of a single LF as a line terminator. When
36231 receiving a message, all line endings are translated to this standard format.
36232 Originally, it was thought that programs that passed messages directly to an
36233 MTA within an operating system would use that system's convention. Experience
36234 has shown that this is not the case; for example, there are Unix applications
36235 that use CRLF in this circumstance. For this reason, and for compatibility with
36236 other MTAs, the way Exim handles line endings for all messages is now as
36237 follows:
36238
36239 .ilist
36240 LF not preceded by CR is treated as a line ending.
36241 .next
36242 CR is treated as a line ending; if it is immediately followed by LF, the LF
36243 is ignored.
36244 .next
36245 The sequence &"CR, dot, CR"& does not terminate an incoming SMTP message,
36246 nor a local message in the state where a line containing only a dot is a
36247 terminator.
36248 .next
36249 If a bare CR is encountered within a header line, an extra space is added after
36250 the line terminator so as not to end the header line. The reasoning behind this
36251 is that bare CRs in header lines are most likely either to be mistakes, or
36252 people trying to play silly games.
36253 .next
36254 If the first header line received in a message ends with CRLF, a subsequent
36255 bare LF in a header line is treated in the same way as a bare CR in a header
36256 line.
36257 .endlist
36258
36259
36260
36261
36262
36263 .section "Unqualified addresses" "SECID218"
36264 .cindex "unqualified addresses"
36265 .cindex "address" "qualification"
36266 By default, Exim expects every envelope address it receives from an external
36267 host to be fully qualified. Unqualified addresses cause negative responses to
36268 SMTP commands. However, because SMTP is used as a means of transporting
36269 messages from MUAs running on personal workstations, there is sometimes a
36270 requirement to accept unqualified addresses from specific hosts or IP networks.
36271
36272 Exim has two options that separately control which hosts may send unqualified
36273 sender or recipient addresses in SMTP commands, namely
36274 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&. In both
36275 cases, if an unqualified address is accepted, it is qualified by adding the
36276 value of &%qualify_domain%& or &%qualify_recipient%&, as appropriate.
36277
36278 .oindex "&%qualify_domain%&"
36279 .oindex "&%qualify_recipient%&"
36280 Unqualified addresses in header lines are automatically qualified for messages
36281 that are locally originated, unless the &%-bnq%& option is given on the command
36282 line. For messages received over SMTP, unqualified addresses in header lines
36283 are qualified only if unqualified addresses are permitted in SMTP commands. In
36284 other words, such qualification is also controlled by
36285 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&,
36286
36287
36288
36289
36290 .section "The UUCP From line" "SECID219"
36291 .cindex "&""From""& line"
36292 .cindex "UUCP" "&""From""& line"
36293 .cindex "sender" "address"
36294 .oindex "&%uucp_from_pattern%&"
36295 .oindex "&%uucp_from_sender%&"
36296 .cindex "envelope from"
36297 .cindex "envelope sender"
36298 .cindex "Sendmail compatibility" "&""From""& line"
36299 Messages that have come from UUCP (and some other applications) often begin
36300 with a line containing the envelope sender and a timestamp, following the word
36301 &"From"&. Examples of two common formats are:
36302 .code
36303 From a.oakley@berlin.mus Fri Jan  5 12:35 GMT 1996
36304 From f.butler@berlin.mus Fri, 7 Jan 97 14:00:00 GMT
36305 .endd
36306 This line precedes the RFC 2822 header lines. For compatibility with Sendmail,
36307 Exim recognizes such lines at the start of messages that are submitted to it
36308 via the command line (that is, on the standard input). It does not recognize
36309 such lines in incoming SMTP messages, unless the sending host matches
36310 &%ignore_fromline_hosts%& or the &%-bs%& option was used for a local message
36311 and &%ignore_fromline_local%& is set. The recognition is controlled by a
36312 regular expression that is defined by the &%uucp_from_pattern%& option, whose
36313 default value matches the two common cases shown above and puts the address
36314 that follows &"From"& into &$1$&.
36315
36316 .cindex "numerical variables (&$1$& &$2$& etc)" "in &""From ""& line handling"
36317 When the caller of Exim for a non-SMTP message that contains a &"From"& line is
36318 a trusted user, the message's sender address is constructed by expanding the
36319 contents of &%uucp_sender_address%&, whose default value is &"$1"&. This is
36320 then parsed as an RFC 2822 address. If there is no domain, the local part is
36321 qualified with &%qualify_domain%& unless it is the empty string. However, if
36322 the command line &%-f%& option is used, it overrides the &"From"& line.
36323
36324 If the caller of Exim is not trusted, the &"From"& line is recognized, but the
36325 sender address is not changed. This is also the case for incoming SMTP messages
36326 that are permitted to contain &"From"& lines.
36327
36328 Only one &"From"& line is recognized. If there is more than one, the second is
36329 treated as a data line that starts the body of the message, as it is not valid
36330 as a header line. This also happens if a &"From"& line is present in an
36331 incoming SMTP message from a source that is not permitted to send them.
36332
36333
36334
36335 .section "Resent- header lines" "SECID220"
36336 .chindex Resent-
36337 RFC 2822 makes provision for sets of header lines starting with the string
36338 &`Resent-`& to be added to a message when it is resent by the original
36339 recipient to somebody else. These headers are &'Resent-Date:'&,
36340 &'Resent-From:'&, &'Resent-Sender:'&, &'Resent-To:'&, &'Resent-Cc:'&,
36341 &'Resent-Bcc:'& and &'Resent-Message-ID:'&. The RFC says:
36342
36343 .blockquote
36344 &'Resent fields are strictly informational. They MUST NOT be used in the normal
36345 processing of replies or other such automatic actions on messages.'&
36346 .endblockquote
36347
36348 This leaves things a bit vague as far as other processing actions such as
36349 address rewriting are concerned. Exim treats &%Resent-%& header lines as
36350 follows:
36351
36352 .ilist
36353 A &'Resent-From:'& line that just contains the login id of the submitting user
36354 is automatically rewritten in the same way as &'From:'& (see below).
36355 .next
36356 If there's a rewriting rule for a particular header line, it is also applied to
36357 &%Resent-%& header lines of the same type. For example, a rule that rewrites
36358 &'From:'& also rewrites &'Resent-From:'&.
36359 .next
36360 For local messages, if &'Sender:'& is removed on input, &'Resent-Sender:'& is
36361 also removed.
36362 .next
36363 For a locally-submitted message,
36364 if there are any &%Resent-%& header lines but no &'Resent-Date:'&,
36365 &'Resent-From:'&, or &'Resent-Message-Id:'&, they are added as necessary. It is
36366 the contents of &'Resent-Message-Id:'& (rather than &'Message-Id:'&) which are
36367 included in log lines in this case.
36368 .next
36369 The logic for adding &'Sender:'& is duplicated for &'Resent-Sender:'& when any
36370 &%Resent-%& header lines are present.
36371 .endlist
36372
36373
36374
36375
36376 .section "The Auto-Submitted: header line" "SECID221"
36377 Whenever Exim generates an autoreply, a bounce, or a delay warning message, it
36378 includes the header line:
36379 .code
36380 Auto-Submitted: auto-replied
36381 .endd
36382
36383 .section "The Bcc: header line" "SECID222"
36384 .cindex "&'Bcc:'& header line"
36385 If Exim is called with the &%-t%& option, to take recipient addresses from a
36386 message's header, it removes any &'Bcc:'& header line that may exist (after
36387 extracting its addresses). If &%-t%& is not present on the command line, any
36388 existing &'Bcc:'& is not removed.
36389
36390
36391 .section "The Date: header line" "SECID223"
36392 .cindex Date:
36393 If a locally-generated or submission-mode message has no &'Date:'& header line,
36394 Exim adds one, using the current date and time, unless the
36395 &%suppress_local_fixups%& control has been specified.
36396
36397 .section "The Delivery-date: header line" "SECID224"
36398 .cindex "&'Delivery-date:'& header line"
36399 .oindex "&%delivery_date_remove%&"
36400 &'Delivery-date:'& header lines are not part of the standard RFC 2822 header
36401 set. Exim can be configured to add them to the final delivery of messages. (See
36402 the generic &%delivery_date_add%& transport option.) They should not be present
36403 in messages in transit. If the &%delivery_date_remove%& configuration option is
36404 set (the default), Exim removes &'Delivery-date:'& header lines from incoming
36405 messages.
36406
36407
36408 .section "The Envelope-to: header line" "SECID225"
36409 .chindex Envelope-to:
36410 .oindex "&%envelope_to_remove%&"
36411 &'Envelope-to:'& header lines are not part of the standard RFC 2822 header set.
36412 Exim can be configured to add them to the final delivery of messages. (See the
36413 generic &%envelope_to_add%& transport option.) They should not be present in
36414 messages in transit. If the &%envelope_to_remove%& configuration option is set
36415 (the default), Exim removes &'Envelope-to:'& header lines from incoming
36416 messages.
36417
36418
36419 .section "The From: header line" "SECTthefrohea"
36420 .chindex From:
36421 .cindex "Sendmail compatibility" "&""From""& line"
36422 .cindex "message" "submission"
36423 .cindex "submission mode"
36424 If a submission-mode message does not contain a &'From:'& header line, Exim
36425 adds one if either of the following conditions is true:
36426
36427 .ilist
36428 The envelope sender address is not empty (that is, this is not a bounce
36429 message). The added header line copies the envelope sender address.
36430 .next
36431 .vindex "&$authenticated_id$&"
36432 The SMTP session is authenticated and &$authenticated_id$& is not empty.
36433 .olist
36434 .vindex "&$qualify_domain$&"
36435 If no domain is specified by the submission control, the local part is
36436 &$authenticated_id$& and the domain is &$qualify_domain$&.
36437 .next
36438 If a non-empty domain is specified by the submission control, the local
36439 part is &$authenticated_id$&, and the domain is the specified domain.
36440 .next
36441 If an empty domain is specified by the submission control,
36442 &$authenticated_id$& is assumed to be the complete address.
36443 .endlist
36444 .endlist
36445
36446 A non-empty envelope sender takes precedence.
36447
36448 If a locally-generated incoming message does not contain a &'From:'& header
36449 line, and the &%suppress_local_fixups%& control is not set, Exim adds one
36450 containing the sender's address. The calling user's login name and full name
36451 are used to construct the address, as described in section &<<SECTconstr>>&.
36452 They are obtained from the password data by calling &[getpwuid()]& (but see the
36453 &%unknown_login%& configuration option). The address is qualified with
36454 &%qualify_domain%&.
36455
36456 For compatibility with Sendmail, if an incoming, non-SMTP message has a
36457 &'From:'& header line containing just the unqualified login name of the calling
36458 user, this is replaced by an address containing the user's login name and full
36459 name as described in section &<<SECTconstr>>&.
36460
36461
36462 .section "The Message-ID: header line" "SECID226"
36463 .chindex Message-ID:
36464 .cindex "message" "submission"
36465 .oindex "&%message_id_header_text%&"
36466 If a locally-generated or submission-mode incoming message does not contain a
36467 &'Message-ID:'& or &'Resent-Message-ID:'& header line, and the
36468 &%suppress_local_fixups%& control is not set, Exim adds a suitable header line
36469 to the message. If there are any &'Resent-:'& headers in the message, it
36470 creates &'Resent-Message-ID:'&. The id is constructed from Exim's internal
36471 message id, preceded by the letter E to ensure it starts with a letter, and
36472 followed by @ and the primary host name. Additional information can be included
36473 in this header line by setting the &%message_id_header_text%& and/or
36474 &%message_id_header_domain%& options.
36475
36476
36477 .section "The Received: header line" "SECID227"
36478 .chindex Received:
36479 A &'Received:'& header line is added at the start of every message. The
36480 contents are defined by the &%received_header_text%& configuration option, and
36481 Exim automatically adds a semicolon and a timestamp to the configured string.
36482
36483 The &'Received:'& header is generated as soon as the message's header lines
36484 have been received. At this stage, the timestamp in the &'Received:'& header
36485 line is the time that the message started to be received. This is the value
36486 that is seen by the DATA ACL and by the &[local_scan()]& function.
36487
36488 Once a message is accepted, the timestamp in the &'Received:'& header line is
36489 changed to the time of acceptance, which is (apart from a small delay while the
36490 -H spool file is written) the earliest time at which delivery could start.
36491
36492
36493 .section "The References: header line" "SECID228"
36494 .chindex References:
36495 Messages created by the &(autoreply)& transport include a &'References:'&
36496 header line. This is constructed according to the rules that are described in
36497 section 3.64 of RFC 2822 (which states that replies should contain such a
36498 header line), and section 3.14 of RFC 3834 (which states that automatic
36499 responses are not different in this respect). However, because some mail
36500 processing software does not cope well with very long header lines, no more
36501 than 12 message IDs are copied from the &'References:'& header line in the
36502 incoming message. If there are more than 12, the first one and then the final
36503 11 are copied, before adding the message ID of the incoming message.
36504
36505
36506
36507 .section "The Return-path: header line" "SECID229"
36508 .chindex Return-path:
36509 .oindex "&%return_path_remove%&"
36510 &'Return-path:'& header lines are defined as something an MTA may insert when
36511 it does the final delivery of messages. (See the generic &%return_path_add%&
36512 transport option.) Therefore, they should not be present in messages in
36513 transit. If the &%return_path_remove%& configuration option is set (the
36514 default), Exim removes &'Return-path:'& header lines from incoming messages.
36515
36516
36517
36518 .section "The Sender: header line" "SECTthesenhea"
36519 .cindex "&'Sender:'& header line"
36520 .cindex "message" "submission"
36521 .chindex Sender:
36522 For a locally-originated message from an untrusted user, Exim may remove an
36523 existing &'Sender:'& header line, and it may add a new one. You can modify
36524 these actions by setting the &%local_sender_retain%& option true, the
36525 &%local_from_check%& option false, or by using the &%suppress_local_fixups%&
36526 control setting.
36527
36528 When a local message is received from an untrusted user and
36529 &%local_from_check%& is true (the default), and the &%suppress_local_fixups%&
36530 control has not been set, a check is made to see if the address given in the
36531 &'From:'& header line is the correct (local) sender of the message. The address
36532 that is expected has the login name as the local part and the value of
36533 &%qualify_domain%& as the domain. Prefixes and suffixes for the local part can
36534 be permitted by setting &%local_from_prefix%& and &%local_from_suffix%&
36535 appropriately. If &'From:'& does not contain the correct sender, a &'Sender:'&
36536 line is added to the message.
36537
36538 If you set &%local_from_check%& false, this checking does not occur. However,
36539 the removal of an existing &'Sender:'& line still happens, unless you also set
36540 &%local_sender_retain%& to be true. It is not possible to set both of these
36541 options true at the same time.
36542
36543 .cindex "submission mode"
36544 By default, no processing of &'Sender:'& header lines is done for messages
36545 received over TCP/IP or for messages submitted by trusted users. However, when
36546 a message is received over TCP/IP in submission mode, and &%sender_retain%& is
36547 not specified on the submission control, the following processing takes place:
36548
36549 .vindex "&$authenticated_id$&"
36550 First, any existing &'Sender:'& lines are removed. Then, if the SMTP session is
36551 authenticated, and &$authenticated_id$& is not empty, a sender address is
36552 created as follows:
36553
36554 .ilist
36555 .vindex "&$qualify_domain$&"
36556 If no domain is specified by the submission control, the local part is
36557 &$authenticated_id$& and the domain is &$qualify_domain$&.
36558 .next
36559 If a non-empty domain is specified by the submission control, the local part
36560 is &$authenticated_id$&, and the domain is the specified domain.
36561 .next
36562 If an empty domain is specified by the submission control,
36563 &$authenticated_id$& is assumed to be the complete address.
36564 .endlist
36565
36566 This address is compared with the address in the &'From:'& header line. If they
36567 are different, a &'Sender:'& header line containing the created address is
36568 added. Prefixes and suffixes for the local part in &'From:'& can be permitted
36569 by setting &%local_from_prefix%& and &%local_from_suffix%& appropriately.
36570
36571 .cindex "return path" "created from &'Sender:'&"
36572 &*Note*&: Whenever a &'Sender:'& header line is created, the return path for
36573 the message (the envelope sender address) is changed to be the same address,
36574 except in the case of submission mode when &%sender_retain%& is specified.
36575
36576
36577
36578 .section "Adding and removing header lines in routers and transports" &&&
36579          "SECTheadersaddrem"
36580 .cindex "header lines" "adding; in router or transport"
36581 .cindex "header lines" "removing; in router or transport"
36582 When a message is delivered, the addition and removal of header lines can be
36583 specified in a system filter, or on any of the routers and transports that
36584 process the message. Section &<<SECTaddremheasys>>& contains details about
36585 modifying headers in a system filter. Header lines can also be added in an ACL
36586 as a message is received (see section &<<SECTaddheadacl>>&).
36587
36588 In contrast to what happens in a system filter, header modifications that are
36589 specified on routers and transports apply only to the particular recipient
36590 addresses that are being processed by those routers and transports. These
36591 changes do not actually take place until a copy of the message is being
36592 transported. Therefore, they do not affect the basic set of header lines, and
36593 they do not affect the values of the variables that refer to header lines.
36594
36595 &*Note*&: In particular, this means that any expansions in the configuration of
36596 the transport cannot refer to the modified header lines, because such
36597 expansions all occur before the message is actually transported.
36598
36599 For both routers and transports, the argument of a &%headers_add%&
36600 option must be in the form of one or more RFC 2822 header lines, separated by
36601 newlines (coded as &"\n"&). For example:
36602 .code
36603 headers_add = X-added-header: added by $primary_hostname\n\
36604               X-added-second: another added header line
36605 .endd
36606 Exim does not check the syntax of these added header lines.
36607
36608 Multiple &%headers_add%& options for a single router or transport can be
36609 specified; the values will append to a single list of header lines.
36610 Each header-line is separately expanded.
36611
36612 The argument of a &%headers_remove%& option must consist of a colon-separated
36613 list of header names. This is confusing, because header names themselves are
36614 often terminated by colons. In this case, the colons are the list separators,
36615 not part of the names. For example:
36616 .code
36617 headers_remove = return-receipt-to:acknowledge-to
36618 .endd
36619
36620 Multiple &%headers_remove%& options for a single router or transport can be
36621 specified; the arguments will append to a single header-names list.
36622 Each item is separately expanded.
36623 Note that colons in complex expansions which are used to
36624 form all or part of a &%headers_remove%& list
36625 will act as list separators.
36626
36627 When &%headers_add%& or &%headers_remove%& is specified on a router,
36628 items are expanded at routing time,
36629 and then associated with all addresses that are
36630 accepted by that router, and also with any new addresses that it generates. If
36631 an address passes through several routers as a result of aliasing or
36632 forwarding, the changes are cumulative.
36633
36634 .oindex "&%unseen%&"
36635 However, this does not apply to multiple routers that result from the use of
36636 the &%unseen%& option. Any header modifications that were specified by the
36637 &"unseen"& router or its predecessors apply only to the &"unseen"& delivery.
36638
36639 Addresses that end up with different &%headers_add%& or &%headers_remove%&
36640 settings cannot be delivered together in a batch, so a transport is always
36641 dealing with a set of addresses that have the same header-processing
36642 requirements.
36643
36644 The transport starts by writing the original set of header lines that arrived
36645 with the message, possibly modified by the system filter. As it writes out
36646 these lines, it consults the list of header names that were attached to the
36647 recipient address(es) by &%headers_remove%& options in routers, and it also
36648 consults the transport's own &%headers_remove%& option. Header lines whose
36649 names are on either of these lists are not written out. If there are multiple
36650 instances of any listed header, they are all skipped.
36651
36652 After the remaining original header lines have been written, new header
36653 lines that were specified by routers' &%headers_add%& options are written, in
36654 the order in which they were attached to the address. These are followed by any
36655 header lines specified by the transport's &%headers_add%& option.
36656
36657 This way of handling header line modifications in routers and transports has
36658 the following consequences:
36659
36660 .ilist
36661 The original set of header lines, possibly modified by the system filter,
36662 remains &"visible"&, in the sense that the &$header_$&&'xxx'& variables refer
36663 to it, at all times.
36664 .next
36665 Header lines that are added by a router's
36666 &%headers_add%& option are not accessible by means of the &$header_$&&'xxx'&
36667 expansion syntax in subsequent routers or the transport.
36668 .next
36669 Conversely, header lines that are specified for removal by &%headers_remove%&
36670 in a router remain visible to subsequent routers and the transport.
36671 .next
36672 Headers added to an address by &%headers_add%& in a router cannot be removed by
36673 a later router or by a transport.
36674 .next
36675 An added header can refer to the contents of an original header that is to be
36676 removed, even it has the same name as the added header. For example:
36677 .code
36678 headers_remove = subject
36679 headers_add = Subject: new subject (was: $h_subject:)
36680 .endd
36681 .endlist
36682
36683 &*Warning*&: The &%headers_add%& and &%headers_remove%& options cannot be used
36684 for a &(redirect)& router that has the &%one_time%& option set.
36685
36686
36687
36688
36689
36690 .section "Constructed addresses" "SECTconstr"
36691 .cindex "address" "constructed"
36692 .cindex "constructed address"
36693 When Exim constructs a sender address for a locally-generated message, it uses
36694 the form
36695 .display
36696 <&'user name'&>&~&~<&'login'&&`@`&&'qualify_domain'&>
36697 .endd
36698 For example:
36699 .code
36700 Zaphod Beeblebrox <zaphod@end.univ.example>
36701 .endd
36702 The user name is obtained from the &%-F%& command line option if set, or
36703 otherwise by looking up the calling user by &[getpwuid()]& and extracting the
36704 &"gecos"& field from the password entry. If the &"gecos"& field contains an
36705 ampersand character, this is replaced by the login name with the first letter
36706 upper cased, as is conventional in a number of operating systems. See the
36707 &%gecos_name%& option for a way to tailor the handling of the &"gecos"& field.
36708 The &%unknown_username%& option can be used to specify user names in cases when
36709 there is no password file entry.
36710
36711 .cindex "RFC 2047"
36712 In all cases, the user name is made to conform to RFC 2822 by quoting all or
36713 parts of it if necessary. In addition, if it contains any non-printing
36714 characters, it is encoded as described in RFC 2047, which defines a way of
36715 including non-ASCII characters in header lines. The value of the
36716 &%headers_charset%& option specifies the name of the encoding that is used (the
36717 characters are assumed to be in this encoding). The setting of
36718 &%print_topbitchars%& controls whether characters with the top bit set (that
36719 is, with codes greater than 127) count as printing characters or not.
36720
36721
36722
36723 .section "Case of local parts" "SECID230"
36724 .cindex "case of local parts"
36725 .cindex "local part" "case of"
36726 RFC 2822 states that the case of letters in the local parts of addresses cannot
36727 be assumed to be non-significant. Exim preserves the case of local parts of
36728 addresses, but by default it uses a lower-cased form when it is routing,
36729 because on most Unix systems, usernames are in lower case and case-insensitive
36730 routing is required. However, any particular router can be made to use the
36731 original case for local parts by setting the &%caseful_local_part%& generic
36732 router option.
36733
36734 .cindex "mixed-case login names"
36735 If you must have mixed-case user names on your system, the best way to proceed,
36736 assuming you want case-independent handling of incoming email, is to set up
36737 your first router to convert incoming local parts in your domains to the
36738 correct case by means of a file lookup. For example:
36739 .code
36740 correct_case:
36741   driver = redirect
36742   domains = +local_domains
36743   data = ${lookup{$local_part}cdb\
36744               {/etc/usercased.cdb}{$value}fail}\
36745               @$domain
36746 .endd
36747 For this router, the local part is forced to lower case by the default action
36748 (&%caseful_local_part%& is not set). The lower-cased local part is used to look
36749 up a new local part in the correct case. If you then set &%caseful_local_part%&
36750 on any subsequent routers which process your domains, they will operate on
36751 local parts with the correct case in a case-sensitive manner.
36752
36753
36754
36755 .section "Dots in local parts" "SECID231"
36756 .cindex "dot" "in local part"
36757 .cindex "local part" "dots in"
36758 RFC 2822 forbids empty components in local parts. That is, an unquoted local
36759 part may not begin or end with a dot, nor have two consecutive dots in the
36760 middle. However, it seems that many MTAs do not enforce this, so Exim permits
36761 empty components for compatibility.
36762
36763
36764
36765 .section "Rewriting addresses" "SECID232"
36766 .cindex "rewriting" "addresses"
36767 Rewriting of sender and recipient addresses, and addresses in headers, can
36768 happen automatically, or as the result of configuration options, as described
36769 in chapter &<<CHAPrewrite>>&. The headers that may be affected by this are
36770 &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-To:'&, &'Sender:'&, and &'To:'&.
36771
36772 Automatic rewriting includes qualification, as mentioned above. The other case
36773 in which it can happen is when an incomplete non-local domain is given. The
36774 routing process may cause this to be expanded into the full domain name. For
36775 example, a header such as
36776 .code
36777 To: hare@teaparty
36778 .endd
36779 might get rewritten as
36780 .code
36781 To: hare@teaparty.wonderland.fict.example
36782 .endd
36783 Rewriting as a result of routing is the one kind of message processing that
36784 does not happen at input time, as it cannot be done until the address has
36785 been routed.
36786
36787 Strictly, one should not do &'any'& deliveries of a message until all its
36788 addresses have been routed, in case any of the headers get changed as a
36789 result of routing. However, doing this in practice would hold up many
36790 deliveries for unreasonable amounts of time, just because one address could not
36791 immediately be routed. Exim therefore does not delay other deliveries when
36792 routing of one or more addresses is deferred.
36793 .ecindex IIDmesproc
36794
36795
36796
36797 . ////////////////////////////////////////////////////////////////////////////
36798 . ////////////////////////////////////////////////////////////////////////////
36799
36800 .chapter "SMTP processing" "CHAPSMTP"
36801 .scindex IIDsmtpproc1 "SMTP" "processing details"
36802 .scindex IIDsmtpproc2 "LMTP" "processing details"
36803 Exim supports a number of different ways of using the SMTP protocol, and its
36804 LMTP variant, which is an interactive protocol for transferring messages into a
36805 closed mail store application. This chapter contains details of how SMTP is
36806 processed. For incoming mail, the following are available:
36807
36808 .ilist
36809 SMTP over TCP/IP (Exim daemon or &'inetd'&);
36810 .next
36811 SMTP over the standard input and output (the &%-bs%& option);
36812 .next
36813 Batched SMTP on the standard input (the &%-bS%& option).
36814 .endlist
36815
36816 For mail delivery, the following are available:
36817
36818 .ilist
36819 SMTP over TCP/IP (the &(smtp)& transport);
36820 .next
36821 LMTP over TCP/IP (the &(smtp)& transport with the &%protocol%& option set to
36822 &"lmtp"&);
36823 .next
36824 LMTP over a pipe to a process running in the local host (the &(lmtp)&
36825 transport);
36826 .next
36827 Batched SMTP to a file or pipe (the &(appendfile)& and &(pipe)& transports with
36828 the &%use_bsmtp%& option set).
36829 .endlist
36830
36831 &'Batched SMTP'& is the name for a process in which batches of messages are
36832 stored in or read from files (or pipes), in a format in which SMTP commands are
36833 used to contain the envelope information.
36834
36835
36836
36837 .section "Outgoing SMTP and LMTP over TCP/IP" "SECToutSMTPTCP"
36838 .cindex "SMTP" "outgoing over TCP/IP"
36839 .cindex "outgoing SMTP over TCP/IP"
36840 .cindex "LMTP" "over TCP/IP"
36841 .cindex "outgoing LMTP over TCP/IP"
36842 .cindex "EHLO"
36843 .cindex "HELO"
36844 .cindex "SIZE" "option on MAIL command"
36845 Outgoing SMTP and LMTP over TCP/IP is implemented by the &(smtp)& transport.
36846 The &%protocol%& option selects which protocol is to be used, but the actual
36847 processing is the same in both cases.
36848
36849 .cindex "ESMTP extensions" SIZE
36850 If, in response to its EHLO command, Exim is told that the SIZE
36851 extension is supported, it adds SIZE=<&'n'&> to each subsequent MAIL
36852 command. The value of <&'n'&> is the message size plus the value of the
36853 &%size_addition%& option (default 1024) to allow for additions to the message
36854 such as per-transport header lines, or changes made in a
36855 .cindex "transport" "filter"
36856 .cindex "filter" "transport filter"
36857 transport filter. If &%size_addition%& is set negative, the use of SIZE is
36858 suppressed.
36859
36860 If the remote server advertises support for PIPELINING, Exim uses the
36861 pipelining extension to SMTP (RFC 2197) to reduce the number of TCP/IP packets
36862 required for the transaction.
36863
36864 If the remote server advertises support for the STARTTLS command, and Exim
36865 was built to support TLS encryption, it tries to start a TLS session unless the
36866 server matches &%hosts_avoid_tls%&. See chapter &<<CHAPTLS>>& for more details.
36867 Either a match in that or &%hosts_verify_avoid_tls%& apply when the transport
36868 is called for verification.
36869
36870 If the remote server advertises support for the AUTH command, Exim scans
36871 the authenticators configuration for any suitable client settings, as described
36872 in chapter &<<CHAPSMTPAUTH>>&.
36873
36874 .cindex "carriage return"
36875 .cindex "linefeed"
36876 Responses from the remote host are supposed to be terminated by CR followed by
36877 LF. However, there are known to be hosts that do not send CR characters, so in
36878 order to be able to interwork with such hosts, Exim treats LF on its own as a
36879 line terminator.
36880
36881 If a message contains a number of different addresses, all those with the same
36882 characteristics (for example, the same envelope sender) that resolve to the
36883 same set of hosts, in the same order, are sent in a single SMTP transaction,
36884 even if they are for different domains, unless there are more than the setting
36885 of the &%max_rcpt%&s option in the &(smtp)& transport allows, in which case
36886 they are split into groups containing no more than &%max_rcpt%&s addresses
36887 each. If &%remote_max_parallel%& is greater than one, such groups may be sent
36888 in parallel sessions. The order of hosts with identical MX values is not
36889 significant when checking whether addresses can be batched in this way.
36890
36891 When the &(smtp)& transport suffers a temporary failure that is not
36892 message-related, Exim updates its transport-specific database, which contains
36893 records indexed by host name that remember which messages are waiting for each
36894 particular host. It also updates the retry database with new retry times.
36895
36896 .cindex "hints database" "retry keys"
36897 Exim's retry hints are based on host name plus IP address, so if one address of
36898 a multi-homed host is broken, it will soon be skipped most of the time.
36899 See the next section for more detail about error handling.
36900
36901 .cindex "SMTP" "passed connection"
36902 .cindex "SMTP" "batching over TCP/IP"
36903 When a message is successfully delivered over a TCP/IP SMTP connection, Exim
36904 looks in the hints database for the transport to see if there are any queued
36905 messages waiting for the host to which it is connected. If it finds one, it
36906 creates a new Exim process using the &%-MC%& option (which can only be used by
36907 a process running as root or the Exim user) and passes the TCP/IP socket to it
36908 so that it can deliver another message using the same socket. The new process
36909 does only those deliveries that are routed to the connected host, and may in
36910 turn pass the socket on to a third process, and so on.
36911
36912 The &%connection_max_messages%& option of the &(smtp)& transport can be used to
36913 limit the number of messages sent down a single TCP/IP connection.
36914
36915 .cindex "asterisk" "after IP address"
36916 The second and subsequent messages delivered down an existing connection are
36917 identified in the main log by the addition of an asterisk after the closing
36918 square bracket of the IP address.
36919
36920
36921
36922
36923 .section "Errors in outgoing SMTP" "SECToutSMTPerr"
36924 .cindex "error" "in outgoing SMTP"
36925 .cindex "SMTP" "errors in outgoing"
36926 .cindex "host" "error"
36927 Three different kinds of error are recognized for outgoing SMTP: host errors,
36928 message errors, and recipient errors.
36929
36930 .vlist
36931 .vitem "&*Host errors*&"
36932 A host error is not associated with a particular message or with a
36933 particular recipient of a message. The host errors are:
36934
36935 .ilist
36936 Connection refused or timed out,
36937 .next
36938 Any error response code on connection,
36939 .next
36940 Any error response code to EHLO or HELO,
36941 .next
36942 Loss of connection at any time, except after &"."&,
36943 .next
36944 I/O errors at any time,
36945 .next
36946 Timeouts during the session, other than in response to MAIL, RCPT or
36947 the &"."& at the end of the data.
36948 .endlist ilist
36949
36950 For a host error, a permanent error response on connection, or in response to
36951 EHLO, causes all addresses routed to the host to be failed. Any other host
36952 error causes all addresses to be deferred, and retry data to be created for the
36953 host. It is not tried again, for any message, until its retry time arrives. If
36954 the current set of addresses are not all delivered in this run (to some
36955 alternative host), the message is added to the list of those waiting for this
36956 host, so if it is still undelivered when a subsequent successful delivery is
36957 made to the host, it will be sent down the same SMTP connection.
36958
36959 .vitem "&*Message errors*&"
36960 .cindex "message" "error"
36961 A message error is associated with a particular message when sent to a
36962 particular host, but not with a particular recipient of the message. The
36963 message errors are:
36964
36965 .ilist
36966 Any error response code to MAIL, DATA, or the &"."& that terminates
36967 the data,
36968 .next
36969 Timeout after MAIL,
36970 .next
36971 Timeout or loss of connection after the &"."& that terminates the data. A
36972 timeout after the DATA command itself is treated as a host error, as is loss of
36973 connection at any other time.
36974 .endlist ilist
36975
36976 For a message error, a permanent error response (5&'xx'&) causes all addresses
36977 to be failed, and a delivery error report to be returned to the sender. A
36978 temporary error response (4&'xx'&), or one of the timeouts, causes all
36979 addresses to be deferred. Retry data is not created for the host, but instead,
36980 a retry record for the combination of host plus message id is created. The
36981 message is not added to the list of those waiting for this host. This ensures
36982 that the failing message will not be sent to this host again until the retry
36983 time arrives. However, other messages that are routed to the host are not
36984 affected, so if it is some property of the message that is causing the error,
36985 it will not stop the delivery of other mail.
36986
36987 If the remote host specified support for the SIZE parameter in its response
36988 to EHLO, Exim adds SIZE=&'nnn'& to the MAIL command, so an
36989 over-large message will cause a message error because the error arrives as a
36990 response to MAIL.
36991
36992 .vitem "&*Recipient errors*&"
36993 .cindex "recipient" "error"
36994 A recipient error is associated with a particular recipient of a message. The
36995 recipient errors are:
36996
36997 .ilist
36998 Any error response to RCPT,
36999 .next
37000 Timeout after RCPT.
37001 .endlist
37002
37003 For a recipient error, a permanent error response (5&'xx'&) causes the
37004 recipient address to be failed, and a bounce message to be returned to the
37005 sender. A temporary error response (4&'xx'&) or a timeout causes the failing
37006 address to be deferred, and routing retry data to be created for it. This is
37007 used to delay processing of the address in subsequent queue runs, until its
37008 routing retry time arrives. This applies to all messages, but because it
37009 operates only in queue runs, one attempt will be made to deliver a new message
37010 to the failing address before the delay starts to operate. This ensures that,
37011 if the failure is really related to the message rather than the recipient
37012 (&"message too big for this recipient"& is a possible example), other messages
37013 have a chance of getting delivered. If a delivery to the address does succeed,
37014 the retry information gets cleared, so all stuck messages get tried again, and
37015 the retry clock is reset.
37016
37017 The message is not added to the list of those waiting for this host. Use of the
37018 host for other messages is unaffected, and except in the case of a timeout,
37019 other recipients are processed independently, and may be successfully delivered
37020 in the current SMTP session. After a timeout it is of course impossible to
37021 proceed with the session, so all addresses get deferred. However, those other
37022 than the one that failed do not suffer any subsequent retry delays. Therefore,
37023 if one recipient is causing trouble, the others have a chance of getting
37024 through when a subsequent delivery attempt occurs before the failing
37025 recipient's retry time.
37026 .endlist
37027
37028 In all cases, if there are other hosts (or IP addresses) available for the
37029 current set of addresses (for example, from multiple MX records), they are
37030 tried in this run for any undelivered addresses, subject of course to their
37031 own retry data. In other words, recipient error retry data does not take effect
37032 until the next delivery attempt.
37033
37034 Some hosts have been observed to give temporary error responses to every
37035 MAIL command at certain times (&"insufficient space"& has been seen). It
37036 would be nice if such circumstances could be recognized, and defer data for the
37037 host itself created, but this is not possible within the current Exim design.
37038 What actually happens is that retry data for every (host, message) combination
37039 is created.
37040
37041 The reason that timeouts after MAIL and RCPT are treated specially is that
37042 these can sometimes arise as a result of the remote host's verification
37043 procedures. Exim makes this assumption, and treats them as if a temporary error
37044 response had been received. A timeout after &"."& is treated specially because
37045 it is known that some broken implementations fail to recognize the end of the
37046 message if the last character of the last line is a binary zero. Thus, it is
37047 helpful to treat this case as a message error.
37048
37049 Timeouts at other times are treated as host errors, assuming a problem with the
37050 host, or the connection to it. If a timeout after MAIL, RCPT,
37051 or &"."& is really a connection problem, the assumption is that at the next try
37052 the timeout is likely to occur at some other point in the dialogue, causing it
37053 then to be treated as a host error.
37054
37055 There is experimental evidence that some MTAs drop the connection after the
37056 terminating &"."& if they do not like the contents of the message for some
37057 reason, in contravention of the RFC, which indicates that a 5&'xx'& response
37058 should be given. That is why Exim treats this case as a message rather than a
37059 host error, in order not to delay other messages to the same host.
37060
37061
37062
37063
37064 .section "Incoming SMTP messages over TCP/IP" "SECID233"
37065 .cindex "SMTP" "incoming over TCP/IP"
37066 .cindex "incoming SMTP over TCP/IP"
37067 .cindex "inetd"
37068 .cindex "daemon"
37069 Incoming SMTP messages can be accepted in one of two ways: by running a
37070 listening daemon, or by using &'inetd'&. In the latter case, the entry in
37071 &_/etc/inetd.conf_& should be like this:
37072 .code
37073 smtp stream tcp nowait exim /opt/exim/bin/exim in.exim -bs
37074 .endd
37075 Exim distinguishes between this case and the case of a locally running user
37076 agent using the &%-bs%& option by checking whether or not the standard input is
37077 a socket. When it is, either the port must be privileged (less than 1024), or
37078 the caller must be root or the Exim user. If any other user passes a socket
37079 with an unprivileged port number, Exim prints a message on the standard error
37080 stream and exits with an error code.
37081
37082 By default, Exim does not make a log entry when a remote host connects or
37083 disconnects (either via the daemon or &'inetd'&), unless the disconnection is
37084 unexpected. It can be made to write such log entries by setting the
37085 &%smtp_connection%& log selector.
37086
37087 .cindex "carriage return"
37088 .cindex "linefeed"
37089 Commands from the remote host are supposed to be terminated by CR followed by
37090 LF. However, there are known to be hosts that do not send CR characters. In
37091 order to be able to interwork with such hosts, Exim treats LF on its own as a
37092 line terminator.
37093 Furthermore, because common code is used for receiving messages from all
37094 sources, a CR on its own is also interpreted as a line terminator. However, the
37095 sequence &"CR, dot, CR"& does not terminate incoming SMTP data.
37096
37097 .cindex "EHLO" "invalid data"
37098 .cindex "HELO" "invalid data"
37099 One area that sometimes gives rise to problems concerns the EHLO or
37100 HELO commands. Some clients send syntactically invalid versions of these
37101 commands, which Exim rejects by default. (This is nothing to do with verifying
37102 the data that is sent, so &%helo_verify_hosts%& is not relevant.) You can tell
37103 Exim not to apply a syntax check by setting &%helo_accept_junk_hosts%& to
37104 match the broken hosts that send invalid commands.
37105
37106 .cindex "SIZE option on MAIL command"
37107 .cindex "MAIL" "SIZE option"
37108 The amount of disk space available is checked whenever SIZE is received on
37109 a MAIL command, independently of whether &%message_size_limit%& or
37110 &%check_spool_space%& is configured, unless &%smtp_check_spool_space%& is set
37111 false. A temporary error is given if there is not enough space. If
37112 &%check_spool_space%& is set, the check is for that amount of space plus the
37113 value given with SIZE, that is, it checks that the addition of the incoming
37114 message will not reduce the space below the threshold.
37115
37116 When a message is successfully received, Exim includes the local message id in
37117 its response to the final &"."& that terminates the data. If the remote host
37118 logs this text it can help with tracing what has happened to a message.
37119
37120 The Exim daemon can limit the number of simultaneous incoming connections it is
37121 prepared to handle (see the &%smtp_accept_max%& option). It can also limit the
37122 number of simultaneous incoming connections from a single remote host (see the
37123 &%smtp_accept_max_per_host%& option). Additional connection attempts are
37124 rejected using the SMTP temporary error code 421.
37125
37126 The Exim daemon does not rely on the SIGCHLD signal to detect when a
37127 subprocess has finished, as this can get lost at busy times. Instead, it looks
37128 for completed subprocesses every time it wakes up. Provided there are other
37129 things happening (new incoming calls, starts of queue runs), completed
37130 processes will be noticed and tidied away. On very quiet systems you may
37131 sometimes see a &"defunct"& Exim process hanging about. This is not a problem;
37132 it will be noticed when the daemon next wakes up.
37133
37134 When running as a daemon, Exim can reserve some SMTP slots for specific hosts,
37135 and can also be set up to reject SMTP calls from non-reserved hosts at times of
37136 high system load &-- for details see the &%smtp_accept_reserve%&,
37137 &%smtp_load_reserve%&, and &%smtp_reserve_hosts%& options. The load check
37138 applies in both the daemon and &'inetd'& cases.
37139
37140 Exim normally starts a delivery process for each message received, though this
37141 can be varied by means of the &%-odq%& command line option and the
37142 &%queue_only%&, &%queue_only_file%&, and &%queue_only_load%& options. The
37143 number of simultaneously running delivery processes started in this way from
37144 SMTP input can be limited by the &%smtp_accept_queue%& and
37145 &%smtp_accept_queue_per_connection%& options. When either limit is reached,
37146 subsequently received messages are just put on the input queue without starting
37147 a delivery process.
37148
37149 The controls that involve counts of incoming SMTP calls (&%smtp_accept_max%&,
37150 &%smtp_accept_queue%&, &%smtp_accept_reserve%&) are not available when Exim is
37151 started up from the &'inetd'& daemon, because in that case each connection is
37152 handled by an entirely independent Exim process. Control by load average is,
37153 however, available with &'inetd'&.
37154
37155 Exim can be configured to verify addresses in incoming SMTP commands as they
37156 are received. See chapter &<<CHAPACL>>& for details. It can also be configured
37157 to rewrite addresses at this time &-- before any syntax checking is done. See
37158 section &<<SECTrewriteS>>&.
37159
37160 Exim can also be configured to limit the rate at which a client host submits
37161 MAIL and RCPT commands in a single SMTP session. See the
37162 &%smtp_ratelimit_hosts%& option.
37163
37164
37165
37166 .section "Unrecognized SMTP commands" "SECID234"
37167 .cindex "SMTP" "unrecognized commands"
37168 If Exim receives more than &%smtp_max_unknown_commands%& unrecognized SMTP
37169 commands during a single SMTP connection, it drops the connection after sending
37170 the error response to the last command. The default value for
37171 &%smtp_max_unknown_commands%& is 3. This is a defence against some kinds of
37172 abuse that subvert web servers into making connections to SMTP ports; in these
37173 circumstances, a number of non-SMTP lines are sent first.
37174
37175
37176 .section "Syntax and protocol errors in SMTP commands" "SECID235"
37177 .cindex "SMTP" "syntax errors"
37178 .cindex "SMTP" "protocol errors"
37179 A syntax error is detected if an SMTP command is recognized, but there is
37180 something syntactically wrong with its data, for example, a malformed email
37181 address in a RCPT command. Protocol errors include invalid command
37182 sequencing such as RCPT before MAIL. If Exim receives more than
37183 &%smtp_max_synprot_errors%& such commands during a single SMTP connection, it
37184 drops the connection after sending the error response to the last command. The
37185 default value for &%smtp_max_synprot_errors%& is 3. This is a defence against
37186 broken clients that loop sending bad commands (yes, it has been seen).
37187
37188
37189
37190 .section "Use of non-mail SMTP commands" "SECID236"
37191 .cindex "SMTP" "non-mail commands"
37192 The &"non-mail"& SMTP commands are those other than MAIL, RCPT, and
37193 DATA. Exim counts such commands, and drops the connection if there are too
37194 many of them in a single SMTP session. This action catches some
37195 denial-of-service attempts and things like repeated failing AUTHs, or a mad
37196 client looping sending EHLO. The global option &%smtp_accept_max_nonmail%&
37197 defines what &"too many"& means. Its default value is 10.
37198
37199 When a new message is expected, one occurrence of RSET is not counted. This
37200 allows a client to send one RSET between messages (this is not necessary,
37201 but some clients do it). Exim also allows one uncounted occurrence of HELO
37202 or EHLO, and one occurrence of STARTTLS between messages. After
37203 starting up a TLS session, another EHLO is expected, and so it too is not
37204 counted.
37205
37206 The first occurrence of AUTH in a connection, or immediately following
37207 STARTTLS is also not counted. Otherwise, all commands other than MAIL,
37208 RCPT, DATA, and QUIT are counted.
37209
37210 You can control which hosts are subject to the limit set by
37211 &%smtp_accept_max_nonmail%& by setting
37212 &%smtp_accept_max_nonmail_hosts%&. The default value is &`*`&, which makes
37213 the limit apply to all hosts. This option means that you can exclude any
37214 specific badly-behaved hosts that you have to live with.
37215
37216
37217
37218
37219 .section "The VRFY and EXPN commands" "SECID237"
37220 When Exim receives a VRFY or EXPN command on a TCP/IP connection, it
37221 runs the ACL specified by &%acl_smtp_vrfy%& or &%acl_smtp_expn%& (as
37222 appropriate) in order to decide whether the command should be accepted or not.
37223
37224 .cindex "VRFY" "processing"
37225 When no ACL is defined for VRFY, or if it rejects without
37226 setting an explicit response code, the command is accepted
37227 (with a 252 SMTP response code)
37228 in order to support awkward clients that do a VRFY before every RCPT.
37229 When VRFY is accepted, it runs exactly the same code as when Exim is
37230 called with the &%-bv%& option, and returns 250/451/550
37231 SMTP response codes.
37232
37233 .cindex "EXPN" "processing"
37234 If no ACL for EXPN is defined, the command is rejected.
37235 When EXPN is accepted, a single-level expansion of the address is done.
37236 EXPN is treated as an &"address test"& (similar to the &%-bt%& option) rather
37237 than a verification (the &%-bv%& option). If an unqualified local part is given
37238 as the argument to EXPN, it is qualified with &%qualify_domain%&. Rejections
37239 of VRFY and EXPN commands are logged on the main and reject logs, and
37240 VRFY verification failures are logged on the main log for consistency with
37241 RCPT failures.
37242
37243
37244
37245 .section "The ETRN command" "SECTETRN"
37246 .cindex "ETRN" "processing"
37247 .cindex "ESMTP extensions" ETRN
37248 RFC 1985 describes an ESMTP command called ETRN that is designed to
37249 overcome the security problems of the TURN command (which has fallen into
37250 disuse). When Exim receives an ETRN command on a TCP/IP connection, it runs
37251 the ACL specified by &%acl_smtp_etrn%& in order to decide whether the command
37252 should be accepted or not. If no ACL is defined, the command is rejected.
37253
37254 The ETRN command is concerned with &"releasing"& messages that are awaiting
37255 delivery to certain hosts. As Exim does not organize its message queue by host,
37256 the only form of ETRN that is supported by default is the one where the
37257 text starts with the &"#"& prefix, in which case the remainder of the text is
37258 specific to the SMTP server. A valid ETRN command causes a run of Exim with
37259 the &%-R%& option to happen, with the remainder of the ETRN text as its
37260 argument. For example,
37261 .code
37262 ETRN #brigadoon
37263 .endd
37264 runs the command
37265 .code
37266 exim -R brigadoon
37267 .endd
37268 which causes a delivery attempt on all messages with undelivered addresses
37269 containing the text &"brigadoon"&. When &%smtp_etrn_serialize%& is set (the
37270 default), Exim prevents the simultaneous execution of more than one queue run
37271 for the same argument string as a result of an ETRN command. This stops
37272 a misbehaving client from starting more than one queue runner at once.
37273
37274 .cindex "hints database" "ETRN serialization"
37275 Exim implements the serialization by means of a hints database in which a
37276 record is written whenever a process is started by ETRN, and deleted when
37277 the process completes. However, Exim does not keep the SMTP session waiting for
37278 the ETRN process to complete. Once ETRN is accepted, the client is sent
37279 a &"success"& return code. Obviously there is scope for hints records to get
37280 left lying around if there is a system or program crash. To guard against this,
37281 Exim ignores any records that are more than six hours old.
37282
37283 .oindex "&%smtp_etrn_command%&"
37284 For more control over what ETRN does, the &%smtp_etrn_command%& option can
37285 used. This specifies a command that is run whenever ETRN is received,
37286 whatever the form of its argument. For
37287 example:
37288 .code
37289 smtp_etrn_command = /etc/etrn_command $domain \
37290                     $sender_host_address
37291 .endd
37292 .vindex "&$domain$&"
37293 The string is split up into arguments which are independently expanded. The
37294 expansion variable &$domain$& is set to the argument of the ETRN command,
37295 and no syntax checking is done on the contents of this argument. Exim does not
37296 wait for the command to complete, so its status code is not checked. Exim runs
37297 under its own uid and gid when receiving incoming SMTP, so it is not possible
37298 for it to change them before running the command.
37299
37300
37301
37302 .section "Incoming local SMTP" "SECID238"
37303 .cindex "SMTP" "local incoming"
37304 Some user agents use SMTP to pass messages to their local MTA using the
37305 standard input and output, as opposed to passing the envelope on the command
37306 line and writing the message to the standard input. This is supported by the
37307 &%-bs%& option. This form of SMTP is handled in the same way as incoming
37308 messages over TCP/IP (including the use of ACLs), except that the envelope
37309 sender given in a MAIL command is ignored unless the caller is trusted. In
37310 an ACL you can detect this form of SMTP input by testing for an empty host
37311 identification. It is common to have this as the first line in the ACL that
37312 runs for RCPT commands:
37313 .code
37314 accept hosts = :
37315 .endd
37316 This accepts SMTP messages from local processes without doing any other tests.
37317
37318
37319
37320 .section "Outgoing batched SMTP" "SECTbatchSMTP"
37321 .cindex "SMTP" "batched outgoing"
37322 .cindex "batched SMTP output"
37323 Both the &(appendfile)& and &(pipe)& transports can be used for handling
37324 batched SMTP. Each has an option called &%use_bsmtp%& which causes messages to
37325 be output in BSMTP format. No SMTP responses are possible for this form of
37326 delivery. All it is doing is using SMTP commands as a way of transmitting the
37327 envelope along with the message.
37328
37329 The message is written to the file or pipe preceded by the SMTP commands
37330 MAIL and RCPT, and followed by a line containing a single dot. Lines in
37331 the message that start with a dot have an extra dot added. The SMTP command
37332 HELO is not normally used. If it is required, the &%message_prefix%& option
37333 can be used to specify it.
37334
37335 Because &(appendfile)& and &(pipe)& are both local transports, they accept only
37336 one recipient address at a time by default. However, you can arrange for them
37337 to handle several addresses at once by setting the &%batch_max%& option. When
37338 this is done for BSMTP, messages may contain multiple RCPT commands. See
37339 chapter &<<CHAPbatching>>& for more details.
37340
37341 .vindex "&$host$&"
37342 When one or more addresses are routed to a BSMTP transport by a router that
37343 sets up a host list, the name of the first host on the list is available to the
37344 transport in the variable &$host$&. Here is an example of such a transport and
37345 router:
37346 .code
37347 begin routers
37348 route_append:
37349   driver = manualroute
37350   transport = smtp_appendfile
37351   route_list = domain.example  batch.host.example
37352
37353 begin transports
37354 smtp_appendfile:
37355   driver = appendfile
37356   directory = /var/bsmtp/$host
37357   batch_max = 1000
37358   use_bsmtp
37359   user = exim
37360 .endd
37361 This causes messages addressed to &'domain.example'& to be written in BSMTP
37362 format to &_/var/bsmtp/batch.host.example_&, with only a single copy of each
37363 message (unless there are more than 1000 recipients).
37364
37365
37366
37367 .section "Incoming batched SMTP" "SECTincomingbatchedSMTP"
37368 .cindex "SMTP" "batched incoming"
37369 .cindex "batched SMTP input"
37370 The &%-bS%& command line option causes Exim to accept one or more messages by
37371 reading SMTP on the standard input, but to generate no responses. If the caller
37372 is trusted, the senders in the MAIL commands are believed; otherwise the
37373 sender is always the caller of Exim. Unqualified senders and receivers are not
37374 rejected (there seems little point) but instead just get qualified. HELO
37375 and EHLO act as RSET; VRFY, EXPN, ETRN and  HELP, act
37376 as NOOP; QUIT quits.
37377
37378 Minimal policy checking is done for BSMTP input. Only the non-SMTP
37379 ACL is run in the same way as for non-SMTP local input.
37380
37381 If an error is detected while reading a message, including a missing &"."& at
37382 the end, Exim gives up immediately. It writes details of the error to the
37383 standard output in a stylized way that the calling program should be able to
37384 make some use of automatically, for example:
37385 .code
37386 554 Unexpected end of file
37387 Transaction started in line 10
37388 Error detected in line 14
37389 .endd
37390 It writes a more verbose version, for human consumption, to the standard error
37391 file, for example:
37392 .code
37393 An error was detected while processing a file of BSMTP input.
37394 The error message was:
37395
37396 501 '>' missing at end of address
37397
37398 The SMTP transaction started in line 10.
37399 The error was detected in line 12.
37400 The SMTP command at fault was:
37401
37402 rcpt to:<malformed@in.com.plete
37403
37404 1 previous message was successfully processed.
37405 The rest of the batch was abandoned.
37406 .endd
37407 The return code from Exim is zero only if there were no errors. It is 1 if some
37408 messages were accepted before an error was detected, and 2 if no messages were
37409 accepted.
37410 .ecindex IIDsmtpproc1
37411 .ecindex IIDsmtpproc2
37412
37413
37414
37415 . ////////////////////////////////////////////////////////////////////////////
37416 . ////////////////////////////////////////////////////////////////////////////
37417
37418 .chapter "Customizing bounce and warning messages" "CHAPemsgcust" &&&
37419          "Customizing messages"
37420 When a message fails to be delivered, or remains in the queue for more than a
37421 configured amount of time, Exim sends a message to the original sender, or
37422 to an alternative configured address. The text of these messages is built into
37423 the code of Exim, but it is possible to change it, either by adding a single
37424 string, or by replacing each of the paragraphs by text supplied in a file.
37425
37426 The &'From:'& and &'To:'& header lines are automatically generated; you can
37427 cause a &'Reply-To:'& line to be added by setting the &%errors_reply_to%&
37428 option. Exim also adds the line
37429 .code
37430 Auto-Submitted: auto-generated
37431 .endd
37432 to all warning and bounce messages,
37433
37434
37435 .section "Customizing bounce messages" "SECID239"
37436 .cindex "customizing" "bounce message"
37437 .cindex "bounce message" "customizing"
37438 If &%bounce_message_text%& is set, its contents are included in the default
37439 message immediately after &"This message was created automatically by mail
37440 delivery software."& The string is not expanded. It is not used if
37441 &%bounce_message_file%& is set.
37442
37443 When &%bounce_message_file%& is set, it must point to a template file for
37444 constructing error messages. The file consists of a series of text items,
37445 separated by lines consisting of exactly four asterisks. If the file cannot be
37446 opened, default text is used and a message is written to the main and panic
37447 logs. If any text item in the file is empty, default text is used for that
37448 item.
37449
37450 .vindex "&$bounce_recipient$&"
37451 .vindex "&$bounce_return_size_limit$&"
37452 Each item of text that is read from the file is expanded, and there are two
37453 expansion variables which can be of use here: &$bounce_recipient$& is set to
37454 the recipient of an error message while it is being created, and
37455 &$bounce_return_size_limit$& contains the value of the &%return_size_limit%&
37456 option, rounded to a whole number.
37457
37458 The items must appear in the file in the following order:
37459
37460 .ilist
37461 The first item is included in the headers, and should include at least a
37462 &'Subject:'& header. Exim does not check the syntax of these headers.
37463 .next
37464 The second item forms the start of the error message. After it, Exim lists the
37465 failing addresses with their error messages.
37466 .next
37467 The third item is used to introduce any text from pipe transports that is to be
37468 returned to the sender. It is omitted if there is no such text.
37469 .next
37470 The fourth, fifth and sixth items will be ignored and may be empty.
37471 The fields exist for back-compatibility
37472 .endlist
37473
37474 The default state (&%bounce_message_file%& unset) is equivalent to the
37475 following file, in which the sixth item is empty. The &'Subject:'& and some
37476 other lines have been split in order to fit them on the page:
37477 .code
37478 Subject: Mail delivery failed
37479   ${if eq{$sender_address}{$bounce_recipient}
37480   {: returning message to sender}}
37481 ****
37482 This message was created automatically by mail delivery software.
37483
37484 A message ${if eq{$sender_address}{$bounce_recipient}
37485   {that you sent }{sent by
37486
37487 <$sender_address>
37488
37489 }}could not be delivered to all of its recipients.
37490 This is a permanent error. The following address(es) failed:
37491 ****
37492 The following text was generated during the delivery attempt(s):
37493 ****
37494 ------ This is a copy of the message, including all the headers.
37495   ------
37496 ****
37497 ------ The body of the message is $message_size characters long;
37498   only the first
37499 ------ $bounce_return_size_limit or so are included here.
37500 ****
37501 .endd
37502 .section "Customizing warning messages" "SECTcustwarn"
37503 .cindex "customizing" "warning message"
37504 .cindex "warning of delay" "customizing the message"
37505 The option &%warn_message_file%& can be pointed at a template file for use when
37506 warnings about message delays are created. In this case there are only three
37507 text sections:
37508
37509 .ilist
37510 The first item is included in the headers, and should include at least a
37511 &'Subject:'& header. Exim does not check the syntax of these headers.
37512 .next
37513 The second item forms the start of the warning message. After it, Exim lists
37514 the delayed addresses.
37515 .next
37516 The third item then ends the message.
37517 .endlist
37518
37519 The default state is equivalent to the following file, except that some lines
37520 have been split here, in order to fit them on the page:
37521 .code
37522 Subject: Warning: message $message_exim_id delayed
37523   $warn_message_delay
37524 ****
37525 This message was created automatically by mail delivery software.
37526
37527 A message ${if eq{$sender_address}{$warn_message_recipients}
37528 {that you sent }{sent by
37529
37530 <$sender_address>
37531
37532 }}has not been delivered to all of its recipients after
37533 more than $warn_message_delay in the queue on $primary_hostname.
37534
37535 The message identifier is:     $message_exim_id
37536 The subject of the message is: $h_subject
37537 The date of the message is:    $h_date
37538
37539 The following address(es) have not yet been delivered:
37540 ****
37541 No action is required on your part. Delivery attempts will
37542 continue for some time, and this warning may be repeated at
37543 intervals if the message remains undelivered. Eventually the
37544 mail delivery software will give up, and when that happens,
37545 the message will be returned to you.
37546 .endd
37547 .vindex "&$warn_message_delay$&"
37548 .vindex "&$warn_message_recipients$&"
37549 However, in the default state the subject and date lines are omitted if no
37550 appropriate headers exist. During the expansion of this file,
37551 &$warn_message_delay$& is set to the delay time in one of the forms &"<&'n'&>
37552 minutes"& or &"<&'n'&> hours"&, and &$warn_message_recipients$& contains a list
37553 of recipients for the warning message. There may be more than one if there are
37554 multiple addresses with different &%errors_to%& settings on the routers that
37555 handled them.
37556
37557
37558
37559
37560 . ////////////////////////////////////////////////////////////////////////////
37561 . ////////////////////////////////////////////////////////////////////////////
37562
37563 .chapter "Some common configuration settings" "CHAPcomconreq"
37564 This chapter discusses some configuration settings that seem to be fairly
37565 common. More examples and discussion can be found in the Exim book.
37566
37567
37568
37569 .section "Sending mail to a smart host" "SECID240"
37570 .cindex "smart host" "example router"
37571 If you want to send all mail for non-local domains to a &"smart host"&, you
37572 should replace the default &(dnslookup)& router with a router which does the
37573 routing explicitly:
37574 .code
37575 send_to_smart_host:
37576   driver = manualroute
37577   route_list = !+local_domains smart.host.name
37578   transport = remote_smtp
37579 .endd
37580 You can use the smart host's IP address instead of the name if you wish.
37581 If you are using Exim only to submit messages to a smart host, and not for
37582 receiving incoming messages, you can arrange for it to do the submission
37583 synchronously by setting the &%mua_wrapper%& option (see chapter
37584 &<<CHAPnonqueueing>>&).
37585
37586
37587
37588
37589 .section "Using Exim to handle mailing lists" "SECTmailinglists"
37590 .cindex "mailing lists"
37591 Exim can be used to run simple mailing lists, but for large and/or complicated
37592 requirements, the use of additional specialized mailing list software such as
37593 Majordomo or Mailman is recommended.
37594
37595 The &(redirect)& router can be used to handle mailing lists where each list
37596 is maintained in a separate file, which can therefore be managed by an
37597 independent manager. The &%domains%& router option can be used to run these
37598 lists in a separate domain from normal mail. For example:
37599 .code
37600 lists:
37601   driver = redirect
37602   domains = lists.example
37603   file = ${lookup {$local_part} dsearch,ret=full {/usr/lists}}
37604   forbid_pipe
37605   forbid_file
37606   errors_to = ${quote_local_part:$local_part-request}@lists.example
37607   no_more
37608 .endd
37609 This router is skipped for domains other than &'lists.example'&. For addresses
37610 in that domain, it looks for a file that matches the local part. If there is no
37611 such file, the router declines, but because &%no_more%& is set, no subsequent
37612 routers are tried, and so the whole delivery fails.
37613
37614 The &%forbid_pipe%& and &%forbid_file%& options prevent a local part from being
37615 expanded into a filename or a pipe delivery, which is usually inappropriate in
37616 a mailing list.
37617
37618 .oindex "&%errors_to%&"
37619 The &%errors_to%& option specifies that any delivery errors caused by addresses
37620 taken from a mailing list are to be sent to the given address rather than the
37621 original sender of the message. However, before acting on this, Exim verifies
37622 the error address, and ignores it if verification fails.
37623
37624 For example, using the configuration above, mail sent to
37625 &'dicts@lists.example'& is passed on to those addresses contained in
37626 &_/usr/lists/dicts_&, with error reports directed to
37627 &'dicts-request@lists.example'&, provided that this address can be verified.
37628 There could be a file called &_/usr/lists/dicts-request_& containing
37629 the address(es) of this particular list's manager(s), but other approaches,
37630 such as setting up an earlier router (possibly using the &%local_part_prefix%&
37631 or &%local_part_suffix%& options) to handle addresses of the form
37632 &%owner-%&&'xxx'& or &%xxx-%&&'request'&, are also possible.
37633
37634
37635
37636 .section "Syntax errors in mailing lists" "SECID241"
37637 .cindex "mailing lists" "syntax errors in"
37638 If an entry in redirection data contains a syntax error, Exim normally defers
37639 delivery of the original address. That means that a syntax error in a mailing
37640 list holds up all deliveries to the list. This may not be appropriate when a
37641 list is being maintained automatically from data supplied by users, and the
37642 addresses are not rigorously checked.
37643
37644 If the &%skip_syntax_errors%& option is set, the &(redirect)& router just skips
37645 entries that fail to parse, noting the incident in the log. If in addition
37646 &%syntax_errors_to%& is set to a verifiable address, a message is sent to it
37647 whenever a broken address is skipped. It is usually appropriate to set
37648 &%syntax_errors_to%& to the same address as &%errors_to%&.
37649
37650
37651
37652 .section "Re-expansion of mailing lists" "SECID242"
37653 .cindex "mailing lists" "re-expansion of"
37654 Exim remembers every individual address to which a message has been delivered,
37655 in order to avoid duplication, but it normally stores only the original
37656 recipient addresses with a message. If all the deliveries to a mailing list
37657 cannot be done at the first attempt, the mailing list is re-expanded when the
37658 delivery is next tried. This means that alterations to the list are taken into
37659 account at each delivery attempt, so addresses that have been added to
37660 the list since the message arrived will therefore receive a copy of the
37661 message, even though it pre-dates their subscription.
37662
37663 If this behaviour is felt to be undesirable, the &%one_time%& option can be set
37664 on the &(redirect)& router. If this is done, any addresses generated by the
37665 router that fail to deliver at the first attempt are added to the message as
37666 &"top level"& addresses, and the parent address that generated them is marked
37667 &"delivered"&. Thus, expansion of the mailing list does not happen again at the
37668 subsequent delivery attempts. The disadvantage of this is that if any of the
37669 failing addresses are incorrect, correcting them in the file has no effect on
37670 pre-existing messages.
37671
37672 The original top-level address is remembered with each of the generated
37673 addresses, and is output in any log messages. However, any intermediate parent
37674 addresses are not recorded. This makes a difference to the log only if the
37675 &%all_parents%& selector is set, but for mailing lists there is normally only
37676 one level of expansion anyway.
37677
37678
37679
37680 .section "Closed mailing lists" "SECID243"
37681 .cindex "mailing lists" "closed"
37682 The examples so far have assumed open mailing lists, to which anybody may
37683 send mail. It is also possible to set up closed lists, where mail is accepted
37684 from specified senders only. This is done by making use of the generic
37685 &%senders%& option to restrict the router that handles the list.
37686
37687 The following example uses the same file as a list of recipients and as a list
37688 of permitted senders. It requires three routers:
37689 .code
37690 lists_request:
37691   driver = redirect
37692   domains = lists.example
37693   local_part_suffix = -request
37694   local_parts = ${lookup {$local_part} dsearch,filter=file {/usr/lists}}
37695   file = /usr/lists/${local_part_data}-request
37696   no_more
37697
37698 lists_post:
37699   driver = redirect
37700   domains = lists.example
37701   senders = ${if exists {/usr/lists/$local_part}\
37702              {lsearch;/usr/lists/$local_part}{*}}
37703   file = ${lookup {$local_part} dsearch,ret=full {/usr/lists}}
37704   forbid_pipe
37705   forbid_file
37706   errors_to = ${quote_local_part:$local_part-request}@lists.example
37707   no_more
37708
37709 lists_closed:
37710   driver = redirect
37711   domains = lists.example
37712   allow_fail
37713   data = :fail: $local_part@lists.example is a closed mailing list
37714 .endd
37715 All three routers have the same &%domains%& setting, so for any other domains,
37716 they are all skipped. The first router runs only if the local part ends in
37717 &%-request%&. It handles messages to the list manager(s) by means of an open
37718 mailing list.
37719
37720 The second router runs only if the &%senders%& precondition is satisfied. It
37721 checks for the existence of a list that corresponds to the local part, and then
37722 checks that the sender is on the list by means of a linear search. It is
37723 necessary to check for the existence of the file before trying to search it,
37724 because otherwise Exim thinks there is a configuration error. If the file does
37725 not exist, the expansion of &%senders%& is *, which matches all senders. This
37726 means that the router runs, but because there is no list, declines, and
37727 &%no_more%& ensures that no further routers are run. The address fails with an
37728 &"unrouteable address"& error.
37729
37730 The third router runs only if the second router is skipped, which happens when
37731 a mailing list exists, but the sender is not on it. This router forcibly fails
37732 the address, giving a suitable error message.
37733
37734
37735
37736
37737 .section "Variable Envelope Return Paths (VERP)" "SECTverp"
37738 .cindex "VERP"
37739 .cindex "Variable Envelope Return Paths"
37740 .cindex "envelope from"
37741 .cindex "envelope sender"
37742 Variable Envelope Return Paths &-- see &url(https://cr.yp.to/proto/verp.txt) &--
37743 are a way of helping mailing list administrators discover which subscription
37744 address is the cause of a particular delivery failure. The idea is to encode
37745 the original recipient address in the outgoing envelope sender address, so that
37746 if the message is forwarded by another host and then subsequently bounces, the
37747 original recipient can be extracted from the recipient address of the bounce.
37748
37749 .oindex &%errors_to%&
37750 .oindex &%return_path%&
37751 Envelope sender addresses can be modified by Exim using two different
37752 facilities: the &%errors_to%& option on a router (as shown in previous mailing
37753 list examples), or the &%return_path%& option on a transport. The second of
37754 these is effective only if the message is successfully delivered to another
37755 host; it is not used for errors detected on the local host (see the description
37756 of &%return_path%& in chapter &<<CHAPtransportgeneric>>&). Here is an example
37757 of the use of &%return_path%& to implement VERP on an &(smtp)& transport:
37758 .code
37759 verp_smtp:
37760   driver = smtp
37761   max_rcpt = 1
37762   return_path = \
37763     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
37764       {${quote_local_part:$1-request+$local_part=$domain}@your.dom.example}fail}
37765 .endd
37766 This has the effect of rewriting the return path (envelope sender) on outgoing
37767 SMTP messages, if the local part of the original return path ends in
37768 &"-request"&, and the domain is &'your.dom.example'&. The rewriting inserts the
37769 local part and domain of the recipient into the return path. Suppose, for
37770 example, that a message whose return path has been set to
37771 &'somelist-request@your.dom.example'& is sent to
37772 &'subscriber@other.dom.example'&. In the transport, the return path is
37773 rewritten as
37774 .code
37775 somelist-request+subscriber=other.dom.example@your.dom.example
37776 .endd
37777 .vindex "&$local_part$&"
37778 For this to work, you must tell Exim to send multiple copies of messages that
37779 have more than one recipient, so that each copy has just one recipient. This is
37780 achieved by setting &%max_rcpt%& to 1. Without this, a single copy of a message
37781 might be sent to several different recipients in the same domain, in which case
37782 &$local_part$& is not available in the transport, because it is not unique.
37783
37784 Unless your host is doing nothing but mailing list deliveries, you should
37785 probably use a separate transport for the VERP deliveries, so as not to use
37786 extra resources in making one-per-recipient copies for other deliveries. This
37787 can easily be done by expanding the &%transport%& option in the router:
37788 .code
37789 dnslookup:
37790   driver = dnslookup
37791   domains = ! +local_domains
37792   transport = \
37793     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
37794       {verp_smtp}{remote_smtp}}
37795   no_more
37796 .endd
37797 If you want to change the return path using &%errors_to%& in a router instead
37798 of using &%return_path%& in the transport, you need to set &%errors_to%& on all
37799 routers that handle mailing list addresses. This will ensure that all delivery
37800 errors, including those detected on the local host, are sent to the VERP
37801 address.
37802
37803 On a host that does no local deliveries and has no manual routing, only the
37804 &(dnslookup)& router needs to be changed. A special transport is not needed for
37805 SMTP deliveries. Every mailing list recipient has its own return path value,
37806 and so Exim must hand them to the transport one at a time. Here is an example
37807 of a &(dnslookup)& router that implements VERP:
37808 .code
37809 verp_dnslookup:
37810   driver = dnslookup
37811   domains = ! +local_domains
37812   transport = remote_smtp
37813   errors_to = \
37814     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}}
37815      {${quote_local_part:$1-request+$local_part=$domain}@your.dom.example}fail}
37816   no_more
37817 .endd
37818 Before you start sending out messages with VERPed return paths, you must also
37819 configure Exim to accept the bounce messages that come back to those paths.
37820 Typically this is done by setting a &%local_part_suffix%& option for a
37821 router, and using this to route the messages to wherever you want to handle
37822 them.
37823
37824 The overhead incurred in using VERP depends very much on the size of the
37825 message, the number of recipient addresses that resolve to the same remote
37826 host, and the speed of the connection over which the message is being sent. If
37827 a lot of addresses resolve to the same host and the connection is slow, sending
37828 a separate copy of the message for each address may take substantially longer
37829 than sending a single copy with many recipients (for which VERP cannot be
37830 used).
37831
37832
37833
37834
37835
37836
37837 .section "Virtual domains" "SECTvirtualdomains"
37838 .cindex "virtual domains"
37839 .cindex "domain" "virtual"
37840 The phrase &'virtual domain'& is unfortunately used with two rather different
37841 meanings:
37842
37843 .ilist
37844 A domain for which there are no real mailboxes; all valid local parts are
37845 aliases for other email addresses. Common examples are organizational
37846 top-level domains and &"vanity"& domains.
37847 .next
37848 One of a number of independent domains that are all handled by the same host,
37849 with mailboxes on that host, but where the mailbox owners do not necessarily
37850 have login accounts on that host.
37851 .endlist
37852
37853 The first usage is probably more common, and does seem more &"virtual"& than
37854 the second. This kind of domain can be handled in Exim with a straightforward
37855 aliasing router. One approach is to create a separate alias file for each
37856 virtual domain. Exim can test for the existence of the alias file to determine
37857 whether the domain exists. The &(dsearch)& lookup type is useful here, leading
37858 to a router of this form:
37859 .code
37860 virtual:
37861   driver = redirect
37862   domains = dsearch;/etc/mail/virtual
37863   data = ${lookup{$local_part}lsearch{/etc/mail/virtual/$domain_data}}
37864   no_more
37865 .endd
37866 The &%domains%& option specifies that the router is to be skipped, unless there
37867 is a file in the &_/etc/mail/virtual_& directory whose name is the same as the
37868 domain that is being processed.
37869 The &(dsearch)& lookup used results in an untainted version of &$domain$&
37870 being placed into the &$domain_data$& variable.
37871
37872 When the router runs, it looks up the local
37873 part in the file to find a new address (or list of addresses). The &%no_more%&
37874 setting ensures that if the lookup fails (leading to &%data%& being an empty
37875 string), Exim gives up on the address without trying any subsequent routers.
37876
37877 This one router can handle all the virtual domains because the alias filenames
37878 follow a fixed pattern. Permissions can be arranged so that appropriate people
37879 can edit the different alias files. A successful aliasing operation results in
37880 a new envelope recipient address, which is then routed from scratch.
37881
37882 The other kind of &"virtual"& domain can also be handled in a straightforward
37883 way. One approach is to create a file for each domain containing a list of
37884 valid local parts, and use it in a router like this:
37885 .code
37886 my_domains:
37887   driver = accept
37888   domains = dsearch;/etc/mail/domains
37889   local_parts = lsearch;/etc/mail/domains/$domain
37890   transport = my_mailboxes
37891 .endd
37892 The address is accepted if there is a file for the domain, and the local part
37893 can be found in the file. The &%domains%& option is used to check for the
37894 file's existence because &%domains%& is tested before the &%local_parts%&
37895 option (see section &<<SECTrouprecon>>&). You cannot use &%require_files%&,
37896 because that option is tested after &%local_parts%&. The transport is as
37897 follows:
37898 .code
37899 my_mailboxes:
37900   driver = appendfile
37901   file = /var/mail/$domain_data/$local_part_data
37902   user = mail
37903 .endd
37904 This uses a directory of mailboxes for each domain. The &%user%& setting is
37905 required, to specify which uid is to be used for writing to the mailboxes.
37906
37907 The configuration shown here is just one example of how you might support this
37908 requirement. There are many other ways this kind of configuration can be set
37909 up, for example, by using a database instead of separate files to hold all the
37910 information about the domains.
37911
37912
37913
37914 .section "Multiple user mailboxes" "SECTmulbox"
37915 .cindex "multiple mailboxes"
37916 .cindex "mailbox" "multiple"
37917 .cindex "local part" "prefix"
37918 .cindex "local part" "suffix"
37919 Heavy email users often want to operate with multiple mailboxes, into which
37920 incoming mail is automatically sorted. A popular way of handling this is to
37921 allow users to use multiple sender addresses, so that replies can easily be
37922 identified. Users are permitted to add prefixes or suffixes to their local
37923 parts for this purpose. The wildcard facility of the generic router options
37924 &%local_part_prefix%& and &%local_part_suffix%& can be used for this. For
37925 example, consider this router:
37926 .code
37927 userforward:
37928   driver = redirect
37929   check_local_user
37930   file = $home/.forward
37931   local_part_suffix = -*
37932   local_part_suffix_optional
37933   allow_filter
37934 .endd
37935 .vindex "&$local_part_suffix$&"
37936 It runs a user's &_.forward_& file for all local parts of the form
37937 &'username-*'&. Within the filter file the user can distinguish different
37938 cases by testing the variable &$local_part_suffix$&. For example:
37939 .code
37940 if $local_part_suffix contains -special then
37941 save /home/$local_part_data/Mail/special
37942 endif
37943 .endd
37944 If the filter file does not exist, or does not deal with such addresses, they
37945 fall through to subsequent routers, and, assuming no subsequent use of the
37946 &%local_part_suffix%& option is made, they presumably fail. Thus, users have
37947 control over which suffixes are valid.
37948
37949 Alternatively, a suffix can be used to trigger the use of a different
37950 &_.forward_& file &-- which is the way a similar facility is implemented in
37951 another MTA:
37952 .code
37953 userforward:
37954   driver = redirect
37955   check_local_user
37956   local_part_suffix = -*
37957   local_part_suffix_optional
37958   file = ${lookup {.forward$local_part_suffix} dsearch,ret=full {$home} {$value}fail}
37959   allow_filter
37960 .endd
37961 If there is no suffix, &_.forward_& is used; if the suffix is &'-special'&, for
37962 example, &_.forward-special_& is used. Once again, if the appropriate file
37963 does not exist, or does not deal with the address, it is passed on to
37964 subsequent routers, which could, if required, look for an unqualified
37965 &_.forward_& file to use as a default.
37966
37967
37968
37969 .section "Simplified vacation processing" "SECID244"
37970 .cindex "vacation processing"
37971 The traditional way of running the &'vacation'& program is for a user to set up
37972 a pipe command in a &_.forward_& file
37973 (see section &<<SECTspecitredli>>& for syntax details).
37974 This is prone to error by inexperienced users. There are two features of Exim
37975 that can be used to make this process simpler for users:
37976
37977 .ilist
37978 A local part prefix such as &"vacation-"& can be specified on a router which
37979 can cause the message to be delivered directly to the &'vacation'& program, or
37980 alternatively can use Exim's &(autoreply)& transport. The contents of a user's
37981 &_.forward_& file are then much simpler. For example:
37982 .code
37983 spqr, vacation-spqr
37984 .endd
37985 .next
37986 The &%require_files%& generic router option can be used to trigger a
37987 vacation delivery by checking for the existence of a certain file in the
37988 user's home directory. The &%unseen%& generic option should also be used, to
37989 ensure that the original delivery also proceeds. In this case, all the user has
37990 to do is to create a file called, say, &_.vacation_&, containing a vacation
37991 message.
37992 .endlist
37993
37994 Another advantage of both these methods is that they both work even when the
37995 use of arbitrary pipes by users is locked out.
37996
37997
37998
37999 .section "Taking copies of mail" "SECID245"
38000 .cindex "message" "copying every"
38001 Some installations have policies that require archive copies of all messages to
38002 be made. A single copy of each message can easily be taken by an appropriate
38003 command in a system filter, which could, for example, use a different file for
38004 each day's messages.
38005
38006 There is also a shadow transport mechanism that can be used to take copies of
38007 messages that are successfully delivered by local transports, one copy per
38008 delivery. This could be used, &'inter alia'&, to implement automatic
38009 notification of delivery by sites that insist on doing such things.
38010
38011
38012
38013 .section "Intermittently connected hosts" "SECID246"
38014 .cindex "intermittently connected hosts"
38015 It has become quite common (because it is cheaper) for hosts to connect to the
38016 Internet periodically rather than remain connected all the time. The normal
38017 arrangement is that mail for such hosts accumulates on a system that is
38018 permanently connected.
38019
38020 Exim was designed for use on permanently connected hosts, and so it is not
38021 particularly well-suited to use in an intermittently connected environment.
38022 Nevertheless there are some features that can be used.
38023
38024
38025 .section "Exim on the upstream server host" "SECID247"
38026 It is tempting to arrange for incoming mail for the intermittently connected
38027 host to remain in Exim's queue until the client connects. However, this
38028 approach does not scale very well. Two different kinds of waiting message are
38029 being mixed up in the same queue &-- those that cannot be delivered because of
38030 some temporary problem, and those that are waiting for their destination host
38031 to connect. This makes it hard to manage the queue, as well as wasting
38032 resources, because each queue runner scans the entire queue.
38033
38034 A better approach is to separate off those messages that are waiting for an
38035 intermittently connected host. This can be done by delivering these messages
38036 into local files in batch SMTP, &"mailstore"&, or other envelope-preserving
38037 format, from where they are transmitted by other software when their
38038 destination connects. This makes it easy to collect all the mail for one host
38039 in a single directory, and to apply local timeout rules on a per-message basis
38040 if required.
38041
38042 On a very small scale, leaving the mail on Exim's queue can be made to work. If
38043 you are doing this, you should configure Exim with a long retry period for the
38044 intermittent host. For example:
38045 .code
38046 cheshire.wonderland.fict.example    *   F,5d,24h
38047 .endd
38048 This stops a lot of failed delivery attempts from occurring, but Exim remembers
38049 which messages it has queued up for that host. Once the intermittent host comes
38050 online, forcing delivery of one message (either by using the &%-M%& or &%-R%&
38051 options, or by using the ETRN SMTP command (see section &<<SECTETRN>>&)
38052 causes all the queued up messages to be delivered, often down a single SMTP
38053 connection. While the host remains connected, any new messages get delivered
38054 immediately.
38055
38056 If the connecting hosts do not have fixed IP addresses, that is, if a host is
38057 issued with a different IP address each time it connects, Exim's retry
38058 mechanisms on the holding host get confused, because the IP address is normally
38059 used as part of the key string for holding retry information. This can be
38060 avoided by unsetting &%retry_include_ip_address%& on the &(smtp)& transport.
38061 Since this has disadvantages for permanently connected hosts, it is best to
38062 arrange a separate transport for the intermittently connected ones.
38063
38064
38065
38066 .section "Exim on the intermittently connected client host" "SECID248"
38067 The value of &%smtp_accept_queue_per_connection%& should probably be
38068 increased, or even set to zero (that is, disabled) on the intermittently
38069 connected host, so that all incoming messages down a single connection get
38070 delivered immediately.
38071
38072 .cindex "SMTP" "passed connection"
38073 .cindex "SMTP" "multiple deliveries"
38074 .cindex "multiple SMTP deliveries"
38075 .cindex "first pass routing"
38076 Mail waiting to be sent from an intermittently connected host will probably
38077 not have been routed, because without a connection DNS lookups are not
38078 possible. This means that if a normal queue run is done at connection time,
38079 each message is likely to be sent in a separate SMTP session. This can be
38080 avoided by starting the queue run with a command line option beginning with
38081 &%-qq%& instead of &%-q%&. In this case, the queue is scanned twice. In the
38082 first pass, routing is done but no deliveries take place. The second pass is a
38083 normal queue run; since all the messages have been previously routed, those
38084 destined for the same host are likely to get sent as multiple deliveries in a
38085 single SMTP connection.
38086
38087
38088
38089 . ////////////////////////////////////////////////////////////////////////////
38090 . ////////////////////////////////////////////////////////////////////////////
38091
38092 .chapter "Using Exim as a non-queueing client" "CHAPnonqueueing" &&&
38093          "Exim as a non-queueing client"
38094 .cindex "client, non-queueing"
38095 .cindex "smart host" "suppressing queueing"
38096 On a personal computer, it is a common requirement for all
38097 email to be sent to a &"smart host"&. There are plenty of MUAs that can be
38098 configured to operate that way, for all the popular operating systems.
38099 However, there are some MUAs for Unix-like systems that cannot be so
38100 configured: they submit messages using the command line interface of
38101 &_/usr/sbin/sendmail_&. Furthermore, utility programs such as &'cron'& submit
38102 messages this way.
38103
38104 If the personal computer runs continuously, there is no problem, because it can
38105 run a conventional MTA that handles delivery to the smart host, and deal with
38106 any delays via its queueing mechanism. However, if the computer does not run
38107 continuously or runs different operating systems at different times, queueing
38108 email is not desirable.
38109
38110 There is therefore a requirement for something that can provide the
38111 &_/usr/sbin/sendmail_& interface but deliver messages to a smart host without
38112 any queueing or retrying facilities. Furthermore, the delivery to the smart
38113 host should be synchronous, so that if it fails, the sending MUA is immediately
38114 informed. In other words, we want something that extends an MUA that submits
38115 to a local MTA via the command line so that it behaves like one that submits
38116 to a remote smart host using TCP/SMTP.
38117
38118 There are a number of applications (for example, there is one called &'ssmtp'&)
38119 that do this job. However, people have found them to be lacking in various
38120 ways. For instance, you might want to allow aliasing and forwarding to be done
38121 before sending a message to the smart host.
38122
38123 Exim already had the necessary infrastructure for doing this job. Just a few
38124 tweaks were needed to make it behave as required, though it is somewhat of an
38125 overkill to use a fully-featured MTA for this purpose.
38126
38127 .oindex "&%mua_wrapper%&"
38128 There is a Boolean global option called &%mua_wrapper%&, defaulting false.
38129 Setting &%mua_wrapper%& true causes Exim to run in a special mode where it
38130 assumes that it is being used to &"wrap"& a command-line MUA in the manner
38131 just described. As well as setting &%mua_wrapper%&, you also need to provide a
38132 compatible router and transport configuration. Typically there will be just one
38133 router and one transport, sending everything to a smart host.
38134
38135 When run in MUA wrapping mode, the behaviour of Exim changes in the
38136 following ways:
38137
38138 .ilist
38139 A daemon cannot be run, nor will Exim accept incoming messages from &'inetd'&.
38140 In other words, the only way to submit messages is via the command line.
38141 .next
38142 Each message is synchronously delivered as soon as it is received (&%-odi%& is
38143 assumed). All queueing options (&%queue_only%&, &%queue_smtp_domains%&,
38144 &%control%& in an ACL, etc.) are quietly ignored. The Exim reception process
38145 does not finish until the delivery attempt is complete. If the delivery is
38146 successful, a zero return code is given.
38147 .next
38148 Address redirection is permitted, but the final routing for all addresses must
38149 be to the same remote transport, and to the same list of hosts. Furthermore,
38150 the return address (envelope sender) must be the same for all recipients, as
38151 must any added or deleted header lines. In other words, it must be possible to
38152 deliver the message in a single SMTP transaction, however many recipients there
38153 are.
38154 .next
38155 If these conditions are not met, or if routing any address results in a
38156 failure or defer status, or if Exim is unable to deliver all the recipients
38157 successfully to one of the smart hosts, delivery of the entire message fails.
38158 .next
38159 Because no queueing is allowed, all failures are treated as permanent; there
38160 is no distinction between 4&'xx'& and 5&'xx'& SMTP response codes from the
38161 smart host. Furthermore, because only a single yes/no response can be given to
38162 the caller, it is not possible to deliver to some recipients and not others. If
38163 there is an error (temporary or permanent) for any recipient, all are failed.
38164 .next
38165 If more than one smart host is listed, Exim will try another host after a
38166 connection failure or a timeout, in the normal way. However, if this kind of
38167 failure happens for all the hosts, the delivery fails.
38168 .next
38169 When delivery fails, an error message is written to the standard error stream
38170 (as well as to Exim's log), and Exim exits to the caller with a return code
38171 value 1. The message is expunged from Exim's spool files. No bounce messages
38172 are ever generated.
38173 .next
38174 No retry data is maintained, and any retry rules are ignored.
38175 .next
38176 A number of Exim options are overridden: &%deliver_drop_privilege%& is forced
38177 true, &%max_rcpt%& in the &(smtp)& transport is forced to &"unlimited"&,
38178 &%remote_max_parallel%& is forced to one, and fallback hosts are ignored.
38179 .endlist
38180
38181 The overall effect is that Exim makes a single synchronous attempt to deliver
38182 the message, failing if there is any kind of problem. Because no local
38183 deliveries are done and no daemon can be run, Exim does not need root
38184 privilege. It should be possible to run it setuid to &'exim'& instead of setuid
38185 to &'root'&. See section &<<SECTrunexiwitpri>>& for a general discussion about
38186 the advantages and disadvantages of running without root privilege.
38187
38188
38189
38190
38191 . ////////////////////////////////////////////////////////////////////////////
38192 . ////////////////////////////////////////////////////////////////////////////
38193
38194 .chapter "Log files" "CHAPlog"
38195 .scindex IIDloggen "log" "general description"
38196 .cindex "log" "types of"
38197 Exim writes three different logs, referred to as the main log, the reject log,
38198 and the panic log:
38199
38200 .ilist
38201 .cindex "main log"
38202 The main log records the arrival of each message and each delivery in a single
38203 line in each case. The format is as compact as possible, in an attempt to keep
38204 down the size of log files. Two-character flag sequences make it easy to pick
38205 out these lines. A number of other events are recorded in the main log. Some of
38206 them are optional, in which case the &%log_selector%& option controls whether
38207 they are included or not. A Perl script called &'eximstats'&, which does simple
38208 analysis of main log files, is provided in the Exim distribution (see section
38209 &<<SECTmailstat>>&).
38210 .next
38211 .cindex "reject log"
38212 The reject log records information from messages that are rejected as a result
38213 of a configuration option (that is, for policy reasons).
38214 The first line of each rejection is a copy of the line that is also written to
38215 the main log. Then, if the message's header has been read at the time the log
38216 is written, its contents are written to this log. Only the original header
38217 lines are available; header lines added by ACLs are not logged. You can use the
38218 reject log to check that your policy controls are working correctly; on a busy
38219 host this may be easier than scanning the main log for rejection messages. You
38220 can suppress the writing of the reject log by setting &%write_rejectlog%&
38221 false.
38222 .next
38223 .cindex "panic log"
38224 .cindex "system log"
38225 When certain serious errors occur, Exim writes entries to its panic log. If the
38226 error is sufficiently disastrous, Exim bombs out afterwards. Panic log entries
38227 are usually written to the main log as well, but can get lost amid the mass of
38228 other entries. The panic log should be empty under normal circumstances. It is
38229 therefore a good idea to check it (or to have a &'cron'& script check it)
38230 regularly, in order to become aware of any problems. When Exim cannot open its
38231 panic log, it tries as a last resort to write to the system log (syslog). This
38232 is opened with LOG_PID+LOG_CONS and the facility code of LOG_MAIL. The
38233 message itself is written at priority LOG_CRIT.
38234 .endlist
38235
38236 Every log line starts with a timestamp, in the format shown in the following
38237 example. Note that many of the examples shown in this chapter are line-wrapped.
38238 In the log file, this would be all on one line:
38239 .code
38240 2001-09-16 16:09:47 SMTP connection from [127.0.0.1] closed
38241   by QUIT
38242 .endd
38243 By default, the timestamps are in the local timezone. There are two
38244 ways of changing this:
38245
38246 .ilist
38247 You can set the &%timezone%& option to a different time zone; in particular, if
38248 you set
38249 .code
38250 timezone = UTC
38251 .endd
38252 the timestamps will be in UTC (aka GMT).
38253 .next
38254 If you set &%log_timezone%& true, the time zone is added to the timestamp, for
38255 example:
38256 .code
38257 2003-04-25 11:17:07 +0100 Start queue run: pid=12762
38258 .endd
38259 .endlist
38260
38261 .cindex "log" "process ids in"
38262 .cindex "pid (process id)" "in log lines"
38263 Exim does not include its process id in log lines by default, but you can
38264 request that it does so by specifying the &`pid`& log selector (see section
38265 &<<SECTlogselector>>&). When this is set, the process id is output, in square
38266 brackets, immediately after the time and date.
38267
38268
38269
38270
38271 .section "Where the logs are written" "SECTwhelogwri"
38272 .cindex "log" "destination"
38273 .cindex "log" "to file"
38274 .cindex "log" "to syslog"
38275 .cindex "syslog"
38276 The logs may be written to local files, or to syslog, or both. However, it
38277 should be noted that many syslog implementations use UDP as a transport, and
38278 are therefore unreliable in the sense that messages are not guaranteed to
38279 arrive at the loghost, nor is the ordering of messages necessarily maintained.
38280 It has also been reported that on large log files (tens of megabytes) you may
38281 need to tweak syslog to prevent it syncing the file with each write &-- on
38282 Linux this has been seen to make syslog take 90% plus of CPU time.
38283
38284 The destination for Exim's logs is configured by setting LOG_FILE_PATH in
38285 &_Local/Makefile_& or by setting &%log_file_path%& in the runtime
38286 configuration. This latter string is expanded, so it can contain, for example,
38287 references to the host name:
38288 .code
38289 log_file_path = /var/log/$primary_hostname/exim_%slog
38290 .endd
38291 It is generally advisable, however, to set the string in &_Local/Makefile_&
38292 rather than at runtime, because then the setting is available right from the
38293 start of Exim's execution. Otherwise, if there's something it wants to log
38294 before it has read the configuration file (for example, an error in the
38295 configuration file) it will not use the path you want, and may not be able to
38296 log at all.
38297
38298 The value of LOG_FILE_PATH or &%log_file_path%& is a colon-separated
38299 list, currently limited to at most two items. This is one option where the
38300 facility for changing a list separator may not be used. The list must always be
38301 colon-separated. If an item in the list is &"syslog"& then syslog is used;
38302 otherwise the item must either be an absolute path, containing &`%s`& at the
38303 point where &"main"&, &"reject"&, or &"panic"& is to be inserted, or be empty,
38304 implying the use of a default path.
38305
38306 When Exim encounters an empty item in the list, it searches the list defined by
38307 LOG_FILE_PATH, and uses the first item it finds that is neither empty nor
38308 &"syslog"&. This means that an empty item in &%log_file_path%& can be used to
38309 mean &"use the path specified at build time"&. If no such item exists, log
38310 files are written in the &_log_& subdirectory of the spool directory. This is
38311 equivalent to the setting:
38312 .code
38313 log_file_path = $spool_directory/log/%slog
38314 .endd
38315 If you do not specify anything at build time or runtime,
38316 or if you unset the option at runtime (i.e. &`log_file_path = `&),
38317 that is where the logs are written.
38318
38319 A log file path may also contain &`%D`& or &`%M`& if datestamped log filenames
38320 are in use &-- see section &<<SECTdatlogfil>>& below.
38321
38322 Here are some examples of possible settings:
38323 .display
38324 &`LOG_FILE_PATH=syslog                    `& syslog only
38325 &`LOG_FILE_PATH=:syslog                   `& syslog and default path
38326 &`LOG_FILE_PATH=syslog : /usr/log/exim_%s `& syslog and specified path
38327 &`LOG_FILE_PATH=/usr/log/exim_%s          `& specified path only
38328 .endd
38329 If there are more than two paths in the list, the first is used and a panic
38330 error is logged.
38331
38332
38333
38334 .section "Logging to local files that are periodically &""cycled""&" "SECID285"
38335 .cindex "log" "cycling local files"
38336 .cindex "cycling logs"
38337 .cindex "&'exicyclog'&"
38338 .cindex "log" "local files; writing to"
38339 Some operating systems provide centralized and standardized methods for cycling
38340 log files. For those that do not, a utility script called &'exicyclog'& is
38341 provided (see section &<<SECTcyclogfil>>&). This renames and compresses the
38342 main and reject logs each time it is called. The maximum number of old logs to
38343 keep can be set. It is suggested this script is run as a daily &'cron'& job.
38344
38345 An Exim delivery process opens the main log when it first needs to write to it,
38346 and it keeps the file open in case subsequent entries are required &-- for
38347 example, if a number of different deliveries are being done for the same
38348 message. However, remote SMTP deliveries can take a long time, and this means
38349 that the file may be kept open long after it is renamed if &'exicyclog'& or
38350 something similar is being used to rename log files on a regular basis. To
38351 ensure that a switch of log files is noticed as soon as possible, Exim calls
38352 &[stat()]& on the main log's name before reusing an open file, and if the file
38353 does not exist, or its inode has changed, the old file is closed and Exim
38354 tries to open the main log from scratch. Thus, an old log file may remain open
38355 for quite some time, but no Exim processes should write to it once it has been
38356 renamed.
38357
38358
38359
38360 .section "Datestamped log files" "SECTdatlogfil"
38361 .cindex "log" "datestamped files"
38362 Instead of cycling the main and reject log files by renaming them
38363 periodically, some sites like to use files whose names contain a datestamp,
38364 for example, &_mainlog-20031225_&. The datestamp is in the form &_yyyymmdd_& or
38365 &_yyyymm_&. Exim has support for this way of working. It is enabled by setting
38366 the &%log_file_path%& option to a path that includes &`%D`& or &`%M`& at the
38367 point where the datestamp is required. For example:
38368 .code
38369 log_file_path = /var/spool/exim/log/%slog-%D
38370 log_file_path = /var/log/exim-%s-%D.log
38371 log_file_path = /var/spool/exim/log/%D-%slog
38372 log_file_path = /var/log/exim/%s.%M
38373 .endd
38374 As before, &`%s`& is replaced by &"main"& or &"reject"&; the following are
38375 examples of names generated by the above examples:
38376 .code
38377 /var/spool/exim/log/mainlog-20021225
38378 /var/log/exim-reject-20021225.log
38379 /var/spool/exim/log/20021225-mainlog
38380 /var/log/exim/main.200212
38381 .endd
38382 When this form of log file is specified, Exim automatically switches to new
38383 files at midnight. It does not make any attempt to compress old logs; you
38384 will need to write your own script if you require this. You should not
38385 run &'exicyclog'& with this form of logging.
38386
38387 The location of the panic log is also determined by &%log_file_path%&, but it
38388 is not datestamped, because rotation of the panic log does not make sense.
38389 When generating the name of the panic log, &`%D`& or &`%M`& are removed from
38390 the string. In addition, if it immediately follows a slash, a following
38391 non-alphanumeric character is removed; otherwise a preceding non-alphanumeric
38392 character is removed. Thus, the four examples above would give these panic
38393 log names:
38394 .code
38395 /var/spool/exim/log/paniclog
38396 /var/log/exim-panic.log
38397 /var/spool/exim/log/paniclog
38398 /var/log/exim/panic
38399 .endd
38400
38401
38402 .section "Logging to syslog" "SECID249"
38403 .cindex "log" "syslog; writing to"
38404 The use of syslog does not change what Exim logs or the format of its messages,
38405 except in one respect. If &%syslog_timestamp%& is set false, the timestamps on
38406 Exim's log lines are omitted when these lines are sent to syslog. Apart from
38407 that, the same strings are written to syslog as to log files. The syslog
38408 &"facility"& is set to LOG_MAIL, and the program name to &"exim"&
38409 by default, but you can change these by setting the &%syslog_facility%& and
38410 &%syslog_processname%& options, respectively. If Exim was compiled with
38411 SYSLOG_LOG_PID set in &_Local/Makefile_& (this is the default in
38412 &_src/EDITME_&), then, on systems that permit it (all except ULTRIX), the
38413 LOG_PID flag is set so that the &[syslog()]& call adds the pid as well as
38414 the time and host name to each line.
38415 The three log streams are mapped onto syslog priorities as follows:
38416
38417 .ilist
38418 &'mainlog'& is mapped to LOG_INFO
38419 .next
38420 &'rejectlog'& is mapped to LOG_NOTICE
38421 .next
38422 &'paniclog'& is mapped to LOG_ALERT
38423 .endlist
38424
38425 Many log lines are written to both &'mainlog'& and &'rejectlog'&, and some are
38426 written to both &'mainlog'& and &'paniclog'&, so there will be duplicates if
38427 these are routed by syslog to the same place. You can suppress this duplication
38428 by setting &%syslog_duplication%& false.
38429
38430 Exim's log lines can sometimes be very long, and some of its &'rejectlog'&
38431 entries contain multiple lines when headers are included. To cope with both
38432 these cases, entries written to syslog are split into separate &[syslog()]&
38433 calls at each internal newline, and also after a maximum of
38434 870 data characters. (This allows for a total syslog line length of 1024, when
38435 additions such as timestamps are added.) If you are running a syslog
38436 replacement that can handle lines longer than the 1024 characters allowed by
38437 RFC 3164, you should set
38438 .code
38439 SYSLOG_LONG_LINES=yes
38440 .endd
38441 in &_Local/Makefile_& before building Exim. That stops Exim from splitting long
38442 lines, but it still splits at internal newlines in &'reject'& log entries.
38443
38444 To make it easy to re-assemble split lines later, each component of a split
38445 entry starts with a string of the form [<&'n'&>/<&'m'&>] or [<&'n'&>\<&'m'&>]
38446 where <&'n'&> is the component number and <&'m'&> is the total number of
38447 components in the entry. The / delimiter is used when the line was split
38448 because it was too long; if it was split because of an internal newline, the \
38449 delimiter is used. For example, supposing the length limit to be 50 instead of
38450 870, the following would be the result of a typical rejection message to
38451 &'mainlog'& (LOG_INFO), each line in addition being preceded by the time, host
38452 name, and pid as added by syslog:
38453 .code
38454 [1/5] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected from
38455 [2/5]  [127.0.0.1] (ph10): syntax error in 'From' header
38456 [3/5]  when scanning for sender: missing or malformed lo
38457 [4/5] cal part in "<>" (envelope sender is <ph10@cam.exa
38458 [5/5] mple>)
38459 .endd
38460 The same error might cause the following lines to be written to &"rejectlog"&
38461 (LOG_NOTICE):
38462 .code
38463 [1/18] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected fro
38464 [2/18] m [127.0.0.1] (ph10): syntax error in 'From' head
38465 [3/18] er when scanning for sender: missing or malformed
38466 [4/18]  local part in "<>" (envelope sender is <ph10@cam
38467 [5\18] .example>)
38468 [6\18] Recipients: ph10@some.domain.cam.example
38469 [7\18] P Received: from [127.0.0.1] (ident=ph10)
38470 [8\18]        by xxxxx.cam.example with smtp (Exim 4.00)
38471 [9\18]        id 16RdAL-0006pc-00
38472 [10/18]        for ph10@cam.example; Mon, 16 Sep 2002 16:
38473 [11\18] 09:43 +0100
38474 [12\18] F From: <>
38475 [13\18]   Subject: this is a test header
38476 [18\18]   X-something: this is another header
38477 [15/18] I Message-Id: <E16RdAL-0006pc-00@xxxxx.cam.examp
38478 [16\18] le>
38479 [17\18] B Bcc:
38480 [18/18]   Date: Mon, 16 Sep 2002 16:09:43 +0100
38481 .endd
38482 Log lines that are neither too long nor contain newlines are written to syslog
38483 without modification.
38484
38485 If only syslog is being used, the Exim monitor is unable to provide a log tail
38486 display, unless syslog is routing &'mainlog'& to a file on the local host and
38487 the environment variable EXIMON_LOG_FILE_PATH is set to tell the monitor
38488 where it is.
38489
38490
38491
38492 .section "Log line flags" "SECID250"
38493 One line is written to the main log for each message received, and for each
38494 successful, unsuccessful, and delayed delivery. These lines can readily be
38495 picked out by the distinctive two-character flags that immediately follow the
38496 timestamp. The flags are:
38497 .display
38498 &`<=`&     message arrival
38499 &`(=`&     message fakereject
38500 &`=>`&     normal message delivery
38501 &`->`&     additional address in same delivery
38502 &`>>`&     cutthrough message delivery
38503 &`*>`&     delivery suppressed by &%-N%&
38504 &`**`&     delivery failed; address bounced
38505 &`==`&     delivery deferred; temporary problem
38506 .endd
38507
38508
38509 .section "Logging message reception" "SECID251"
38510 .cindex "log" "reception line"
38511 The format of the single-line entry in the main log that is written for every
38512 message received is shown in the basic example below, which is split over
38513 several lines in order to fit it on the page:
38514 .code
38515 2002-10-31 08:57:53 16ZCW1-0005MB-00 <= kryten@dwarf.fict.example
38516   H=mailer.fict.example [192.168.123.123] U=exim
38517   P=smtp S=5678 id=<incoming message id>
38518 .endd
38519 The address immediately following &"<="& is the envelope sender address. A
38520 bounce message is shown with the sender address &"<>"&, and if it is locally
38521 generated, this is followed by an item of the form
38522 .code
38523 R=<message id>
38524 .endd
38525 which is a reference to the message that caused the bounce to be sent.
38526
38527 .cindex "HELO"
38528 .cindex "EHLO"
38529 For messages from other hosts, the H and U fields identify the remote host and
38530 record the RFC 1413 identity of the user that sent the message, if one was
38531 received. The number given in square brackets is the IP address of the sending
38532 host. If there is a single, unparenthesized  host name in the H field, as
38533 above, it has been verified to correspond to the IP address (see the
38534 &%host_lookup%& option). If the name is in parentheses, it was the name quoted
38535 by the remote host in the SMTP HELO or EHLO command, and has not been
38536 verified. If verification yields a different name to that given for HELO or
38537 EHLO, the verified name appears first, followed by the HELO or EHLO
38538 name in parentheses.
38539
38540 Misconfigured hosts (and mail forgers) sometimes put an IP address, with or
38541 without brackets, in the HELO or EHLO command, leading to entries in
38542 the log containing text like these examples:
38543 .code
38544 H=(10.21.32.43) [192.168.8.34]
38545 H=([10.21.32.43]) [192.168.8.34]
38546 .endd
38547 This can be confusing. Only the final address in square brackets can be relied
38548 on.
38549
38550 For locally generated messages (that is, messages not received over TCP/IP),
38551 the H field is omitted, and the U field contains the login name of the caller
38552 of Exim.
38553
38554 .cindex "authentication" "logging"
38555 .cindex "AUTH" "logging"
38556 For all messages, the P field specifies the protocol used to receive the
38557 message. This is the value that is stored in &$received_protocol$&. In the case
38558 of incoming SMTP messages, the value indicates whether or not any SMTP
38559 extensions (ESMTP), encryption, or authentication were used. If the SMTP
38560 session was encrypted, there is an additional X field that records the cipher
38561 suite that was used.
38562
38563 .cindex log protocol
38564 The protocol is set to &"esmtpsa"& or &"esmtpa"& for messages received from
38565 hosts that have authenticated themselves using the SMTP AUTH command. The first
38566 value is used when the SMTP connection was encrypted (&"secure"&). In this case
38567 there is an additional item A= followed by the name of the authenticator that
38568 was used. If an authenticated identification was set up by the authenticator's
38569 &%server_set_id%& option, this is logged too, separated by a colon from the
38570 authenticator name.
38571
38572 .cindex "size" "of message"
38573 The id field records the existing message id, if present. The size of the
38574 received message is given by the S field. When the message is delivered,
38575 headers may be removed or added, so that the size of delivered copies of the
38576 message may not correspond with this value (and indeed may be different to each
38577 other).
38578
38579 The &%log_selector%& option can be used to request the logging of additional
38580 data when a message is received. See section &<<SECTlogselector>>& below.
38581
38582
38583
38584 .section "Logging deliveries" "SECID252"
38585 .cindex "log" "delivery line"
38586 The format of the single-line entry in the main log that is written for every
38587 delivery is shown in one of the examples below, for local and remote
38588 deliveries, respectively. Each example has been split into multiple lines in order
38589 to fit it on the page:
38590 .code
38591 2002-10-31 08:59:13 16ZCW1-0005MB-00 => marv
38592   <marv@hitch.fict.example> R=localuser T=local_delivery
38593 2002-10-31 09:00:10 16ZCW1-0005MB-00 =>
38594   monk@holistic.fict.example R=dnslookup T=remote_smtp
38595   H=holistic.fict.example [192.168.234.234]
38596 .endd
38597 For ordinary local deliveries, the original address is given in angle brackets
38598 after the final delivery address, which might be a pipe or a file. If
38599 intermediate address(es) exist between the original and the final address, the
38600 last of these is given in parentheses after the final address. The R and T
38601 fields record the router and transport that were used to process the address.
38602
38603 If SMTP AUTH was used for the delivery there is an additional item A=
38604 followed by the name of the authenticator that was used.
38605 If an authenticated identification was set up by the authenticator's &%client_set_id%&
38606 option, this is logged too, as a second colon-separated list item.
38607 Optionally (see the &%smtp_mailauth%& &%log_selector%&) there may be a third list item.
38608
38609 If a shadow transport was run after a successful local delivery, the log line
38610 for the successful delivery has an item added on the end, of the form
38611 .display
38612 &`ST=<`&&'shadow transport name'&&`>`&
38613 .endd
38614 If the shadow transport did not succeed, the error message is put in
38615 parentheses afterwards.
38616
38617 .cindex "asterisk" "after IP address"
38618 When more than one address is included in a single delivery (for example, two
38619 SMTP RCPT commands in one transaction) the second and subsequent addresses are
38620 flagged with &`->`& instead of &`=>`&. When two or more messages are delivered
38621 down a single SMTP connection, an asterisk follows the
38622 .new
38623 remote IP address (and port if enabled)
38624 .wen
38625 in the log lines for the second and subsequent messages.
38626 When two or more messages are delivered down a single TLS connection, the
38627 DNS and some TLS-related information logged for the first message delivered
38628 will not be present in the log lines for the second and subsequent messages.
38629 TLS cipher information is still available.
38630
38631 .cindex "delivery" "cutthrough; logging"
38632 .cindex "cutthrough" "logging"
38633 When delivery is done in cutthrough mode it is flagged with &`>>`& and the log
38634 line precedes the reception line, since cutthrough waits for a possible
38635 rejection from the destination in case it can reject the sourced item.
38636
38637 The generation of a reply message by a filter file gets logged as a
38638 &"delivery"& to the addressee, preceded by &">"&.
38639
38640 The &%log_selector%& option can be used to request the logging of additional
38641 data when a message is delivered. See section &<<SECTlogselector>>& below.
38642
38643
38644 .section "Discarded deliveries" "SECID253"
38645 .cindex "discarded messages"
38646 .cindex "message" "discarded"
38647 .cindex "delivery" "discarded; logging"
38648 When a message is discarded as a result of the command &"seen finish"& being
38649 obeyed in a filter file which generates no deliveries, a log entry of the form
38650 .code
38651 2002-12-10 00:50:49 16auJc-0001UB-00 => discarded
38652   <low.club@bridge.example> R=userforward
38653 .endd
38654 is written, to record why no deliveries are logged. When a message is discarded
38655 because it is aliased to &":blackhole:"& the log line is like this:
38656 .code
38657 1999-03-02 09:44:33 10HmaX-0005vi-00 => :blackhole:
38658   <hole@nowhere.example> R=blackhole_router
38659 .endd
38660
38661
38662 .section "Deferred deliveries" "SECID254"
38663 When a delivery is deferred, a line of the following form is logged:
38664 .code
38665 2002-12-19 16:20:23 16aiQz-0002Q5-00 == marvin@endrest.example
38666   R=dnslookup T=smtp defer (146): Connection refused
38667 .endd
38668 In the case of remote deliveries, the error is the one that was given for the
38669 last IP address that was tried. Details of individual SMTP failures are also
38670 written to the log, so the above line would be preceded by something like
38671 .code
38672 2002-12-19 16:20:23 16aiQz-0002Q5-00 Failed to connect to
38673   mail1.endrest.example [192.168.239.239]: Connection refused
38674 .endd
38675 When a deferred address is skipped because its retry time has not been reached,
38676 a message is written to the log, but this can be suppressed by setting an
38677 appropriate value in &%log_selector%&.
38678
38679
38680
38681 .section "Delivery failures" "SECID255"
38682 .cindex "delivery" "failure; logging"
38683 If a delivery fails because an address cannot be routed, a line of the
38684 following form is logged:
38685 .code
38686 1995-12-19 16:20:23 0tRiQz-0002Q5-00 ** jim@trek99.example
38687   <jim@trek99.example>: unknown mail domain
38688 .endd
38689 If a delivery fails at transport time, the router and transport are shown, and
38690 the response from the remote host is included, as in this example:
38691 .code
38692 2002-07-11 07:14:17 17SXDU-000189-00 ** ace400@pb.example
38693   R=dnslookup T=remote_smtp: SMTP error from remote mailer
38694   after pipelined RCPT TO:<ace400@pb.example>: host
38695   pbmail3.py.example [192.168.63.111]: 553 5.3.0
38696   <ace400@pb.example>...Addressee unknown
38697 .endd
38698 The word &"pipelined"& indicates that the SMTP PIPELINING extension was being
38699 used. See &%hosts_avoid_esmtp%& in the &(smtp)& transport for a way of
38700 disabling PIPELINING. The log lines for all forms of delivery failure are
38701 flagged with &`**`&.
38702
38703
38704
38705 .section "Fake deliveries" "SECID256"
38706 .cindex "delivery" "fake; logging"
38707 If a delivery does not actually take place because the &%-N%& option has been
38708 used to suppress it, a normal delivery line is written to the log, except that
38709 &"=>"& is replaced by &"*>"&.
38710
38711
38712
38713 .section "Completion" "SECID257"
38714 A line of the form
38715 .code
38716 2002-10-31 09:00:11 16ZCW1-0005MB-00 Completed
38717 .endd
38718 is written to the main log when a message is about to be removed from the spool
38719 at the end of its processing.
38720
38721
38722
38723
38724 .section "Summary of Fields in Log Lines" "SECID258"
38725 .cindex "log" "summary of fields"
38726 A summary of the field identifiers that are used in log lines is shown in
38727 the following table:
38728 .display
38729 &`A   `&        authenticator name (and optional id and sender)
38730 &`C   `&        SMTP confirmation on delivery
38731 &`    `&        command list for &"no mail in SMTP session"&
38732 &`CV  `&        certificate verification status
38733 &`D   `&        duration of &"no mail in SMTP session"&
38734 &`DKIM`&        domain verified in incoming message
38735 &`DN  `&        distinguished name from peer certificate
38736 &`DS  `&        DNSSEC secured lookups
38737 &`DT  `&        on &`=>`&, &'=='& and &'**'& lines: time taken for, or to attempt, a delivery
38738 &`F   `&        sender address (on delivery lines)
38739 &`H   `&        host name and IP address
38740 &`I   `&        local interface used
38741 &`id  `&        message id (from header) for incoming message
38742 &`K   `&        CHUNKING extension used
38743 &`L   `&        on &`<=`& and &`=>`& lines: PIPELINING extension used
38744 &`M8S `&        8BITMIME status for incoming message
38745 &`P   `&        on &`<=`& lines: protocol used
38746 &`    `&        on &`=>`& and &`**`& lines: return path
38747 &`PRDR`&        PRDR extension used
38748 &`PRX `&        on &`<=`& and &`=>`& lines: proxy address
38749 &`Q   `&        alternate queue name
38750 &`QT  `&        on &`=>`& lines: time spent on queue so far
38751 &`    `&        on &"Completed"& lines: time spent on queue
38752 &`R   `&        on &`<=`& lines: reference for local bounce
38753 &`    `&        on &`=>`&  &`>>`& &`**`& and &`==`& lines: router name
38754 &`RT  `&        on &`<=`& lines: time taken for reception
38755 &`S   `&        size of message in bytes
38756 &`SNI `&        server name indication from TLS client hello
38757 &`ST  `&        shadow transport name
38758 &`T   `&        on &`<=`& lines: message subject (topic)
38759 &`TFO `&        connection took advantage of TCP Fast Open
38760 &`    `&        on &`=>`& &`**`& and &`==`& lines: transport name
38761 &`U   `&        local user or RFC 1413 identity
38762 &`X   `&        TLS cipher suite
38763 .endd
38764
38765
38766 .section "Other log entries" "SECID259"
38767 Various other types of log entry are written from time to time. Most should be
38768 self-explanatory. Among the more common are:
38769
38770 .ilist
38771 .cindex "retry" "time not reached"
38772 &'retry time not reached'&&~&~An address previously suffered a temporary error
38773 during routing or local delivery, and the time to retry has not yet arrived.
38774 This message is not written to an individual message log file unless it happens
38775 during the first delivery attempt.
38776 .next
38777 &'retry time not reached for any host'&&~&~An address previously suffered
38778 temporary errors during remote delivery, and the retry time has not yet arrived
38779 for any of the hosts to which it is routed.
38780 .next
38781 .cindex "spool directory" "file locked"
38782 &'spool file locked'&&~&~An attempt to deliver a message cannot proceed because
38783 some other Exim process is already working on the message. This can be quite
38784 common if queue running processes are started at frequent intervals. The
38785 &'exiwhat'& utility script can be used to find out what Exim processes are
38786 doing.
38787 .next
38788 .cindex "error" "ignored"
38789 &'error ignored'&&~&~There are several circumstances that give rise to this
38790 message:
38791 .olist
38792 Exim failed to deliver a bounce message whose age was greater than
38793 &%ignore_bounce_errors_after%&. The bounce was discarded.
38794 .next
38795 A filter file set up a delivery using the &"noerror"& option, and the delivery
38796 failed. The delivery was discarded.
38797 .next
38798 A delivery set up by a router configured with
38799 . ==== As this is a nested list, any displays it contains must be indented
38800 . ==== as otherwise they are too far to the left.
38801 .code
38802     errors_to = <>
38803 .endd
38804 failed. The delivery was discarded.
38805 .endlist olist
38806 .next
38807 .cindex DKIM "log line"
38808 &'DKIM: d='&&~&~Verbose results of a DKIM verification attempt, if enabled for
38809 logging and the message has a DKIM signature header.
38810 .endlist ilist
38811
38812
38813
38814
38815
38816 .section "Reducing or increasing what is logged" "SECTlogselector"
38817 .cindex "log" "selectors"
38818 By setting the &%log_selector%& global option, you can disable some of Exim's
38819 default logging, or you can request additional logging. The value of
38820 &%log_selector%& is made up of names preceded by plus or minus characters. For
38821 example:
38822 .code
38823 log_selector = +arguments -retry_defer
38824 .endd
38825 The list of optional log items is in the following table, with the default
38826 selection marked by asterisks:
38827 .display
38828 &` 8bitmime                   `&  received 8BITMIME status
38829 &`*acl_warn_skipped           `&  skipped &%warn%& statement in ACL
38830 &` address_rewrite            `&  address rewriting
38831 &` all_parents                `&  all parents in => lines
38832 &` arguments                  `&  command line arguments
38833 &`*connection_reject          `&  connection rejections
38834 &`*delay_delivery             `&  immediate delivery delayed
38835 &` deliver_time               `&  time taken to attempt delivery
38836 &` delivery_size              `&  add &`S=`&&'nnn'& to => lines
38837 &`*dkim                       `&  DKIM verified domain on <= lines
38838 &` dkim_verbose               `&  separate full DKIM verification result line, per signature
38839 &`*dnslist_defer              `&  defers of DNS list (aka RBL) lookups
38840 &` dnssec                     `&  DNSSEC secured lookups
38841 &`*etrn                       `&  ETRN commands
38842 &`*host_lookup_failed         `&  as it says
38843 &` ident_timeout              `&  timeout for ident connection
38844 &` incoming_interface         `&  local interface on <= and => lines
38845 &` incoming_port              `&  remote port on <= lines
38846 &`*lost_incoming_connection   `&  as it says (includes timeouts)
38847 &` millisec                   `&  millisecond timestamps and RT,QT,DT,D times
38848 &`*msg_id                     `&  on <= lines, Message-ID: header value
38849 &` msg_id_created             `&  on <= lines, Message-ID: header value when one had to be added
38850 &` outgoing_interface         `&  local interface on => lines
38851 &` outgoing_port              `&  add remote port to => lines
38852 &`*queue_run                  `&  start and end queue runs
38853 &` queue_time                 `&  time on queue for one recipient
38854 &`*queue_time_exclusive       `&  exclude recieve time from QT times
38855 &` queue_time_overall         `&  time on queue for whole message
38856 &` pid                        `&  Exim process id
38857 &` pipelining                 `&  PIPELINING use, on <= and => lines
38858 &` proxy                      `&  proxy address on <= and => lines
38859 &` receive_time               `&  time taken to receive message
38860 &` received_recipients        `&  recipients on <= lines
38861 &` received_sender            `&  sender on <= lines
38862 &`*rejected_header            `&  header contents on reject log
38863 &`*retry_defer                `&  &"retry time not reached"&
38864 &` return_path_on_delivery    `&  put return path on => and ** lines
38865 &` sender_on_delivery         `&  add sender to => lines
38866 &`*sender_verify_fail         `&  sender verification failures
38867 &`*size_reject                `&  rejection because too big
38868 &`*skip_delivery              `&  delivery skipped in a queue run
38869 &`*smtp_confirmation          `&  SMTP confirmation on => lines
38870 &` smtp_connection            `&  incoming SMTP connections
38871 &` smtp_incomplete_transaction`&  incomplete SMTP transactions
38872 &` smtp_mailauth              `&  AUTH argument to MAIL commands
38873 &` smtp_no_mail               `&  session with no MAIL commands
38874 &` smtp_protocol_error        `&  SMTP protocol errors
38875 &` smtp_syntax_error          `&  SMTP syntax errors
38876 &` subject                    `&  contents of &'Subject:'& on <= lines
38877 &`*taint                      `&  taint errors or warnings
38878 &`*tls_certificate_verified   `&  certificate verification status
38879 &`*tls_cipher                 `&  TLS cipher suite on <= and => lines
38880 &` tls_peerdn                 `&  TLS peer DN on <= and => lines
38881 &` tls_resumption             `&  append * to cipher field
38882 &` tls_sni                    `&  TLS SNI on <= lines
38883 &` unknown_in_list            `&  DNS lookup failed in list match
38884
38885 &` all                        `&  all of the above
38886 .endd
38887 See also the &%slow_lookup_log%& main configuration option,
38888 section &<<SECID99>>&
38889
38890 More details on each of these items follows:
38891
38892 .ilist
38893 .cindex "8BITMIME"
38894 .cindex "log" "8BITMIME"
38895 &%8bitmime%&: This causes Exim to log any 8BITMIME status of received messages,
38896 which may help in tracking down interoperability issues with ancient MTAs
38897 that are not 8bit clean.  This is added to the &"<="& line, tagged with
38898 &`M8S=`& and a value of &`0`&, &`7`& or &`8`&, corresponding to "not given",
38899 &`7BIT`& and &`8BITMIME`& respectively.
38900 .next
38901 .cindex "&%warn%& ACL verb" "log when skipping"
38902 &%acl_warn_skipped%&: When an ACL &%warn%& statement is skipped because one of
38903 its conditions cannot be evaluated, a log line to this effect is written if
38904 this log selector is set.
38905 .next
38906 .cindex "log" "rewriting"
38907 .cindex "rewriting" "logging"
38908 &%address_rewrite%&: This applies both to global rewrites and per-transport
38909 rewrites, but not to rewrites in filters run as an unprivileged user (because
38910 such users cannot access the log).
38911 .next
38912 .cindex "log" "full parentage"
38913 &%all_parents%&: Normally only the original and final addresses are logged on
38914 delivery lines; with this selector, intermediate parents are given in
38915 parentheses between them.
38916 .next
38917 .cindex "log" "Exim arguments"
38918 .cindex "Exim arguments, logging"
38919 &%arguments%&: This causes Exim to write the arguments with which it was called
38920 to the main log, preceded by the current working directory. This is a debugging
38921 feature, added to make it easier to find out how certain MUAs call
38922 &_/usr/sbin/sendmail_&. The logging does not happen if Exim has given up root
38923 privilege because it was called with the &%-C%& or &%-D%& options. Arguments
38924 that are empty or that contain white space are quoted. Non-printing characters
38925 are shown as escape sequences. This facility cannot log unrecognized arguments,
38926 because the arguments are checked before the configuration file is read. The
38927 only way to log such cases is to interpose a script such as &_util/logargs.sh_&
38928 between the caller and Exim.
38929 .next
38930 .cindex "log" "connection rejections"
38931 &%connection_reject%&: A log entry is written whenever an incoming SMTP
38932 connection is rejected, for whatever reason.
38933 .next
38934 .cindex "log" "delayed delivery"
38935 .cindex "delayed delivery, logging"
38936 &%delay_delivery%&: A log entry is written whenever a delivery process is not
38937 started for an incoming message because the load is too high or too many
38938 messages were received on one connection. Logging does not occur if no delivery
38939 process is started because &%queue_only%& is set or &%-odq%& was used.
38940 .next
38941 .cindex "log" "delivery duration"
38942 &%deliver_time%&: For each delivery, the amount of real time it has taken to
38943 perform the actual delivery is logged as DT=<&'time'&>, for example, &`DT=1s`&.
38944 If millisecond logging is enabled, short times will be shown with greater
38945 precision, eg. &`DT=0.304s`&.
38946 .next
38947 .cindex "log" "message size on delivery"
38948 .cindex "size" "of message"
38949 &%delivery_size%&: For each delivery, the size of message delivered is added to
38950 the &"=>"& line, tagged with S=.
38951 .next
38952 .cindex log "DKIM verification"
38953 .cindex DKIM "verification logging"
38954 &%dkim%&: For message acceptance log lines, when an DKIM signature in the header
38955 verifies successfully a tag of DKIM is added, with one of the verified domains.
38956 .next
38957 .cindex log "DKIM verification"
38958 .cindex DKIM "verification logging"
38959 &%dkim_verbose%&: A log entry is written for each attempted DKIM verification.
38960 .next
38961 .cindex "log" "dnslist defer"
38962 .cindex "DNS list" "logging defer"
38963 .cindex "black list (DNS)"
38964 &%dnslist_defer%&: A log entry is written if an attempt to look up a host in a
38965 DNS black list suffers a temporary error.
38966 .next
38967 .cindex log dnssec
38968 .cindex dnssec logging
38969 &%dnssec%&: For message acceptance and (attempted) delivery log lines, when
38970 dns lookups gave secure results a tag of DS is added.
38971 For acceptance this covers the reverse and forward lookups for host name verification.
38972 It does not cover helo-name verification.
38973 For delivery this covers the SRV, MX, A and/or AAAA lookups.
38974 .next
38975 .cindex "log" "ETRN commands"
38976 .cindex "ETRN" "logging"
38977 &%etrn%&: Every valid ETRN command that is received is logged, before the ACL
38978 is run to determine whether or not it is actually accepted. An invalid ETRN
38979 command, or one received within a message transaction is not logged by this
38980 selector (see &%smtp_syntax_error%& and &%smtp_protocol_error%&).
38981 .next
38982 .cindex "log" "host lookup failure"
38983 &%host_lookup_failed%&: When a lookup of a host's IP addresses fails to find
38984 any addresses, or when a lookup of an IP address fails to find a host name, a
38985 log line is written. This logging does not apply to direct DNS lookups when
38986 routing email addresses, but it does apply to &"byname"& lookups.
38987 .next
38988 .cindex "log" "ident timeout"
38989 .cindex "RFC 1413" "logging timeout"
38990 &%ident_timeout%&: A log line is written whenever an attempt to connect to a
38991 client's ident port times out.
38992 .next
38993 .cindex "log" "incoming interface"
38994 .cindex "log" "outgoing interface"
38995 .cindex "log" "local interface"
38996 .cindex "log" "local address and port"
38997 .cindex "TCP/IP" "logging local address and port"
38998 .cindex "interface" "logging"
38999 &%incoming_interface%&: The interface on which a message was received is added
39000 to the &"<="& line as an IP address in square brackets, tagged by I= and
39001 followed by a colon and the port number. The local interface and port are also
39002 added to other SMTP log lines, for example, &"SMTP connection from"&, to
39003 rejection lines, and (despite the name) to outgoing
39004 .new
39005 &"=>"&, &"->"&, &"=="& and &"**"& lines.
39006 .wen
39007 The latter can be disabled by turning off the &%outgoing_interface%& option.
39008 .next
39009 .cindex log "incoming proxy address"
39010 .cindex proxy "logging proxy address"
39011 .cindex "TCP/IP" "logging proxy address"
39012 &%proxy%&: The internal (closest to the system running Exim) IP address
39013 of the proxy, tagged by PRX=, on the &"<="& line for a message accepted
39014 on a proxied connection
39015 or the &"=>"& line for a message delivered on a proxied connection.
39016 See &<<SECTproxyInbound>>& for more information.
39017 .next
39018 .cindex "log" "incoming remote port"
39019 .cindex "port" "logging remote"
39020 .cindex "TCP/IP" "logging incoming remote port"
39021 .vindex "&$sender_fullhost$&"
39022 .vindex "&$sender_rcvhost$&"
39023 &%incoming_port%&: The remote port number from which a message was received is
39024 added to log entries and &'Received:'& header lines, following the IP address
39025 in square brackets, and separated from it by a colon. This is implemented by
39026 changing the value that is put in the &$sender_fullhost$& and
39027 &$sender_rcvhost$& variables. Recording the remote port number has become more
39028 important with the widening use of NAT (see RFC 2505).
39029 .next
39030 .cindex "log" "dropped connection"
39031 &%lost_incoming_connection%&: A log line is written when an incoming SMTP
39032 connection is unexpectedly dropped.
39033 .next
39034 .cindex "log" "millisecond timestamps"
39035 .cindex millisecond logging
39036 .cindex timestamps "millisecond, in logs"
39037 &%millisec%&: Timestamps have a period and three decimal places of finer granularity
39038 appended to the seconds value.
39039 .next
39040 .cindex "log" "message id"
39041 &%msg_id%&: The value of the Message-ID: header.
39042 .next
39043 &%msg_id_created%&: The value of the Message-ID: header, when one had to be created.
39044 This will be either because the message is a bounce, or was submitted locally
39045 (submission mode) without one.
39046 The field identifier will have an asterix appended: &"id*="&.
39047 .next
39048 .cindex "log" "outgoing interface"
39049 .cindex "log" "local interface"
39050 .cindex "log" "local address and port"
39051 .cindex "TCP/IP" "logging local address and port"
39052 .cindex "interface" "logging"
39053 &%outgoing_interface%&: If &%incoming_interface%& is turned on, then the
39054 interface on which a message was sent is added to delivery lines as an I= tag
39055 followed by IP address in square brackets. You can disable this by turning
39056 off the &%outgoing_interface%& option.
39057 .next
39058 .cindex "log" "outgoing remote port"
39059 .cindex "port" "logging outgoing remote"
39060 .cindex "TCP/IP" "logging outgoing remote port"
39061 &%outgoing_port%&: The remote port number is added to delivery log lines (those
39062 containing => tags) following the IP address.
39063 The local port is also added if &%incoming_interface%& and
39064 &%outgoing_interface%& are both enabled.
39065 This option is not included in the default setting, because for most ordinary
39066 configurations, the remote port number is always 25 (the SMTP port), and the
39067 local port is a random ephemeral port.
39068 .next
39069 .cindex "log" "process ids in"
39070 .cindex "pid (process id)" "in log lines"
39071 &%pid%&: The current process id is added to every log line, in square brackets,
39072 immediately after the time and date.
39073 .next
39074 .cindex log pipelining
39075 .cindex pipelining "logging outgoing"
39076 &%pipelining%&: A field is added to delivery and accept
39077 log lines when the ESMTP PIPELINING extension was used.
39078 The field is a single "L".
39079
39080 On accept lines, where PIPELINING was offered but not used by the client,
39081 the field has a minus appended.
39082
39083 .cindex "pipelining" "early connection"
39084 If Exim is built with the SUPPORT_PIPE_CONNECT build option
39085 accept "L" fields have a period appended if the feature was
39086 offered but not used, or an asterisk appended if used.
39087 Delivery "L" fields have an asterisk appended if used.
39088
39089 .next
39090 .cindex "log" "queue run"
39091 .cindex "queue runner" "logging"
39092 &%queue_run%&: The start and end of every queue run are logged.
39093 .next
39094 .cindex "log" "queue time"
39095 &%queue_time%&: The amount of time the message has been in the queue on the
39096 local host is logged as QT=<&'time'&> on delivery (&`=>`&) lines, for example,
39097 &`QT=3m45s`&.
39098 If millisecond logging is enabled, short times will be shown with greater
39099 precision, eg. &`QT=1.578s`&.
39100 .next
39101 &%queue_time_overall%&: The amount of time the message has been in the queue on
39102 the local host is logged as QT=<&'time'&> on &"Completed"& lines, for
39103 example, &`QT=3m45s`&.
39104 .next
39105 .cindex "log" "receive duration"
39106 &%receive_time%&: For each message, the amount of real time it has taken to
39107 perform the reception is logged as RT=<&'time'&>, for example, &`RT=1s`&.
39108 If millisecond logging is enabled, short times will be shown with greater
39109 precision, eg. &`RT=0.204s`&.
39110 .next
39111 .cindex "log" "recipients"
39112 &%received_recipients%&: The recipients of a message are listed in the main log
39113 as soon as the message is received. The list appears at the end of the log line
39114 that is written when a message is received, preceded by the word &"for"&. The
39115 addresses are listed after they have been qualified, but before any rewriting
39116 has taken place.
39117 Recipients that were discarded by an ACL for MAIL or RCPT do not appear
39118 in the list.
39119 .next
39120 .cindex "log" "sender reception"
39121 &%received_sender%&: The unrewritten original sender of a message is added to
39122 the end of the log line that records the message's arrival, after the word
39123 &"from"& (before the recipients if &%received_recipients%& is also set).
39124 .next
39125 .cindex "log" "header lines for rejection"
39126 &%rejected_header%&: If a message's header has been received at the time a
39127 rejection is written to the reject log, the complete header is added to the
39128 log. Header logging can be turned off individually for messages that are
39129 rejected by the &[local_scan()]& function (see section &<<SECTapiforloc>>&).
39130 .next
39131 .cindex "log" "retry defer"
39132 &%retry_defer%&: A log line is written if a delivery is deferred because a
39133 retry time has not yet been reached. However, this &"retry time not reached"&
39134 message is always omitted from individual message logs after the first delivery
39135 attempt.
39136 .next
39137 .cindex "log" "return path"
39138 &%return_path_on_delivery%&: The return path that is being transmitted with
39139 the message is included in delivery and bounce lines, using the tag P=.
39140 This is omitted if no delivery actually happens, for example, if routing fails,
39141 or if delivery is to &_/dev/null_& or to &`:blackhole:`&.
39142 .next
39143 .cindex "log" "sender on delivery"
39144 &%sender_on_delivery%&: The message's sender address is added to every delivery
39145 and bounce line, tagged by F= (for &"from"&).
39146 This is the original sender that was received with the message; it is not
39147 necessarily the same as the outgoing return path.
39148 .next
39149 .cindex "log" "sender verify failure"
39150 &%sender_verify_fail%&: If this selector is unset, the separate log line that
39151 gives details of a sender verification failure is not written. Log lines for
39152 the rejection of SMTP commands contain just &"sender verify failed"&, so some
39153 detail is lost.
39154 .next
39155 .cindex "log" "size rejection"
39156 &%size_reject%&: A log line is written whenever a message is rejected because
39157 it is too big.
39158 .next
39159 .cindex "log" "frozen messages; skipped"
39160 .cindex "frozen messages" "logging skipping"
39161 &%skip_delivery%&: A log line is written whenever a message is skipped during a
39162 queue run because it another process is already delivering it or because
39163 it is frozen.
39164 .cindex "&""spool file is locked""&"
39165 .cindex "&""message is frozen""&"
39166 The message that is written is either &"spool file is locked"& or
39167 &"message is frozen"&.
39168 .next
39169 .cindex "log" "smtp confirmation"
39170 .cindex "SMTP" "logging confirmation"
39171 .cindex "LMTP" "logging confirmation"
39172 &%smtp_confirmation%&: The response to the final &"."& in the SMTP or LMTP dialogue for
39173 outgoing messages is added to delivery log lines in the form &`C=`&<&'text'&>.
39174 A number of MTAs (including Exim) return an identifying string in this
39175 response.
39176 .next
39177 .cindex "log" "SMTP connections"
39178 .cindex "SMTP" "logging connections"
39179 &%smtp_connection%&: A log line is written whenever an incoming SMTP connection is
39180 established or closed, unless the connection is from a host that matches
39181 &%hosts_connection_nolog%&. (In contrast, &%lost_incoming_connection%& applies
39182 only when the closure is unexpected.) This applies to connections from local
39183 processes that use &%-bs%& as well as to TCP/IP connections. If a connection is
39184 dropped in the middle of a message, a log line is always written, whether or
39185 not this selector is set, but otherwise nothing is written at the start and end
39186 of connections unless this selector is enabled.
39187
39188 For TCP/IP connections to an Exim daemon, the current number of connections is
39189 included in the log message for each new connection, but note that the count is
39190 reset if the daemon is restarted.
39191 Also, because connections are closed (and the closure is logged) in
39192 subprocesses, the count may not include connections that have been closed but
39193 whose termination the daemon has not yet noticed. Thus, while it is possible to
39194 match up the opening and closing of connections in the log, the value of the
39195 logged counts may not be entirely accurate.
39196 .next
39197 .cindex "log" "SMTP transaction; incomplete"
39198 .cindex "SMTP" "logging incomplete transactions"
39199 &%smtp_incomplete_transaction%&: When a mail transaction is aborted by
39200 RSET, QUIT, loss of connection, or otherwise, the incident is logged,
39201 and the message sender plus any accepted recipients are included in the log
39202 line. This can provide evidence of dictionary attacks.
39203 .next
39204 .cindex "log" "non-MAIL SMTP sessions"
39205 .cindex "MAIL" "logging session without"
39206 &%smtp_no_mail%&: A line is written to the main log whenever an accepted SMTP
39207 connection terminates without having issued a MAIL command. This includes both
39208 the case when the connection is dropped, and the case when QUIT is used. It
39209 does not include cases where the connection is rejected right at the start (by
39210 an ACL, or because there are too many connections, or whatever). These cases
39211 already have their own log lines.
39212
39213 The log line that is written contains the identity of the client in the usual
39214 way, followed by D= and a time, which records the duration of the connection.
39215 If the connection was authenticated, this fact is logged exactly as it is for
39216 an incoming message, with an A= item. If the connection was encrypted, CV=,
39217 DN=, and X= items may appear as they do for an incoming message, controlled by
39218 the same logging options.
39219
39220 Finally, if any SMTP commands were issued during the connection, a C= item
39221 is added to the line, listing the commands that were used. For example,
39222 .code
39223 C=EHLO,QUIT
39224 .endd
39225 shows that the client issued QUIT straight after EHLO. If there were fewer
39226 than 20 commands, they are all listed. If there were more than 20 commands,
39227 the last 20 are listed, preceded by &"..."&. However, with the default
39228 setting of 10 for &%smtp_accept_max_nonmail%&, the connection will in any case
39229 have been aborted before 20 non-mail commands are processed.
39230 .next
39231 &%smtp_mailauth%&: A third subfield with the authenticated sender,
39232 colon-separated, is appended to the A= item for a message arrival or delivery
39233 log line, if an AUTH argument to the SMTP MAIL command (see &<<SECTauthparamail>>&)
39234 was accepted or used.
39235 .next
39236 .cindex "log" "SMTP protocol error"
39237 .cindex "SMTP" "logging protocol error"
39238 &%smtp_protocol_error%&: A log line is written for every SMTP protocol error
39239 encountered. Exim does not have perfect detection of all protocol errors
39240 because of transmission delays and the use of pipelining. If PIPELINING has
39241 been advertised to a client, an Exim server assumes that the client will use
39242 it, and therefore it does not count &"expected"& errors (for example, RCPT
39243 received after rejecting MAIL) as protocol errors.
39244 .next
39245 .cindex "SMTP" "logging syntax errors"
39246 .cindex "SMTP" "syntax errors; logging"
39247 .cindex "SMTP" "unknown command; logging"
39248 .cindex "log" "unknown SMTP command"
39249 .cindex "log" "SMTP syntax error"
39250 &%smtp_syntax_error%&: A log line is written for every SMTP syntax error
39251 encountered. An unrecognized command is treated as a syntax error. For an
39252 external connection, the host identity is given; for an internal connection
39253 using &%-bs%& the sender identification (normally the calling user) is given.
39254 .next
39255 .cindex "log" "subject"
39256 .cindex "subject, logging"
39257 &%subject%&: The subject of the message is added to the arrival log line,
39258 preceded by &"T="& (T for &"topic"&, since S is already used for &"size"&).
39259 Any MIME &"words"& in the subject are decoded. The &%print_topbitchars%& option
39260 specifies whether characters with values greater than 127 should be logged
39261 unchanged, or whether they should be rendered as escape sequences.
39262 .next
39263 .cindex "log" "certificate verification"
39264 .cindex log DANE
39265 .cindex DANE logging
39266 &%tls_certificate_verified%&: An extra item is added to <= and => log lines
39267 when TLS is in use. The item is &`CV=yes`& if the peer's certificate was
39268 verified
39269 using a CA trust anchor,
39270 &`CV=dane`& if using a DNS trust anchor,
39271 and &`CV=no`& if not.
39272 .next
39273 .cindex "log" "Taint warnings"
39274 &%taint%&: Log warnings about tainted data. This selector can't be
39275 turned of if &%allow_insecure_tainted_data%& is false (which is the
39276 default).
39277 .next
39278 .cindex "log" "TLS cipher"
39279 .cindex "TLS" "logging cipher"
39280 &%tls_cipher%&: When a message is sent or received over an encrypted
39281 connection, the cipher suite used is added to the log line, preceded by X=.
39282 .next
39283 .cindex "log" "TLS peer DN"
39284 .cindex "TLS" "logging peer DN"
39285 &%tls_peerdn%&: When a message is sent or received over an encrypted
39286 connection, and a certificate is supplied by the remote host, the peer DN is
39287 added to the log line, preceded by DN=.
39288 .next
39289 .cindex "log" "TLS resumption"
39290 .cindex "TLS" "logging session resumption"
39291 .new
39292 &%tls_resumption%&: When a message is sent or received over an encrypted
39293 connection and the TLS session resumed one used on a previous TCP connection,
39294 an asterisk is appended to the X= cipher field in the log line.
39295 .wen
39296 .next
39297 .cindex "log" "TLS SNI"
39298 .cindex "TLS" "logging SNI"
39299 .cindex SNI logging
39300 &%tls_sni%&: When a message is received over an encrypted connection, and
39301 the remote host provided the Server Name Indication extension, the SNI is
39302 added to the log line, preceded by SNI=.
39303 .next
39304 .cindex "log" "DNS failure in list"
39305 &%unknown_in_list%&: This setting causes a log entry to be written when the
39306 result of a list match is failure because a DNS lookup failed.
39307 .endlist
39308
39309
39310 .section "Message log" "SECID260"
39311 .cindex "message" "log file for"
39312 .cindex "log" "message log; description of"
39313 .cindex "&_msglog_& directory"
39314 .oindex "&%preserve_message_logs%&"
39315 In addition to the general log files, Exim writes a log file for each message
39316 that it handles. The names of these per-message logs are the message ids, and
39317 they are kept in the &_msglog_& sub-directory of the spool directory. Each
39318 message log contains copies of the log lines that apply to the message. This
39319 makes it easier to inspect the status of an individual message without having
39320 to search the main log. A message log is deleted when processing of the message
39321 is complete, unless &%preserve_message_logs%& is set, but this should be used
39322 only with great care because they can fill up your disk very quickly.
39323
39324 On a heavily loaded system, it may be desirable to disable the use of
39325 per-message logs, in order to reduce disk I/O. This can be done by setting the
39326 &%message_logs%& option false.
39327 .ecindex IIDloggen
39328
39329
39330
39331
39332 . ////////////////////////////////////////////////////////////////////////////
39333 . ////////////////////////////////////////////////////////////////////////////
39334
39335 .chapter "Exim utilities" "CHAPutils"
39336 .scindex IIDutils "utilities"
39337 A number of utility scripts and programs are supplied with Exim and are
39338 described in this chapter. There is also the Exim Monitor, which is covered in
39339 the next chapter. The utilities described here are:
39340
39341 .itable none 0 0 3  7* left  15* left  40* left
39342 .irow &<<SECTfinoutwha>>&     &'exiwhat'&       &&&
39343   "list what Exim processes are doing"
39344 .irow &<<SECTgreptheque>>&    &'exiqgrep'&      "grep the queue"
39345 .irow &<<SECTsumtheque>>&     &'exiqsumm'&      "summarize the queue"
39346 .irow &<<SECTextspeinf>>&     &'exigrep'&       "search the main log"
39347 .irow &<<SECTexipick>>&       &'exipick'&       "select messages on &&&
39348                                                 various criteria"
39349 .irow &<<SECTcyclogfil>>&     &'exicyclog'&     "cycle (rotate) log files"
39350 .irow &<<SECTmailstat>>&      &'eximstats'&     &&&
39351   "extract statistics from the log"
39352 .irow &<<SECTcheckaccess>>&   &'exim_checkaccess'& &&&
39353   "check address acceptance from given IP"
39354 .irow &<<SECTdbmbuild>>&      &'exim_dbmbuild'& "build a DBM file"
39355 .irow &<<SECTfinindret>>&     &'exinext'&       "extract retry information"
39356 .irow &<<SECTdumpdb>>&        &'exim_dumpdb'&   "dump a hints database"
39357 .irow &<<SECTtidydb>>&        &'exim_tidydb'&   "clean up a hints database"
39358 .irow &<<SECTfixdb>>&         &'exim_fixdb'&    "patch a hints database"
39359 .irow &<<SECTmailboxmaint>>&  &'exim_lock'&     "lock a mailbox file"
39360 .endtable
39361
39362 Another utility that might be of use to sites with many MTAs is Tom Kistner's
39363 &'exilog'&. It provides log visualizations across multiple Exim servers. See
39364 &url(https://duncanthrax.net/exilog/) for details.
39365
39366
39367
39368
39369 .section "Finding out what Exim processes are doing (exiwhat)" "SECTfinoutwha"
39370 .cindex "&'exiwhat'&"
39371 .cindex "process, querying"
39372 .cindex "SIGUSR1"
39373 On operating systems that can restart a system call after receiving a signal
39374 (most modern OS), an Exim process responds to the SIGUSR1 signal by writing
39375 a line describing what it is doing to the file &_exim-process.info_& in the
39376 Exim spool directory. The &'exiwhat'& script sends the signal to all Exim
39377 processes it can find, having first emptied the file. It then waits for one
39378 second to allow the Exim processes to react before displaying the results. In
39379 order to run &'exiwhat'& successfully you have to have sufficient privilege to
39380 send the signal to the Exim processes, so it is normally run as root.
39381
39382 &*Warning*&: This is not an efficient process. It is intended for occasional
39383 use by system administrators. It is not sensible, for example, to set up a
39384 script that sends SIGUSR1 signals to Exim processes at short intervals.
39385
39386
39387 Unfortunately, the &'ps'& command that &'exiwhat'& uses to find Exim processes
39388 varies in different operating systems. Not only are different options used,
39389 but the format of the output is different. For this reason, there are some
39390 system configuration options that configure exactly how &'exiwhat'& works. If
39391 it doesn't seem to be working for you, check the following compile-time
39392 options:
39393 .display
39394 &`EXIWHAT_PS_CMD    `& the command for running &'ps'&
39395 &`EXIWHAT_PS_ARG    `& the argument for &'ps'&
39396 &`EXIWHAT_EGREP_ARG `& the argument for &'egrep'& to select from &'ps'& output
39397 &`EXIWHAT_KILL_ARG  `& the argument for the &'kill'& command
39398 .endd
39399 An example of typical output from &'exiwhat'& is
39400 .code
39401 164 daemon: -q1h, listening on port 25
39402 10483 running queue: waiting for 0tAycK-0002ij-00 (10492)
39403 10492 delivering 0tAycK-0002ij-00 to mail.ref.example
39404   [10.19.42.42] (editor@ref.example)
39405 10592 handling incoming call from [192.168.243.242]
39406 10628 accepting a local non-SMTP message
39407 .endd
39408 The first number in the output line is the process number. The third line has
39409 been split here, in order to fit it on the page.
39410
39411
39412
39413 .section "Selective queue listing (exiqgrep)" "SECTgreptheque"
39414 .cindex "&'exiqgrep'&"
39415 .cindex "queue" "grepping"
39416 This utility is a Perl script contributed by Matt Hubbard. It runs
39417 .code
39418 exim -bpu
39419 .endd
39420 or (in case &*-a*& switch is specified)
39421 .code
39422 exim -bp
39423 .endd
39424 The &*-C*& option is used to specify an alternate &_exim.conf_& which might
39425 contain alternate exim configuration the queue management might be using.
39426
39427 to obtain a queue listing, and then greps the output to select messages
39428 that match given criteria. The following selection options are available:
39429
39430 .vlist
39431 .vitem &*-f*&&~<&'regex'&>
39432 Match the sender address using a case-insensitive search. The field that is
39433 tested is enclosed in angle brackets, so you can test for bounce messages with
39434 .code
39435 exiqgrep -f '^<>$'
39436 .endd
39437 .vitem &*-r*&&~<&'regex'&>
39438 Match a recipient address using a case-insensitive search. The field that is
39439 tested is not enclosed in angle brackets.
39440
39441 .vitem &*-s*&&~<&'regex'&>
39442 Match against the size field.
39443
39444 .vitem &*-y*&&~<&'seconds'&>
39445 Match messages that are younger than the given time.
39446
39447 .vitem &*-o*&&~<&'seconds'&>
39448 Match messages that are older than the given time.
39449
39450 .vitem &*-z*&
39451 Match only frozen messages.
39452
39453 .vitem &*-x*&
39454 Match only non-frozen messages.
39455
39456 .vitem &*-G*&&~<&'queuename'&>
39457 Match only messages in the given queue.  Without this, the default queue is searched.
39458 .endlist
39459
39460 The following options control the format of the output:
39461
39462 .vlist
39463 .vitem &*-c*&
39464 Display only the count of matching messages.
39465
39466 .vitem &*-l*&
39467 Long format &-- display the full message information as output by Exim. This is
39468 the default.
39469
39470 .vitem &*-i*&
39471 Display message ids only.
39472
39473 .vitem &*-b*&
39474 Brief format &-- one line per message.
39475
39476 .vitem &*-R*&
39477 Display messages in reverse order.
39478
39479 .vitem &*-a*&
39480 Include delivered recipients in queue listing.
39481 .endlist
39482
39483 There is one more option, &%-h%&, which outputs a list of options.
39484
39485
39486
39487 .section "Summarizing the queue (exiqsumm)" "SECTsumtheque"
39488 .cindex "&'exiqsumm'&"
39489 .cindex "queue" "summary"
39490 The &'exiqsumm'& utility is a Perl script which reads the output of &`exim
39491 -bp`& and produces a summary of the messages in the queue. Thus, you use it by
39492 running a command such as
39493 .code
39494 exim -bp | exiqsumm
39495 .endd
39496 The output consists of one line for each domain that has messages waiting for
39497 it, as in the following example:
39498 .code
39499 3   2322   74m   66m  msn.com.example
39500 .endd
39501 Each line lists the number of pending deliveries for a domain, their total
39502 volume, and the length of time that the oldest and the newest messages have
39503 been waiting. Note that the number of pending deliveries is greater than the
39504 number of messages when messages have more than one recipient.
39505
39506 A summary line is output at the end. By default the output is sorted on the
39507 domain name, but &'exiqsumm'& has the options &%-a%& and &%-c%&, which cause
39508 the output to be sorted by oldest message and by count of messages,
39509 respectively. There are also three options that split the messages for each
39510 domain into two or more subcounts: &%-b%& separates bounce messages, &%-f%&
39511 separates frozen messages, and &%-s%& separates messages according to their
39512 sender.
39513
39514 The output of &'exim -bp'& contains the original addresses in the message, so
39515 this also applies to the output from &'exiqsumm'&. No domains from addresses
39516 generated by aliasing or forwarding are included (unless the &%one_time%&
39517 option of the &(redirect)& router has been used to convert them into &"top
39518 level"& addresses).
39519
39520
39521
39522
39523 .section "Extracting specific information from the log (exigrep)" &&&
39524          "SECTextspeinf"
39525 .cindex "&'exigrep'&"
39526 .cindex "log" "extracts; grepping for"
39527 The &'exigrep'& utility is a Perl script that searches one or more main log
39528 files for entries that match a given pattern. When it finds a match, it
39529 extracts all the log entries for the relevant message, not just those that
39530 match the pattern. Thus, &'exigrep'& can extract complete log entries for a
39531 given message, or all mail for a given user, or for a given host, for example.
39532 The input files can be in Exim log format or syslog format.
39533 If a matching log line is not associated with a specific message, it is
39534 included in &'exigrep'&'s output without any additional lines. The usage is:
39535 .display
39536 &`exigrep [-t<`&&'n'&&`>] [-I] [-l] [-M] [-v] <`&&'pattern'&&`> [<`&&'log file'&&`>] ...`&
39537 .endd
39538 If no log filenames are given on the command line, the standard input is read.
39539
39540 The &%-t%& argument specifies a number of seconds. It adds an additional
39541 condition for message selection. Messages that are complete are shown only if
39542 they spent more than <&'n'&> seconds in the queue.
39543
39544 By default, &'exigrep'& does case-insensitive matching. The &%-I%& option
39545 makes it case-sensitive. This may give a performance improvement when searching
39546 large log files. Without &%-I%&, the Perl pattern matches use Perl's &`/i`&
39547 option; with &%-I%& they do not. In both cases it is possible to change the
39548 case sensitivity within the pattern by using &`(?i)`& or &`(?-i)`&.
39549
39550 The &%-l%& option means &"literal"&, that is, treat all characters in the
39551 pattern as standing for themselves. Otherwise the pattern must be a Perl
39552 regular expression.
39553
39554 The &%-v%& option inverts the matching condition. That is, a line is selected
39555 if it does &'not'& match the pattern.
39556
39557 The &%-M%& options means &"related messages"&. &'exigrep'& will show messages
39558 that are generated as a result/response to a message that &'exigrep'& matched
39559 normally.
39560
39561 Example of &%-M%&:
39562 user_a sends a message to user_b, which generates a bounce back to user_b. If
39563 &'exigrep'& is used to search for &"user_a"&, only the first message will be
39564 displayed.  But if &'exigrep'& is used to search for &"user_b"&, the first and
39565 the second (bounce) message will be displayed. Using &%-M%& with &'exigrep'&
39566 when searching for &"user_a"& will show both messages since the bounce is
39567 &"related"& to or a &"result"& of the first message that was found by the
39568 search term.
39569
39570 If the location of a &'zcat'& command is known from the definition of
39571 ZCAT_COMMAND in &_Local/Makefile_&, &'exigrep'& automatically passes any file
39572 whose name ends in COMPRESS_SUFFIX through &'zcat'& as it searches it.
39573 If the ZCAT_COMMAND is not executable, &'exigrep'& tries to use
39574 autodetection of some well known compression extensions.
39575
39576
39577 .section "Selecting messages by various criteria (exipick)" "SECTexipick"
39578 .cindex "&'exipick'&"
39579 John Jetmore's &'exipick'& utility is included in the Exim distribution. It
39580 lists messages from the queue according to a variety of criteria. For details
39581 of &'exipick'&'s facilities, run &'exipick'& with
39582 the &%--help%& option.
39583
39584
39585 .section "Cycling log files (exicyclog)" "SECTcyclogfil"
39586 .cindex "log" "cycling local files"
39587 .cindex "cycling logs"
39588 .cindex "&'exicyclog'&"
39589 The &'exicyclog'& script can be used to cycle (rotate) &'mainlog'& and
39590 &'rejectlog'& files. This is not necessary if only syslog is being used, or if
39591 you are using log files with datestamps in their names (see section
39592 &<<SECTdatlogfil>>&). Some operating systems have their own standard mechanisms
39593 for log cycling, and these can be used instead of &'exicyclog'& if preferred.
39594 There are two command line options for &'exicyclog'&:
39595 .ilist
39596 &%-k%& <&'count'&> specifies the number of log files to keep, overriding the
39597 default that is set when Exim is built. The default default is 10.
39598 .next
39599 &%-l%& <&'path'&> specifies the log file path, in the same format as Exim's
39600 &%log_file_path%& option (for example, &`/var/log/exim_%slog`&), again
39601 overriding the script's default, which is to find the setting from Exim's
39602 configuration.
39603 .endlist
39604
39605 Each time &'exicyclog'& is run the filenames get &"shuffled down"& by one. If
39606 the main log filename is &_mainlog_& (the default) then when &'exicyclog'& is
39607 run &_mainlog_& becomes &_mainlog.01_&, the previous &_mainlog.01_& becomes
39608 &_mainlog.02_& and so on, up to the limit that is set in the script or by the
39609 &%-k%& option. Log files whose numbers exceed the limit are discarded. Reject
39610 logs are handled similarly.
39611
39612 If the limit is greater than 99, the script uses 3-digit numbers such as
39613 &_mainlog.001_&, &_mainlog.002_&, etc. If you change from a number less than 99
39614 to one that is greater, or &'vice versa'&, you will have to fix the names of
39615 any existing log files.
39616
39617 If no &_mainlog_& file exists, the script does nothing. Files that &"drop off"&
39618 the end are deleted. All files with numbers greater than 01 are compressed,
39619 using a compression command which is configured by the COMPRESS_COMMAND
39620 setting in &_Local/Makefile_&. It is usual to run &'exicyclog'& daily from a
39621 root &%crontab%& entry of the form
39622 .code
39623 1 0 * * * su exim -c /usr/exim/bin/exicyclog
39624 .endd
39625 assuming you have used the name &"exim"& for the Exim user. You can run
39626 &'exicyclog'& as root if you wish, but there is no need.
39627
39628
39629
39630 .section "Mail statistics (eximstats)" "SECTmailstat"
39631 .cindex "statistics"
39632 .cindex "&'eximstats'&"
39633 A Perl script called &'eximstats'& is provided for extracting statistical
39634 information from log files. The output is either plain text, or HTML.
39635 . --- 2018-09-07: LogReport's Lire appears to be dead; website is a Yahoo Japan
39636 . --- 404 error and everything else points to that.
39637
39638 The &'eximstats'& script has been hacked about quite a bit over time. The
39639 latest version is the result of some extensive revision by Steve Campbell. A
39640 lot of information is given by default, but there are options for suppressing
39641 various parts of it. Following any options, the arguments to the script are a
39642 list of files, which should be main log files. For example:
39643 .code
39644 eximstats -nr /var/spool/exim/log/mainlog.01
39645 .endd
39646 By default, &'eximstats'& extracts information about the number and volume of
39647 messages received from or delivered to various hosts. The information is sorted
39648 both by message count and by volume, and the top fifty hosts in each category
39649 are listed on the standard output. Similar information, based on email
39650 addresses or domains instead of hosts can be requested by means of various
39651 options. For messages delivered and received locally, similar statistics are
39652 also produced per user.
39653
39654 The output also includes total counts and statistics about delivery errors, and
39655 histograms showing the number of messages received and deliveries made in each
39656 hour of the day. A delivery with more than one address in its envelope (for
39657 example, an SMTP transaction with more than one RCPT command) is counted
39658 as a single delivery by &'eximstats'&.
39659
39660 Though normally more deliveries than receipts are reported (as messages may
39661 have multiple recipients), it is possible for &'eximstats'& to report more
39662 messages received than delivered, even though the queue is empty at the start
39663 and end of the period in question. If an incoming message contains no valid
39664 recipients, no deliveries are recorded for it. A bounce message is handled as
39665 an entirely separate message.
39666
39667 &'eximstats'& always outputs a grand total summary giving the volume and number
39668 of messages received and deliveries made, and the number of hosts involved in
39669 each case. It also outputs the number of messages that were delayed (that is,
39670 not completely delivered at the first attempt), and the number that had at
39671 least one address that failed.
39672
39673 The remainder of the output is in sections that can be independently disabled
39674 or modified by various options. It consists of a summary of deliveries by
39675 transport, histograms of messages received and delivered per time interval
39676 (default per hour), information about the time messages spent in the queue,
39677 a list of relayed messages, lists of the top fifty sending hosts, local
39678 senders, destination hosts, and destination local users by count and by volume,
39679 and a list of delivery errors that occurred.
39680
39681 The relay information lists messages that were actually relayed, that is, they
39682 came from a remote host and were directly delivered to some other remote host,
39683 without being processed (for example, for aliasing or forwarding) locally.
39684
39685 There are quite a few options for &'eximstats'& to control exactly what it
39686 outputs. These are documented in the Perl script itself, and can be extracted
39687 by running the command &(perldoc)& on the script. For example:
39688 .code
39689 perldoc /usr/exim/bin/eximstats
39690 .endd
39691
39692 .section "Checking access policy (exim_checkaccess)" "SECTcheckaccess"
39693 .cindex "&'exim_checkaccess'&"
39694 .cindex "policy control" "checking access"
39695 .cindex "checking access"
39696 The &%-bh%& command line argument allows you to run a fake SMTP session with
39697 debugging output, in order to check what Exim is doing when it is applying
39698 policy controls to incoming SMTP mail. However, not everybody is sufficiently
39699 familiar with the SMTP protocol to be able to make full use of &%-bh%&, and
39700 sometimes you just want to answer the question &"Does this address have
39701 access?"& without bothering with any further details.
39702
39703 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%&. It takes
39704 two arguments, an IP address and an email address:
39705 .code
39706 exim_checkaccess 10.9.8.7 A.User@a.domain.example
39707 .endd
39708 The utility runs a call to Exim with the &%-bh%& option, to test whether the
39709 given email address would be accepted in a RCPT command in a TCP/IP
39710 connection from the host with the given IP address. The output of the utility
39711 is either the word &"accepted"&, or the SMTP error response, for example:
39712 .code
39713 Rejected:
39714 550 Relay not permitted
39715 .endd
39716 When running this test, the utility uses &`<>`& as the envelope sender address
39717 for the MAIL command, but you can change this by providing additional
39718 options. These are passed directly to the Exim command. For example, to specify
39719 that the test is to be run with the sender address &'himself@there.example'&
39720 you can use:
39721 .code
39722 exim_checkaccess 10.9.8.7 A.User@a.domain.example \
39723                  -f himself@there.example
39724 .endd
39725 Note that these additional Exim command line items must be given after the two
39726 mandatory arguments.
39727
39728 Because the &%exim_checkaccess%& uses &%-bh%&, it does not perform callouts
39729 while running its checks. You can run checks that include callouts by using
39730 &%-bhc%&, but this is not yet available in a &"packaged"& form.
39731
39732
39733
39734 .section "Making DBM files (exim_dbmbuild)" "SECTdbmbuild"
39735 .cindex "DBM" "building dbm files"
39736 .cindex "building DBM files"
39737 .cindex "&'exim_dbmbuild'&"
39738 .cindex "lower casing"
39739 .cindex "binary zero" "in lookup key"
39740 The &'exim_dbmbuild'& program reads an input file containing keys and data in
39741 the format used by the &(lsearch)& lookup (see section
39742 &<<SECTsinglekeylookups>>&). It writes a DBM file using the lower-cased alias
39743 names as keys and the remainder of the information as data. The lower-casing
39744 can be prevented by calling the program with the &%-nolc%& option.
39745
39746 A terminating zero is included as part of the key string. This is expected by
39747 the &(dbm)& lookup type. However, if the option &%-nozero%& is given,
39748 &'exim_dbmbuild'& creates files without terminating zeroes in either the key
39749 strings or the data strings. The &(dbmnz)& lookup type can be used with such
39750 files.
39751
39752 The program requires two arguments: the name of the input file (which can be a
39753 single hyphen to indicate the standard input), and the name of the output file.
39754 It creates the output under a temporary name, and then renames it if all went
39755 well.
39756
39757 .cindex "USE_DB"
39758 If the native DB interface is in use (USE_DB is set in a compile-time
39759 configuration file &-- this is common in free versions of Unix) the two
39760 filenames must be different, because in this mode the Berkeley DB functions
39761 create a single output file using exactly the name given. For example,
39762 .code
39763 exim_dbmbuild /etc/aliases /etc/aliases.db
39764 .endd
39765 reads the system alias file and creates a DBM version of it in
39766 &_/etc/aliases.db_&.
39767
39768 In systems that use the &'ndbm'& routines (mostly proprietary versions of
39769 Unix), two files are used, with the suffixes &_.dir_& and &_.pag_&. In this
39770 environment, the suffixes are added to the second argument of
39771 &'exim_dbmbuild'&, so it can be the same as the first. This is also the case
39772 when the Berkeley functions are used in compatibility mode (though this is not
39773 recommended), because in that case it adds a &_.db_& suffix to the filename.
39774
39775 If a duplicate key is encountered, the program outputs a warning, and when it
39776 finishes, its return code is 1 rather than zero, unless the &%-noduperr%&
39777 option is used. By default, only the first of a set of duplicates is used &--
39778 this makes it compatible with &(lsearch)& lookups. There is an option
39779 &%-lastdup%& which causes it to use the data for the last duplicate instead.
39780 There is also an option &%-nowarn%&, which stops it listing duplicate keys to
39781 &%stderr%&. For other errors, where it doesn't actually make a new file, the
39782 return code is 2.
39783
39784
39785
39786
39787 .section "Finding individual retry times (exinext)" "SECTfinindret"
39788 .cindex "retry" "times"
39789 .cindex "&'exinext'&"
39790 A utility called &'exinext'& (mostly a Perl script) provides the ability to
39791 fish specific information out of the retry database. Given a mail domain (or a
39792 complete address), it looks up the hosts for that domain, and outputs any retry
39793 information for the hosts or for the domain. At present, the retry information
39794 is obtained by running &'exim_dumpdb'& (see below) and post-processing the
39795 output. For example:
39796 .code
39797 $ exinext piglet@milne.fict.example
39798 kanga.milne.example:192.168.8.1 error 146: Connection refused
39799   first failed: 21-Feb-1996 14:57:34
39800   last tried:   21-Feb-1996 14:57:34
39801   next try at:  21-Feb-1996 15:02:34
39802 roo.milne.example:192.168.8.3 error 146: Connection refused
39803   first failed: 20-Jan-1996 13:12:08
39804   last tried:   21-Feb-1996 11:42:03
39805   next try at:  21-Feb-1996 19:42:03
39806   past final cutoff time
39807 .endd
39808 You can also give &'exinext'& a local part, without a domain, and it
39809 will give any retry information for that local part in your default domain.
39810 A message id can be used to obtain retry information pertaining to a specific
39811 message. This exists only when an attempt to deliver a message to a remote host
39812 suffers a message-specific error (see section &<<SECToutSMTPerr>>&).
39813 &'exinext'& is not particularly efficient, but then it is not expected to be
39814 run very often.
39815
39816 The &'exinext'& utility calls Exim to find out information such as the location
39817 of the spool directory. The utility has &%-C%& and &%-D%& options, which are
39818 passed on to the &'exim'& commands. The first specifies an alternate Exim
39819 configuration file, and the second sets macros for use within the configuration
39820 file. These features are mainly to help in testing, but might also be useful in
39821 environments where more than one configuration file is in use.
39822
39823
39824
39825 .section "Hints database maintenance" "SECThindatmai"
39826 .cindex "hints database" "maintenance"
39827 .cindex "maintaining Exim's hints database"
39828 Three utility programs are provided for maintaining the DBM files that Exim
39829 uses to contain its delivery hint information. Each program requires two
39830 arguments. The first specifies the name of Exim's spool directory, and the
39831 second is the name of the database it is to operate on. These are as follows:
39832
39833 .ilist
39834 &'retry'&: the database of retry information
39835 .next
39836 &'wait-'&<&'transport name'&>: databases of information about messages waiting
39837 for remote hosts
39838 .next
39839 &'callout'&: the callout cache
39840 .next
39841 &'ratelimit'&: the data for implementing the ratelimit ACL condition
39842 .next
39843 .new
39844 &'tls'&: TLS session resumption data
39845 .wen
39846 .next
39847 &'misc'&: other hints data
39848 .endlist
39849
39850 The &'misc'& database is used for
39851
39852 .ilist
39853 Serializing ETRN runs (when &%smtp_etrn_serialize%& is set)
39854 .next
39855 Serializing delivery to a specific host (when &%serialize_hosts%& is set in an
39856 &(smtp)& transport)
39857 .next
39858 Limiting the concurrency of specific transports (when &%max_parallel%& is set
39859 in a transport)
39860 .endlist
39861
39862
39863
39864 .section "exim_dumpdb" "SECTdumpdb"
39865 .cindex "&'exim_dumpdb'&"
39866 The entire contents of a database are written to the standard output by the
39867 &'exim_dumpdb'& program, which has no options or arguments other than the
39868 spool and database names. For example, to dump the retry database:
39869 .code
39870 exim_dumpdb /var/spool/exim retry
39871 .endd
39872 Two lines of output are produced for each entry:
39873 .code
39874 T:mail.ref.example:192.168.242.242 146 77 Connection refused
39875 31-Oct-1995 12:00:12 02-Nov-1995 12:21:39 02-Nov-1995 20:21:39 *
39876 .endd
39877 The first item on the first line is the key of the record. It starts with one
39878 of the letters R, or T, depending on whether it refers to a routing or
39879 transport retry. For a local delivery, the next part is the local address; for
39880 a remote delivery it is the name of the remote host, followed by its failing IP
39881 address (unless &%retry_include_ip_address%& is set false on the &(smtp)&
39882 transport). If the remote port is not the standard one (port 25), it is added
39883 to the IP address. Then there follows an error code, an additional error code,
39884 and a textual description of the error.
39885
39886 The three times on the second line are the time of first failure, the time of
39887 the last delivery attempt, and the computed time for the next attempt. The line
39888 ends with an asterisk if the cutoff time for the last retry rule has been
39889 exceeded.
39890
39891 Each output line from &'exim_dumpdb'& for the &'wait-xxx'& databases
39892 consists of a host name followed by a list of ids for messages that are or were
39893 waiting to be delivered to that host. If there are a very large number for any
39894 one host, continuation records, with a sequence number added to the host name,
39895 may be seen. The data in these records is often out of date, because a message
39896 may be routed to several alternative hosts, and Exim makes no effort to keep
39897 cross-references.
39898
39899
39900
39901 .section "exim_tidydb" "SECTtidydb"
39902 .cindex "&'exim_tidydb'&"
39903 The &'exim_tidydb'& utility program is used to tidy up the contents of a hints
39904 database. If run with no options, it removes all records that are more than 30
39905 days old. The age is calculated from the date and time that the record was last
39906 updated. Note that, in the case of the retry database, it is &'not'& the time
39907 since the first delivery failure. Information about a host that has been down
39908 for more than 30 days will remain in the database, provided that the record is
39909 updated sufficiently often.
39910
39911 The cutoff date can be altered by means of the &%-t%& option, which must be
39912 followed by a time. For example, to remove all records older than a week from
39913 the retry database:
39914 .code
39915 exim_tidydb -t 7d /var/spool/exim retry
39916 .endd
39917 Both the &'wait-xxx'& and &'retry'& databases contain items that involve
39918 message ids. In the former these appear as data in records keyed by host &--
39919 they were messages that were waiting for that host &-- and in the latter they
39920 are the keys for retry information for messages that have suffered certain
39921 types of error. When &'exim_tidydb'& is run, a check is made to ensure that
39922 message ids in database records are those of messages that are still on the
39923 queue. Message ids for messages that no longer exist are removed from
39924 &'wait-xxx'& records, and if this leaves any records empty, they are deleted.
39925 For the &'retry'& database, records whose keys are non-existent message ids are
39926 removed. The &'exim_tidydb'& utility outputs comments on the standard output
39927 whenever it removes information from the database.
39928
39929 Certain records are automatically removed by Exim when they are no longer
39930 needed, but others are not. For example, if all the MX hosts for a domain are
39931 down, a retry record is created for each one. If the primary MX host comes back
39932 first, its record is removed when Exim successfully delivers to it, but the
39933 records for the others remain because Exim has not tried to use those hosts.
39934
39935 It is important, therefore, to run &'exim_tidydb'& periodically on all the
39936 hints databases. You should do this at a quiet time of day, because it requires
39937 a database to be locked (and therefore inaccessible to Exim) while it does its
39938 work. Removing records from a DBM file does not normally make the file smaller,
39939 but all the common DBM libraries are able to re-use the space that is released.
39940 After an initial phase of increasing in size, the databases normally reach a
39941 point at which they no longer get any bigger, as long as they are regularly
39942 tidied.
39943
39944 &*Warning*&: If you never run &'exim_tidydb'&, the space used by the hints
39945 databases is likely to keep on increasing.
39946
39947
39948
39949
39950 .section "exim_fixdb" "SECTfixdb"
39951 .cindex "&'exim_fixdb'&"
39952 The &'exim_fixdb'& program is a utility for interactively modifying databases.
39953 Its main use is for testing Exim, but it might also be occasionally useful for
39954 getting round problems in a live system. It has no options, and its interface
39955 is somewhat crude. On entry, it prompts for input with a right angle-bracket. A
39956 key of a database record can then be entered, and the data for that record is
39957 displayed.
39958
39959 If &"d"& is typed at the next prompt, the entire record is deleted. For all
39960 except the &'retry'& database, that is the only operation that can be carried
39961 out. For the &'retry'& database, each field is output preceded by a number, and
39962 data for individual fields can be changed by typing the field number followed
39963 by new data, for example:
39964 .code
39965 > 4 951102:1000
39966 .endd
39967 resets the time of the next delivery attempt. Time values are given as a
39968 sequence of digit pairs for year, month, day, hour, and minute. Colons can be
39969 used as optional separators.
39970
39971
39972
39973
39974 .section "Mailbox maintenance (exim_lock)" "SECTmailboxmaint"
39975 .cindex "mailbox" "maintenance"
39976 .cindex "&'exim_lock'&"
39977 .cindex "locking mailboxes"
39978 The &'exim_lock'& utility locks a mailbox file using the same algorithm as
39979 Exim. For a discussion of locking issues, see section &<<SECTopappend>>&.
39980 &'Exim_lock'& can be used to prevent any modification of a mailbox by Exim or
39981 a user agent while investigating a problem. The utility requires the name of
39982 the file as its first argument. If the locking is successful, the second
39983 argument is run as a command (using C's &[system()]& function); if there is no
39984 second argument, the value of the SHELL environment variable is used; if this
39985 is unset or empty, &_/bin/sh_& is run. When the command finishes, the mailbox
39986 is unlocked and the utility ends. The following options are available:
39987
39988 .vlist
39989 .vitem &%-fcntl%&
39990 Use &[fcntl()]& locking on the open mailbox.
39991
39992 .vitem &%-flock%&
39993 Use &[flock()]& locking on the open mailbox, provided the operating system
39994 supports it.
39995
39996 .vitem &%-interval%&
39997 This must be followed by a number, which is a number of seconds; it sets the
39998 interval to sleep between retries (default 3).
39999
40000 .vitem &%-lockfile%&
40001 Create a lock file before opening the mailbox.
40002
40003 .vitem &%-mbx%&
40004 Lock the mailbox using MBX rules.
40005
40006 .vitem &%-q%&
40007 Suppress verification output.
40008
40009 .vitem &%-retries%&
40010 This must be followed by a number; it sets the number of times to try to get
40011 the lock (default 10).
40012
40013 .vitem &%-restore_time%&
40014 This option causes &%exim_lock%& to restore the modified and read times to the
40015 locked file before exiting. This allows you to access a locked mailbox (for
40016 example, to take a backup copy) without disturbing the times that the user
40017 subsequently sees.
40018
40019 .vitem &%-timeout%&
40020 This must be followed by a number, which is a number of seconds; it sets a
40021 timeout to be used with a blocking &[fcntl()]& lock. If it is not set (the
40022 default), a non-blocking call is used.
40023
40024 .vitem &%-v%&
40025 Generate verbose output.
40026 .endlist
40027
40028 If none of &%-fcntl%&, &%-flock%&, &%-lockfile%& or &%-mbx%& are given, the
40029 default is to create a lock file and also to use &[fcntl()]& locking on the
40030 mailbox, which is the same as Exim's default. The use of &%-flock%& or
40031 &%-fcntl%& requires that the file be writeable; the use of &%-lockfile%&
40032 requires that the directory containing the file be writeable. Locking by lock
40033 file does not last forever; Exim assumes that a lock file is expired if it is
40034 more than 30 minutes old.
40035
40036 The &%-mbx%& option can be used with either or both of &%-fcntl%& or
40037 &%-flock%&. It assumes &%-fcntl%& by default. MBX locking causes a shared lock
40038 to be taken out on the open mailbox, and an exclusive lock on the file
40039 &_/tmp/.n.m_& where &'n'& and &'m'& are the device number and inode
40040 number of the mailbox file. When the locking is released, if an exclusive lock
40041 can be obtained for the mailbox, the file in &_/tmp_& is deleted.
40042
40043 The default output contains verification of the locking that takes place. The
40044 &%-v%& option causes some additional information to be given. The &%-q%& option
40045 suppresses all output except error messages.
40046
40047 A command such as
40048 .code
40049 exim_lock /var/spool/mail/spqr
40050 .endd
40051 runs an interactive shell while the file is locked, whereas
40052 .display
40053 &`exim_lock -q /var/spool/mail/spqr <<End`&
40054 <&'some commands'&>
40055 &`End`&
40056 .endd
40057 runs a specific non-interactive sequence of commands while the file is locked,
40058 suppressing all verification output. A single command can be run by a command
40059 such as
40060 .code
40061 exim_lock -q /var/spool/mail/spqr \
40062   "cp /var/spool/mail/spqr /some/where"
40063 .endd
40064 Note that if a command is supplied, it must be entirely contained within the
40065 second argument &-- hence the quotes.
40066 .ecindex IIDutils
40067
40068
40069 . ////////////////////////////////////////////////////////////////////////////
40070 . ////////////////////////////////////////////////////////////////////////////
40071
40072 .chapter "The Exim monitor" "CHAPeximon"
40073 .scindex IIDeximon "Exim monitor" "description"
40074 .cindex "X-windows"
40075 .cindex "&'eximon'&"
40076 .cindex "Local/eximon.conf"
40077 .cindex "&_exim_monitor/EDITME_&"
40078 The Exim monitor is an application which displays in an X window information
40079 about the state of Exim's queue and what Exim is doing. An admin user can
40080 perform certain operations on messages from this GUI interface; however all
40081 such facilities are also available from the command line, and indeed, the
40082 monitor itself makes use of the command line to perform any actions requested.
40083
40084
40085
40086 .section "Running the monitor" "SECID264"
40087 The monitor is started by running the script called &'eximon'&. This is a shell
40088 script that sets up a number of environment variables, and then runs the
40089 binary called &_eximon.bin_&. The default appearance of the monitor window can
40090 be changed by editing the &_Local/eximon.conf_& file created by editing
40091 &_exim_monitor/EDITME_&. Comments in that file describe what the various
40092 parameters are for.
40093
40094 The parameters that get built into the &'eximon'& script can be overridden for
40095 a particular invocation by setting up environment variables of the same names,
40096 preceded by &`EXIMON_`&. For example, a shell command such as
40097 .code
40098 EXIMON_LOG_DEPTH=400 eximon
40099 .endd
40100 (in a Bourne-compatible shell) runs &'eximon'& with an overriding setting of
40101 the LOG_DEPTH parameter. If EXIMON_LOG_FILE_PATH is set in the environment, it
40102 overrides the Exim log file configuration. This makes it possible to have
40103 &'eximon'& tailing log data that is written to syslog, provided that MAIL.INFO
40104 syslog messages are routed to a file on the local host.
40105
40106 X resources can be used to change the appearance of the window in the normal
40107 way. For example, a resource setting of the form
40108 .code
40109 Eximon*background: gray94
40110 .endd
40111 changes the colour of the background to light grey rather than white. The
40112 stripcharts are drawn with both the data lines and the reference lines in
40113 black. This means that the reference lines are not visible when on top of the
40114 data. However, their colour can be changed by setting a resource called
40115 &"highlight"& (an odd name, but that's what the Athena stripchart widget uses).
40116 For example, if your X server is running Unix, you could set up lighter
40117 reference lines in the stripcharts by obeying
40118 .code
40119 xrdb -merge <<End
40120 Eximon*highlight: gray
40121 End
40122 .endd
40123 .cindex "admin user"
40124 In order to see the contents of messages in the queue, and to operate on them,
40125 &'eximon'& must either be run as root or by an admin user.
40126
40127 The command-line parameters of &'eximon'& are passed to &_eximon.bin_& and may
40128 contain X11 resource parameters interpreted by the X11 library.  In addition,
40129 if the first parameter starts with the string "gdb" then it is removed and the
40130 binary is invoked under gdb (the parameter is used as the gdb command-name, so
40131 versioned variants of gdb can be invoked).
40132
40133 The monitor's window is divided into three parts. The first contains one or
40134 more stripcharts and two action buttons, the second contains a &"tail"& of the
40135 main log file, and the third is a display of the queue of messages awaiting
40136 delivery, with two more action buttons. The following sections describe these
40137 different parts of the display.
40138
40139
40140
40141
40142 .section "The stripcharts" "SECID265"
40143 .cindex "stripchart"
40144 The first stripchart is always a count of messages in the queue. Its name can
40145 be configured by setting QUEUE_STRIPCHART_NAME in the
40146 &_Local/eximon.conf_& file. The remaining stripcharts are defined in the
40147 configuration script by regular expression matches on log file entries, making
40148 it possible to display, for example, counts of messages delivered to certain
40149 hosts or using certain transports. The supplied defaults display counts of
40150 received and delivered messages, and of local and SMTP deliveries. The default
40151 period between stripchart updates is one minute; this can be adjusted by a
40152 parameter in the &_Local/eximon.conf_& file.
40153
40154 The stripchart displays rescale themselves automatically as the value they are
40155 displaying changes. There are always 10 horizontal lines in each chart; the
40156 title string indicates the value of each division when it is greater than one.
40157 For example, &"x2"& means that each division represents a value of 2.
40158
40159 It is also possible to have a stripchart which shows the percentage fullness of
40160 a particular disk partition, which is useful when local deliveries are confined
40161 to a single partition.
40162
40163 .cindex "&%statvfs%& function"
40164 This relies on the availability of the &[statvfs()]& function or equivalent in
40165 the operating system. Most, but not all versions of Unix that support Exim have
40166 this. For this particular stripchart, the top of the chart always represents
40167 100%, and the scale is given as &"x10%"&. This chart is configured by setting
40168 SIZE_STRIPCHART and (optionally) SIZE_STRIPCHART_NAME in the
40169 &_Local/eximon.conf_& file.
40170
40171
40172
40173
40174 .section "Main action buttons" "SECID266"
40175 .cindex "size" "of monitor window"
40176 .cindex "Exim monitor" "window size"
40177 .cindex "window size"
40178 Below the stripcharts there is an action button for quitting the monitor. Next
40179 to this is another button marked &"Size"&. They are placed here so that
40180 shrinking the window to its default minimum size leaves just the queue count
40181 stripchart and these two buttons visible. Pressing the &"Size"& button causes
40182 the window to expand to its maximum size, unless it is already at the maximum,
40183 in which case it is reduced to its minimum.
40184
40185 When expanding to the maximum, if the window cannot be fully seen where it
40186 currently is, it is moved back to where it was the last time it was at full
40187 size. When it is expanding from its minimum size, the old position is
40188 remembered, and next time it is reduced to the minimum it is moved back there.
40189
40190 The idea is that you can keep a reduced window just showing one or two
40191 stripcharts at a convenient place on your screen, easily expand it to show
40192 the full window when required, and just as easily put it back to what it was.
40193 The idea is copied from what the &'twm'& window manager does for its
40194 &'f.fullzoom'& action. The minimum size of the window can be changed by setting
40195 the MIN_HEIGHT and MIN_WIDTH values in &_Local/eximon.conf_&.
40196
40197 Normally, the monitor starts up with the window at its full size, but it can be
40198 built so that it starts up with the window at its smallest size, by setting
40199 START_SMALL=yes in &_Local/eximon.conf_&.
40200
40201
40202
40203 .section "The log display" "SECID267"
40204 .cindex "log" "tail of; in monitor"
40205 The second section of the window is an area in which a display of the tail of
40206 the main log is maintained.
40207 To save space on the screen, the timestamp on each log line is shortened by
40208 removing the date and, if &%log_timezone%& is set, the timezone.
40209 The log tail is not available when the only destination for logging data is
40210 syslog, unless the syslog lines are routed to a local file whose name is passed
40211 to &'eximon'& via the EXIMON_LOG_FILE_PATH environment variable.
40212
40213 The log sub-window has a scroll bar at its lefthand side which can be used to
40214 move back to look at earlier text, and the up and down arrow keys also have a
40215 scrolling effect. The amount of log that is kept depends on the setting of
40216 LOG_BUFFER in &_Local/eximon.conf_&, which specifies the amount of memory
40217 to use. When this is full, the earlier 50% of data is discarded &-- this is
40218 much more efficient than throwing it away line by line. The sub-window also has
40219 a horizontal scroll bar for accessing the ends of long log lines. This is the
40220 only means of horizontal scrolling; the right and left arrow keys are not
40221 available. Text can be cut from this part of the window using the mouse in the
40222 normal way. The size of this subwindow is controlled by parameters in the
40223 configuration file &_Local/eximon.conf_&.
40224
40225 Searches of the text in the log window can be carried out by means of the ^R
40226 and ^S keystrokes, which default to a reverse and a forward search,
40227 respectively. The search covers only the text that is displayed in the window.
40228 It cannot go further back up the log.
40229
40230 The point from which the search starts is indicated by a caret marker. This is
40231 normally at the end of the text in the window, but can be positioned explicitly
40232 by pointing and clicking with the left mouse button, and is moved automatically
40233 by a successful search. If new text arrives in the window when it is scrolled
40234 back, the caret remains where it is, but if the window is not scrolled back,
40235 the caret is moved to the end of the new text.
40236
40237 Pressing ^R or ^S pops up a window into which the search text can be typed.
40238 There are buttons for selecting forward or reverse searching, for carrying out
40239 the search, and for cancelling. If the &"Search"& button is pressed, the search
40240 happens and the window remains so that further searches can be done. If the
40241 &"Return"& key is pressed, a single search is done and the window is closed. If
40242 ^C is typed the search is cancelled.
40243
40244 The searching facility is implemented using the facilities of the Athena text
40245 widget. By default this pops up a window containing both &"search"& and
40246 &"replace"& options. In order to suppress the unwanted &"replace"& portion for
40247 eximon, a modified version of the &%TextPop%& widget is distributed with Exim.
40248 However, the linkers in BSDI and HP-UX seem unable to handle an externally
40249 provided version of &%TextPop%& when the remaining parts of the text widget
40250 come from the standard libraries. The compile-time option EXIMON_TEXTPOP can be
40251 unset to cut out the modified &%TextPop%&, making it possible to build Eximon
40252 on these systems, at the expense of having unwanted items in the search popup
40253 window.
40254
40255
40256
40257 .section "The queue display" "SECID268"
40258 .cindex "queue" "display in monitor"
40259 The bottom section of the monitor window contains a list of all messages that
40260 are in the queue, which includes those currently being received or delivered,
40261 as well as those awaiting delivery. The size of this subwindow is controlled by
40262 parameters in the configuration file &_Local/eximon.conf_&, and the frequency
40263 at which it is updated is controlled by another parameter in the same file &--
40264 the default is 5 minutes, since queue scans can be quite expensive. However,
40265 there is an &"Update"& action button just above the display which can be used
40266 to force an update of the queue display at any time.
40267
40268 When a host is down for some time, a lot of pending mail can build up for it,
40269 and this can make it hard to deal with other messages in the queue. To help
40270 with this situation there is a button next to &"Update"& called &"Hide"&. If
40271 pressed, a dialogue box called &"Hide addresses ending with"& is put up. If you
40272 type anything in here and press &"Return"&, the text is added to a chain of
40273 such texts, and if every undelivered address in a message matches at least one
40274 of the texts, the message is not displayed.
40275
40276 If there is an address that does not match any of the texts, all the addresses
40277 are displayed as normal. The matching happens on the ends of addresses so, for
40278 example, &'cam.ac.uk'& specifies all addresses in Cambridge, while
40279 &'xxx@foo.com.example'& specifies just one specific address. When any hiding
40280 has been set up, a button called &"Unhide"& is displayed. If pressed, it
40281 cancels all hiding. Also, to ensure that hidden messages do not get forgotten,
40282 a hide request is automatically cancelled after one hour.
40283
40284 While the dialogue box is displayed, you can't press any buttons or do anything
40285 else to the monitor window. For this reason, if you want to cut text from the
40286 queue display to use in the dialogue box, you have to do the cutting before
40287 pressing the &"Hide"& button.
40288
40289 The queue display contains, for each unhidden queued message, the length of
40290 time it has been in the queue, the size of the message, the message id, the
40291 message sender, and the first undelivered recipient, all on one line. If it is
40292 a bounce message, the sender is shown as &"<>"&. If there is more than one
40293 recipient to which the message has not yet been delivered, subsequent ones are
40294 listed on additional lines, up to a maximum configured number, following which
40295 an ellipsis is displayed. Recipients that have already received the message are
40296 not shown.
40297
40298 .cindex "frozen messages" "display"
40299 If a message is frozen, an asterisk is displayed at the left-hand side.
40300
40301 The queue display has a vertical scroll bar, and can also be scrolled by means
40302 of the arrow keys. Text can be cut from it using the mouse in the normal way.
40303 The text searching facilities, as described above for the log window, are also
40304 available, but the caret is always moved to the end of the text when the queue
40305 display is updated.
40306
40307
40308
40309 .section "The queue menu" "SECID269"
40310 .cindex "queue" "menu in monitor"
40311 If the &%shift%& key is held down and the left button is clicked when the mouse
40312 pointer is over the text for any message, an action menu pops up, and the first
40313 line of the queue display for the message is highlighted. This does not affect
40314 any selected text.
40315
40316 If you want to use some other event for popping up the menu, you can set the
40317 MENU_EVENT parameter in &_Local/eximon.conf_& to change the default, or
40318 set EXIMON_MENU_EVENT in the environment before starting the monitor. The
40319 value set in this parameter is a standard X event description. For example, to
40320 run eximon using &%ctrl%& rather than &%shift%& you could use
40321 .code
40322 EXIMON_MENU_EVENT='Ctrl<Btn1Down>' eximon
40323 .endd
40324 The title of the menu is the message id, and it contains entries which act as
40325 follows:
40326
40327 .ilist
40328 &'message log'&: The contents of the message log for the message are displayed
40329 in a new text window.
40330 .next
40331 &'headers'&: Information from the spool file that contains the envelope
40332 information and headers is displayed in a new text window. See chapter
40333 &<<CHAPspool>>& for a description of the format of spool files.
40334 .next
40335 &'body'&: The contents of the spool file containing the body of the message are
40336 displayed in a new text window. There is a default limit of 20,000 bytes to the
40337 amount of data displayed. This can be changed by setting the BODY_MAX
40338 option at compile time, or the EXIMON_BODY_MAX option at runtime.
40339 .next
40340 &'deliver message'&: A call to Exim is made using the &%-M%& option to request
40341 delivery of the message. This causes an automatic thaw if the message is
40342 frozen. The &%-v%& option is also set, and the output from Exim is displayed in
40343 a new text window. The delivery is run in a separate process, to avoid holding
40344 up the monitor while the delivery proceeds.
40345 .next
40346 &'freeze message'&: A call to Exim is made using the &%-Mf%& option to request
40347 that the message be frozen.
40348 .next
40349 .cindex "thawing messages"
40350 .cindex "unfreezing messages"
40351 .cindex "frozen messages" "thawing"
40352 &'thaw message'&: A call to Exim is made using the &%-Mt%& option to request
40353 that the message be thawed.
40354 .next
40355 .cindex "delivery" "forcing failure"
40356 &'give up on msg'&: A call to Exim is made using the &%-Mg%& option to request
40357 that Exim gives up trying to deliver the message. A bounce message is generated
40358 for any remaining undelivered addresses.
40359 .next
40360 &'remove message'&: A call to Exim is made using the &%-Mrm%& option to request
40361 that the message be deleted from the system without generating a bounce
40362 message.
40363 .next
40364 &'add recipient'&: A dialog box is displayed into which a recipient address can
40365 be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
40366 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
40367 Otherwise it must be entered as a fully qualified address. Pressing RETURN
40368 causes a call to Exim to be made using the &%-Mar%& option to request that an
40369 additional recipient be added to the message, unless the entry box is empty, in
40370 which case no action is taken.
40371 .next
40372 &'mark delivered'&: A dialog box is displayed into which a recipient address
40373 can be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
40374 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
40375 Otherwise it must be entered as a fully qualified address. Pressing RETURN
40376 causes a call to Exim to be made using the &%-Mmd%& option to mark the given
40377 recipient address as already delivered, unless the entry box is empty, in which
40378 case no action is taken.
40379 .next
40380 &'mark all delivered'&: A call to Exim is made using the &%-Mmad%& option to
40381 mark all recipient addresses as already delivered.
40382 .next
40383 &'edit sender'&: A dialog box is displayed initialized with the current
40384 sender's address. Pressing RETURN causes a call to Exim to be made using the
40385 &%-Mes%& option to replace the sender address, unless the entry box is empty,
40386 in which case no action is taken. If you want to set an empty sender (as in
40387 bounce messages), you must specify it as &"<>"&. Otherwise, if the address is
40388 not qualified and the QUALIFY_DOMAIN parameter is set in &_Local/eximon.conf_&,
40389 the address is qualified with that domain.
40390 .endlist
40391
40392 When a delivery is forced, a window showing the &%-v%& output is displayed. In
40393 other cases when a call to Exim is made, if there is any output from Exim (in
40394 particular, if the command fails) a window containing the command and the
40395 output is displayed. Otherwise, the results of the action are normally apparent
40396 from the log and queue displays. However, if you set ACTION_OUTPUT=yes in
40397 &_Local/eximon.conf_&, a window showing the Exim command is always opened, even
40398 if no output is generated.
40399
40400 The queue display is automatically updated for actions such as freezing and
40401 thawing, unless ACTION_QUEUE_UPDATE=no has been set in
40402 &_Local/eximon.conf_&. In this case the &"Update"& button has to be used to
40403 force an update of the display after one of these actions.
40404
40405 In any text window that is displayed as result of a menu action, the normal
40406 cut-and-paste facility is available, and searching can be carried out using ^R
40407 and ^S, as described above for the log tail window.
40408 .ecindex IIDeximon
40409
40410
40411
40412
40413
40414 . ////////////////////////////////////////////////////////////////////////////
40415 . ////////////////////////////////////////////////////////////////////////////
40416
40417 .chapter "Security considerations" "CHAPsecurity"
40418 .scindex IIDsecurcon "security" "discussion of"
40419 This chapter discusses a number of issues concerned with security, some of
40420 which are also covered in other parts of this manual.
40421
40422 For reasons that this author does not understand, some people have promoted
40423 Exim as a &"particularly secure"& mailer. Perhaps it is because of the
40424 existence of this chapter in the documentation. However, the intent of the
40425 chapter is simply to describe the way Exim works in relation to certain
40426 security concerns, not to make any specific claims about the effectiveness of
40427 its security as compared with other MTAs.
40428
40429 What follows is a description of the way Exim is supposed to be. Best efforts
40430 have been made to try to ensure that the code agrees with the theory, but an
40431 absence of bugs can never be guaranteed. Any that are reported will get fixed
40432 as soon as possible.
40433
40434
40435 .section "Building a more &""hardened""& Exim" "SECID286"
40436 .cindex "security" "build-time features"
40437 There are a number of build-time options that can be set in &_Local/Makefile_&
40438 to create Exim binaries that are &"harder"& to attack, in particular by a rogue
40439 Exim administrator who does not have the root password, or by someone who has
40440 penetrated the Exim (but not the root) account. These options are as follows:
40441
40442 .ilist
40443 ALT_CONFIG_PREFIX can be set to a string that is required to match the
40444 start of any filenames used with the &%-C%& option. When it is set, these
40445 filenames are also not allowed to contain the sequence &"/../"&. (However, if
40446 the value of the &%-C%& option is identical to the value of CONFIGURE_FILE in
40447 &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as usual.) There is no
40448 default setting for &%ALT_CONFIG_PREFIX%&.
40449
40450 If the permitted configuration files are confined to a directory to
40451 which only root has access, this guards against someone who has broken
40452 into the Exim account from running a privileged Exim with an arbitrary
40453 configuration file, and using it to break into other accounts.
40454 .next
40455
40456 If a non-trusted configuration file (i.e. not the default configuration file
40457 or one which is trusted by virtue of being listed in the TRUSTED_CONFIG_LIST
40458 file) is specified with &%-C%&, or if macros are given with &%-D%& (but see
40459 the next item), then root privilege is retained only if the caller of Exim is
40460 root. This locks out the possibility of testing a configuration using &%-C%&
40461 right through message reception and delivery, even if the caller is root. The
40462 reception works, but by that time, Exim is running as the Exim user, so when
40463 it re-execs to regain privilege for the delivery, the use of &%-C%& causes
40464 privilege to be lost. However, root can test reception and delivery using two
40465 separate commands.
40466
40467 .next
40468 The WHITELIST_D_MACROS build option declares some macros to be safe to override
40469 with &%-D%& if the real uid is one of root, the Exim run-time user or the
40470 CONFIGURE_OWNER, if defined.  The potential impact of this option is limited by
40471 requiring the run-time value supplied to &%-D%& to match a regex that errs on
40472 the restrictive side.  Requiring build-time selection of safe macros is onerous
40473 but this option is intended solely as a transition mechanism to permit
40474 previously-working configurations to continue to work after release 4.73.
40475 .next
40476 If DISABLE_D_OPTION is defined, the use of the &%-D%& command line option
40477 is disabled.
40478 .next
40479 FIXED_NEVER_USERS can be set to a colon-separated list of users that are
40480 never to be used for any deliveries. This is like the &%never_users%& runtime
40481 option, but it cannot be overridden; the runtime option adds additional users
40482 to the list. The default setting is &"root"&; this prevents a non-root user who
40483 is permitted to modify the runtime file from using Exim as a way to get root.
40484 .endlist
40485
40486
40487
40488 .section "Root privilege" "SECID270"
40489 .cindex "setuid"
40490 .cindex "root privilege"
40491 The Exim binary is normally setuid to root, which means that it gains root
40492 privilege (runs as root) when it starts execution. In some special cases (for
40493 example, when the daemon is not in use and there are no local deliveries), it
40494 may be possible to run Exim setuid to some user other than root. This is
40495 discussed in the next section. However, in most installations, root privilege
40496 is required for two things:
40497
40498 .ilist
40499 To set up a socket connected to the standard SMTP port (25) when initialising
40500 the listening daemon. If Exim is run from &'inetd'&, this privileged action is
40501 not required.
40502 .next
40503 To be able to change uid and gid in order to read users' &_.forward_& files and
40504 perform local deliveries as the receiving user or as specified in the
40505 configuration.
40506 .endlist
40507
40508 It is not necessary to be root to do any of the other things Exim does, such as
40509 receiving messages and delivering them externally over SMTP, and it is
40510 obviously more secure if Exim does not run as root except when necessary.
40511 For this reason, a user and group for Exim to use must be defined in
40512 &_Local/Makefile_&. These are known as &"the Exim user"& and &"the Exim
40513 group"&. Their values can be changed by the runtime configuration, though this
40514 is not recommended. Often a user called &'exim'& is used, but some sites use
40515 &'mail'& or another user name altogether.
40516
40517 Exim uses &[setuid()]& whenever it gives up root privilege. This is a permanent
40518 abdication; the process cannot regain root afterwards. Prior to release 4.00,
40519 &[seteuid()]& was used in some circumstances, but this is no longer the case.
40520
40521 After a new Exim process has interpreted its command line options, it changes
40522 uid and gid in the following cases:
40523
40524 .ilist
40525 .oindex "&%-C%&"
40526 .oindex "&%-D%&"
40527 If the &%-C%& option is used to specify an alternate configuration file, or if
40528 the &%-D%& option is used to define macro values for the configuration, and the
40529 calling process is not running as root, the uid and gid are changed to those of
40530 the calling process.
40531 However, if DISABLE_D_OPTION is defined in &_Local/Makefile_&, the &%-D%&
40532 option may not be used at all.
40533 If WHITELIST_D_MACROS is defined in &_Local/Makefile_&, then some macro values
40534 can be supplied if the calling process is running as root, the Exim run-time
40535 user or CONFIGURE_OWNER, if defined.
40536 .next
40537 .oindex "&%-be%&"
40538 .oindex "&%-bf%&"
40539 .oindex "&%-bF%&"
40540 If the expansion test option (&%-be%&) or one of the filter testing options
40541 (&%-bf%& or &%-bF%&) are used, the uid and gid are changed to those of the
40542 calling process.
40543 .next
40544 If the process is not a daemon process or a queue runner process or a delivery
40545 process or a process for testing address routing (started with &%-bt%&), the
40546 uid and gid are changed to the Exim user and group. This means that Exim always
40547 runs under its own uid and gid when receiving messages. This also applies when
40548 testing address verification
40549 .oindex "&%-bv%&"
40550 .oindex "&%-bh%&"
40551 (the &%-bv%& option) and testing incoming message policy controls (the &%-bh%&
40552 option).
40553 .next
40554 For a daemon, queue runner, delivery, or address testing process, the uid
40555 remains as root at this stage, but the gid is changed to the Exim group.
40556 .endlist
40557
40558 The processes that initially retain root privilege behave as follows:
40559
40560 .ilist
40561 A daemon process changes the gid to the Exim group and the uid to the Exim
40562 user after setting up one or more listening sockets. The &[initgroups()]&
40563 function is called, so that if the Exim user is in any additional groups, they
40564 will be used during message reception.
40565 .next
40566 A queue runner process retains root privilege throughout its execution. Its
40567 job is to fork a controlled sequence of delivery processes.
40568 .next
40569 A delivery process retains root privilege throughout most of its execution,
40570 but any actual deliveries (that is, the transports themselves) are run in
40571 subprocesses which always change to a non-root uid and gid. For local
40572 deliveries this is typically the uid and gid of the owner of the mailbox; for
40573 remote deliveries, the Exim uid and gid are used. Once all the delivery
40574 subprocesses have been run, a delivery process changes to the Exim uid and gid
40575 while doing post-delivery tidying up such as updating the retry database and
40576 generating bounce and warning messages.
40577
40578 While the recipient addresses in a message are being routed, the delivery
40579 process runs as root. However, if a user's filter file has to be processed,
40580 this is done in a subprocess that runs under the individual user's uid and
40581 gid. A system filter is run as root unless &%system_filter_user%& is set.
40582 .next
40583 A process that is testing addresses (the &%-bt%& option) runs as root so that
40584 the routing is done in the same environment as a message delivery.
40585 .endlist
40586
40587
40588
40589
40590 .section "Running Exim without privilege" "SECTrunexiwitpri"
40591 .cindex "privilege, running without"
40592 .cindex "unprivileged running"
40593 .cindex "root privilege" "running without"
40594 Some installations like to run Exim in an unprivileged state for more of its
40595 operation, for added security. Support for this mode of operation is provided
40596 by the global option &%deliver_drop_privilege%&. When this is set, the uid and
40597 gid are changed to the Exim user and group at the start of a delivery process
40598 (and also queue runner and address testing processes). This means that address
40599 routing is no longer run as root, and the deliveries themselves cannot change
40600 to any other uid.
40601
40602 .cindex SIGHUP
40603 .cindex "daemon" "restarting"
40604 Leaving the binary setuid to root, but setting &%deliver_drop_privilege%& means
40605 that the daemon can still be started in the usual way, and it can respond
40606 correctly to SIGHUP because the re-invocation regains root privilege.
40607
40608 An alternative approach is to make Exim setuid to the Exim user and also setgid
40609 to the Exim group. If you do this, the daemon must be started from a root
40610 process. (Calling Exim from a root process makes it behave in the way it does
40611 when it is setuid root.) However, the daemon cannot restart itself after a
40612 SIGHUP signal because it cannot regain privilege.
40613
40614 It is still useful to set &%deliver_drop_privilege%& in this case, because it
40615 stops Exim from trying to re-invoke itself to do a delivery after a message has
40616 been received. Such a re-invocation is a waste of resources because it has no
40617 effect.
40618
40619 If restarting the daemon is not an issue (for example, if &%mua_wrapper%& is
40620 set, or &'inetd'& is being used instead of a daemon), having the binary setuid
40621 to the Exim user seems a clean approach, but there is one complication:
40622
40623 In this style of operation, Exim is running with the real uid and gid set to
40624 those of the calling process, and the effective uid/gid set to Exim's values.
40625 Ideally, any association with the calling process' uid/gid should be dropped,
40626 that is, the real uid/gid should be reset to the effective values so as to
40627 discard any privileges that the caller may have. While some operating systems
40628 have a function that permits this action for a non-root effective uid, quite a
40629 number of them do not. Because of this lack of standardization, Exim does not
40630 address this problem at this time.
40631
40632 For this reason, the recommended approach for &"mostly unprivileged"& running
40633 is to keep the Exim binary setuid to root, and to set
40634 &%deliver_drop_privilege%&. This also has the advantage of allowing a daemon to
40635 be used in the most straightforward way.
40636
40637 If you configure Exim not to run delivery processes as root, there are a
40638 number of restrictions on what you can do:
40639
40640 .ilist
40641 You can deliver only as the Exim user/group. You should  explicitly use the
40642 &%user%& and &%group%& options to override routers or local transports that
40643 normally deliver as the recipient. This makes sure that configurations that
40644 work in this mode function the same way in normal mode. Any implicit or
40645 explicit specification of another user causes an error.
40646 .next
40647 Use of &_.forward_& files is severely restricted, such that it is usually
40648 not worthwhile to include them in the configuration.
40649 .next
40650 Users who wish to use &_.forward_& would have to make their home directory and
40651 the file itself accessible to the Exim user. Pipe and append-to-file entries,
40652 and their equivalents in Exim filters, cannot be used. While they could be
40653 enabled in the Exim user's name, that would be insecure and not very useful.
40654 .next
40655 Unless the local user mailboxes are all owned by the Exim user (possible in
40656 some POP3 or IMAP-only environments):
40657
40658 .olist
40659 They must be owned by the Exim group and be writeable by that group. This
40660 implies you must set &%mode%& in the appendfile configuration, as well as the
40661 mode of the mailbox files themselves.
40662 .next
40663 You must set &%no_check_owner%&, since most or all of the files will not be
40664 owned by the Exim user.
40665 .next
40666 You must set &%file_must_exist%&, because Exim cannot set the owner correctly
40667 on a newly created mailbox when unprivileged. This also implies that new
40668 mailboxes need to be created manually.
40669 .endlist olist
40670 .endlist ilist
40671
40672
40673 These restrictions severely restrict what can be done in local deliveries.
40674 However, there are no restrictions on remote deliveries. If you are running a
40675 gateway host that does no local deliveries, setting &%deliver_drop_privilege%&
40676 gives more security at essentially no cost.
40677
40678 If you are using the &%mua_wrapper%& facility (see chapter
40679 &<<CHAPnonqueueing>>&), &%deliver_drop_privilege%& is forced to be true.
40680
40681
40682
40683
40684 .section "Delivering to local files" "SECID271"
40685 Full details of the checks applied by &(appendfile)& before it writes to a file
40686 are given in chapter &<<CHAPappendfile>>&.
40687
40688
40689
40690 .section "Running local commands" "SECTsecconslocalcmds"
40691 .cindex "security" "local commands"
40692 .cindex "security" "command injection attacks"
40693 There are a number of ways in which an administrator can configure Exim to run
40694 commands based upon received, untrustworthy, data. Further, in some
40695 configurations a user who can control a &_.forward_& file can also arrange to
40696 run commands. Configuration to check includes, but is not limited to:
40697
40698 .ilist
40699 Use of &%use_shell%& in the pipe transport: various forms of shell command
40700 injection may be possible with this option present. It is dangerous and should
40701 be used only with considerable caution. Consider constraints which whitelist
40702 allowed characters in a variable which is to be used in a pipe transport that
40703 has &%use_shell%& enabled.
40704 .next
40705 A number of options such as &%forbid_filter_run%&, &%forbid_filter_perl%&,
40706 &%forbid_filter_dlfunc%& and so forth which restrict facilities available to
40707 &_.forward_& files in a redirect router. If Exim is running on a central mail
40708 hub to which ordinary users do not have shell access, but home directories are
40709 NFS mounted (for instance) then administrators should review the list of these
40710 forbid options available, and should bear in mind that the options that may
40711 need forbidding can change as new features are added between releases.
40712 .next
40713 The &%${run...}%& expansion item does not use a shell by default, but
40714 administrators can configure use of &_/bin/sh_& as part of the command.
40715 Such invocations should be viewed with prejudicial suspicion.
40716 .next
40717 Administrators who use embedded Perl are advised to explore how Perl's
40718 taint checking might apply to their usage.
40719 .next
40720 Use of &%${expand...}%& is somewhat analogous to shell's eval builtin and
40721 administrators are well advised to view its use with suspicion, in case (for
40722 instance) it allows a local-part to contain embedded Exim directives.
40723 .next
40724 Use of &%${match_local_part...}%& and friends becomes more dangerous if
40725 Exim was built with EXPAND_LISTMATCH_RHS defined: the second string in
40726 each can reference arbitrary lists and files, rather than just being a list
40727 of opaque strings.
40728 The EXPAND_LISTMATCH_RHS option was added and set false by default because of
40729 real-world security vulnerabilities caused by its use with untrustworthy data
40730 injected in, for SQL injection attacks.
40731 Consider the use of the &%inlisti%& expansion condition instead.
40732 .endlist
40733
40734
40735
40736
40737 .section "Trust in configuration data" "SECTsecconfdata"
40738 .cindex "security" "data sources"
40739 .cindex "security" "regular expressions"
40740 .cindex "regular expressions" "security"
40741 .cindex "PCRE" "security"
40742 If configuration data for Exim can come from untrustworthy sources, there
40743 are some issues to be aware of:
40744
40745 .ilist
40746 Use of &%${expand...}%& may provide a path for shell injection attacks.
40747 .next
40748 Letting untrusted data provide a regular expression is unwise.
40749 .next
40750 Using &%${match...}%& to apply a fixed regular expression against untrusted
40751 data may result in pathological behaviour within PCRE.  Be aware of what
40752 "backtracking" means and consider options for being more strict with a regular
40753 expression. Avenues to explore include limiting what can match (avoiding &`.`&
40754 when &`[a-z0-9]`& or other character class will do), use of atomic grouping and
40755 possessive quantifiers or just not using regular expressions against untrusted
40756 data.
40757 .next
40758 It can be important to correctly use &%${quote:...}%&,
40759 &%${quote_local_part:...}%& and &%${quote_%&<&'lookup-type'&>&%:...}%& expansion
40760 items to ensure that data is correctly constructed.
40761 .next
40762 Some lookups might return multiple results, even though normal usage is only
40763 expected to yield one result.
40764 .endlist
40765
40766
40767
40768
40769 .section "IPv4 source routing" "SECID272"
40770 .cindex "source routing" "in IP packets"
40771 .cindex "IP source routing"
40772 Many operating systems suppress IP source-routed packets in the kernel, but
40773 some cannot be made to do this, so Exim does its own check. It logs incoming
40774 IPv4 source-routed TCP calls, and then drops them. Things are all different in
40775 IPv6. No special checking is currently done.
40776
40777
40778
40779 .section "The VRFY, EXPN, and ETRN commands in SMTP" "SECID273"
40780 Support for these SMTP commands is disabled by default. If required, they can
40781 be enabled by defining suitable ACLs.
40782
40783
40784
40785
40786 .section "Privileged users" "SECID274"
40787 .cindex "trusted users"
40788 .cindex "admin user"
40789 .cindex "privileged user"
40790 .cindex "user" "trusted"
40791 .cindex "user" "admin"
40792 Exim recognizes two sets of users with special privileges. Trusted users are
40793 able to submit new messages to Exim locally, but supply their own sender
40794 addresses and information about a sending host. For other users submitting
40795 local messages, Exim sets up the sender address from the uid, and doesn't
40796 permit a remote host to be specified.
40797
40798 .oindex "&%-f%&"
40799 However, an untrusted user is permitted to use the &%-f%& command line option
40800 in the special form &%-f <>%& to indicate that a delivery failure for the
40801 message should not cause an error report. This affects the message's envelope,
40802 but it does not affect the &'Sender:'& header. Untrusted users may also be
40803 permitted to use specific forms of address with the &%-f%& option by setting
40804 the &%untrusted_set_sender%& option.
40805
40806 Trusted users are used to run processes that receive mail messages from some
40807 other mail domain and pass them on to Exim for delivery either locally, or over
40808 the Internet. Exim trusts a caller that is running as root, as the Exim user,
40809 as any user listed in the &%trusted_users%& configuration option, or under any
40810 group listed in the &%trusted_groups%& option.
40811
40812 Admin users are permitted to do things to the messages on Exim's queue. They
40813 can freeze or thaw messages, cause them to be returned to their senders, remove
40814 them entirely, or modify them in various ways. In addition, admin users can run
40815 the Exim monitor and see all the information it is capable of providing, which
40816 includes the contents of files on the spool.
40817
40818 .oindex "&%-M%&"
40819 .oindex "&%-q%&"
40820 By default, the use of the &%-M%& and &%-q%& options to cause Exim to attempt
40821 delivery of messages on its queue is restricted to admin users. This
40822 restriction can be relaxed by setting the &%no_prod_requires_admin%& option.
40823 Similarly, the use of &%-bp%& (and its variants) to list the contents of the
40824 queue is also restricted to admin users. This restriction can be relaxed by
40825 setting &%no_queue_list_requires_admin%&.
40826
40827 Exim recognizes an admin user if the calling process is running as root or as
40828 the Exim user or if any of the groups associated with the calling process is
40829 the Exim group. It is not necessary actually to be running under the Exim
40830 group. However, if admin users who are not root or the Exim user are to access
40831 the contents of files on the spool via the Exim monitor (which runs
40832 unprivileged), Exim must be built to allow group read access to its spool
40833 files.
40834
40835 By default, regular users are trusted to perform basic testing and
40836 introspection commands, as themselves.  This setting can be tightened by
40837 setting the &%commandline_checks_require_admin%& option.
40838 This affects most of the checking options,
40839 such as &%-be%& and anything else &%-b*%&.
40840
40841
40842 .section "Spool files" "SECID275"
40843 .cindex "spool directory" "files"
40844 Exim's spool directory and everything it contains is owned by the Exim user and
40845 set to the Exim group. The mode for spool files is defined in the
40846 &_Local/Makefile_& configuration file, and defaults to 0640. This means that
40847 any user who is a member of the Exim group can access these files.
40848
40849
40850
40851 .section "Use of argv[0]" "SECID276"
40852 Exim examines the last component of &%argv[0]%&, and if it matches one of a set
40853 of specific strings, Exim assumes certain options. For example, calling Exim
40854 with the last component of &%argv[0]%& set to &"rsmtp"& is exactly equivalent
40855 to calling it with the option &%-bS%&. There are no security implications in
40856 this.
40857
40858
40859
40860 .section "Use of %f formatting" "SECID277"
40861 The only use made of &"%f"& by Exim is in formatting load average values. These
40862 are actually stored in integer variables as 1000 times the load average.
40863 Consequently, their range is limited and so therefore is the length of the
40864 converted output.
40865
40866
40867
40868 .section "Embedded Exim path" "SECID278"
40869 Exim uses its own path name, which is embedded in the code, only when it needs
40870 to re-exec in order to regain root privilege. Therefore, it is not root when it
40871 does so. If some bug allowed the path to get overwritten, it would lead to an
40872 arbitrary program's being run as exim, not as root.
40873
40874
40875
40876 .section "Dynamic module directory" "SECTdynmoddir"
40877 Any dynamically loadable modules must be installed into the directory
40878 defined in &`LOOKUP_MODULE_DIR`& in &_Local/Makefile_& for Exim to permit
40879 loading it.
40880
40881
40882 .section "Use of sprintf()" "SECID279"
40883 .cindex "&[sprintf()]&"
40884 A large number of occurrences of &"sprintf"& in the code are actually calls to
40885 &'string_sprintf()'&, a function that returns the result in malloc'd store.
40886 The intermediate formatting is done into a large fixed buffer by a function
40887 that runs through the format string itself, and checks the length of each
40888 conversion before performing it, thus preventing buffer overruns.
40889
40890 The remaining uses of &[sprintf()]& happen in controlled circumstances where
40891 the output buffer is known to be sufficiently long to contain the converted
40892 string.
40893
40894
40895
40896 .section "Use of debug_printf() and log_write()" "SECID280"
40897 Arbitrary strings are passed to both these functions, but they do their
40898 formatting by calling the function &'string_vformat()'&, which runs through
40899 the format string itself, and checks the length of each conversion.
40900
40901
40902
40903 .section "Use of strcat() and strcpy()" "SECID281"
40904 These are used only in cases where the output buffer is known to be large
40905 enough to hold the result.
40906 .ecindex IIDsecurcon
40907
40908
40909
40910
40911 . ////////////////////////////////////////////////////////////////////////////
40912 . ////////////////////////////////////////////////////////////////////////////
40913
40914 .chapter "Format of spool files" "CHAPspool"
40915 .scindex IIDforspo1 "format" "spool files"
40916 .scindex IIDforspo2 "spool directory" "format of files"
40917 .scindex IIDforspo3 "spool files" "format of"
40918 .cindex "spool files" "editing"
40919 A message on Exim's queue consists of two files, whose names are the message id
40920 followed by -D and -H, respectively. The data portion of the message is kept in
40921 the -D file on its own. The message's envelope, status, and headers are all
40922 kept in the -H file, whose format is described in this chapter. Each of these
40923 two files contains the final component of its own name as its first line. This
40924 is insurance against disk crashes where the directory is lost but the files
40925 themselves are recoverable.
40926
40927 The file formats may be changed, or new formats added, at any release.
40928 Spool files are not intended as an interface to other programs
40929 and should not be used as such.
40930
40931 Some people are tempted into editing -D files in order to modify messages. You
40932 need to be extremely careful if you do this; it is not recommended and you are
40933 on your own if you do it. Here are some of the pitfalls:
40934
40935 .ilist
40936 You must ensure that Exim does not try to deliver the message while you are
40937 fiddling with it. The safest way is to take out a write lock on the -D file,
40938 which is what Exim itself does, using &[fcntl()]&. If you update the file in
40939 place, the lock will be retained. If you write a new file and rename it, the
40940 lock will be lost at the instant of rename.
40941 .next
40942 .vindex "&$body_linecount$&"
40943 If you change the number of lines in the file, the value of
40944 &$body_linecount$&, which is stored in the -H file, will be incorrect and can
40945 cause incomplete transmission of messages or undeliverable messages.
40946 .next
40947 If the message is in MIME format, you must take care not to break it.
40948 .next
40949 If the message is cryptographically signed, any change will invalidate the
40950 signature.
40951 .endlist
40952 All in all, modifying -D files is fraught with danger.
40953
40954 Files whose names end with -J may also be seen in the &_input_& directory (or
40955 its subdirectories when &%split_spool_directory%& is set). These are journal
40956 files, used to record addresses to which the message has been delivered during
40957 the course of a delivery attempt. If there are still undelivered recipients at
40958 the end, the -H file is updated, and the -J file is deleted. If, however, there
40959 is some kind of crash (for example, a power outage) before this happens, the -J
40960 file remains in existence. When Exim next processes the message, it notices the
40961 -J file and uses it to update the -H file before starting the next delivery
40962 attempt.
40963
40964 Files whose names end with -K or .eml may also be seen in the spool.
40965 These are temporaries used for DKIM or malware processing, when that is used.
40966 They should be tidied up by normal operations; any old ones are probably
40967 relics of crashes and can be removed.
40968
40969 .section "Format of the -H file" "SECID282"
40970 .cindex "uid (user id)" "in spool file"
40971 .cindex "gid (group id)" "in spool file"
40972 The second line of the -H file contains the login name for the uid of the
40973 process that called Exim to read the message, followed by the numerical uid and
40974 gid. For a locally generated message, this is normally the user who sent the
40975 message. For a message received over TCP/IP via the daemon, it is
40976 normally the Exim user.
40977
40978 The third line of the file contains the address of the message's sender as
40979 transmitted in the envelope, contained in angle brackets. The sender address is
40980 empty for bounce messages. For incoming SMTP mail, the sender address is given
40981 in the MAIL command. For locally generated mail, the sender address is
40982 created by Exim from the login name of the current user and the configured
40983 &%qualify_domain%&. However, this can be overridden by the &%-f%& option or a
40984 leading &"From&~"& line if the caller is trusted, or if the supplied address is
40985 &"<>"& or an address that matches &%untrusted_set_senders%&.
40986
40987 The fourth line contains two numbers. The first is the time that the message
40988 was received, in the conventional Unix form &-- the number of seconds since the
40989 start of the epoch. The second number is a count of the number of messages
40990 warning of delayed delivery that have been sent to the sender.
40991
40992 There follow a number of lines starting with a hyphen. These can appear in any
40993 order, and are omitted when not relevant:
40994
40995 .vlist
40996 .vitem "&%-acl%&&~<&'number'&>&~<&'length'&>"
40997 This item is obsolete, and is not generated from Exim release 4.61 onwards;
40998 &%-aclc%& and &%-aclm%& are used instead. However, &%-acl%& is still
40999 recognized, to provide backward compatibility. In the old format, a line of
41000 this form is present for every ACL variable that is not empty. The number
41001 identifies the variable; the &%acl_c%&&*x*& variables are numbered 0&--9 and
41002 the &%acl_m%&&*x*& variables are numbered 10&--19. The length is the length of
41003 the data string for the variable. The string itself starts at the beginning of
41004 the next line, and is followed by a newline character. It may contain internal
41005 newlines.
41006
41007 .vitem "&%-aclc%&&~<&'rest-of-name'&>&~<&'length'&>"
41008 A line of this form is present for every ACL connection variable that is
41009 defined. Note that there is a space between &%-aclc%& and the rest of the name.
41010 The length is the length of the data string for the variable. The string itself
41011 starts at the beginning of the next line, and is followed by a newline
41012 character. It may contain internal newlines.
41013
41014 .vitem "&%-aclm%&&~<&'rest-of-name'&>&~<&'length'&>"
41015 A line of this form is present for every ACL message variable that is defined.
41016 Note that there is a space between &%-aclm%& and the rest of the name. The
41017 length is the length of the data string for the variable. The string itself
41018 starts at the beginning of the next line, and is followed by a newline
41019 character. It may contain internal newlines.
41020
41021 .vitem "&%-active_hostname%&&~<&'hostname'&>"
41022 This is present if, when the message was received over SMTP, the value of
41023 &$smtp_active_hostname$& was different to the value of &$primary_hostname$&.
41024
41025 .vitem &%-allow_unqualified_recipient%&
41026 This is present if unqualified recipient addresses are permitted in header
41027 lines (to stop such addresses from being qualified if rewriting occurs at
41028 transport time). Local messages that were input using &%-bnq%& and remote
41029 messages from hosts that match &%recipient_unqualified_hosts%& set this flag.
41030
41031 .vitem &%-allow_unqualified_sender%&
41032 This is present if unqualified sender addresses are permitted in header lines
41033 (to stop such addresses from being qualified if rewriting occurs at transport
41034 time). Local messages that were input using &%-bnq%& and remote messages from
41035 hosts that match &%sender_unqualified_hosts%& set this flag.
41036
41037 .vitem "&%-auth_id%&&~<&'text'&>"
41038 The id information for a message received on an authenticated SMTP connection
41039 &-- the value of the &$authenticated_id$& variable.
41040
41041 .vitem "&%-auth_sender%&&~<&'address'&>"
41042 The address of an authenticated sender &-- the value of the
41043 &$authenticated_sender$& variable.
41044
41045 .vitem "&%-body_linecount%&&~<&'number'&>"
41046 This records the number of lines in the body of the message, and is
41047 present unless &%-spool_file_wireformat%& is.
41048
41049 .vitem "&%-body_zerocount%&&~<&'number'&>"
41050 This records the number of binary zero bytes in the body of the message, and is
41051 present if the number is greater than zero.
41052
41053 .vitem &%-deliver_firsttime%&
41054 This is written when a new message is first added to the spool. When the spool
41055 file is updated after a deferral, it is omitted.
41056
41057 .vitem "&%-frozen%&&~<&'time'&>"
41058 .cindex "frozen messages" "spool data"
41059 The message is frozen, and the freezing happened at <&'time'&>.
41060
41061 .vitem "&%-helo_name%&&~<&'text'&>"
41062 This records the host name as specified by a remote host in a HELO or EHLO
41063 command.
41064
41065 .vitem "&%-host_address%&&~<&'address'&>.<&'port'&>"
41066 This records the IP address of the host from which the message was received and
41067 the remote port number that was used. It is omitted for locally generated
41068 messages.
41069
41070 .vitem "&%-host_auth%&&~<&'text'&>"
41071 If the message was received on an authenticated SMTP connection, this records
41072 the name of the authenticator &-- the value of the
41073 &$sender_host_authenticated$& variable.
41074
41075 .vitem &%-host_lookup_failed%&
41076 This is present if an attempt to look up the sending host's name from its IP
41077 address failed. It corresponds to the &$host_lookup_failed$& variable.
41078
41079 .vitem "&%-host_name%&&~<&'text'&>"
41080 .cindex "reverse DNS lookup"
41081 .cindex "DNS" "reverse lookup"
41082 This records the name of the remote host from which the message was received,
41083 if the host name was looked up from the IP address when the message was being
41084 received. It is not present if no reverse lookup was done.
41085
41086 .vitem "&%-ident%&&~<&'text'&>"
41087 For locally submitted messages, this records the login of the originating user,
41088 unless it was a trusted user and the &%-oMt%& option was used to specify an
41089 ident value. For messages received over TCP/IP, this records the ident string
41090 supplied by the remote host, if any.
41091
41092 .vitem "&%-interface_address%&&~<&'address'&>.<&'port'&>"
41093 This records the IP address of the local interface and the port number through
41094 which a message was received from a remote host. It is omitted for locally
41095 generated messages.
41096
41097 .vitem &%-local%&
41098 The message is from a local sender.
41099
41100 .vitem &%-localerror%&
41101 The message is a locally-generated bounce message.
41102
41103 .vitem "&%-local_scan%&&~<&'string'&>"
41104 This records the data string that was returned by the &[local_scan()]& function
41105 when the message was received &-- the value of the &$local_scan_data$&
41106 variable. It is omitted if no data was returned.
41107
41108 .vitem &%-manual_thaw%&
41109 The message was frozen but has been thawed manually, that is, by an explicit
41110 Exim command rather than via the auto-thaw process.
41111
41112 .vitem &%-N%&
41113 A testing delivery process was started using the &%-N%& option to suppress any
41114 actual deliveries, but delivery was deferred. At any further delivery attempts,
41115 &%-N%& is assumed.
41116
41117 .vitem &%-received_protocol%&
41118 This records the value of the &$received_protocol$& variable, which contains
41119 the name of the protocol by which the message was received.
41120
41121 .vitem &%-sender_set_untrusted%&
41122 The envelope sender of this message was set by an untrusted local caller (used
41123 to ensure that the caller is displayed in queue listings).
41124
41125 .vitem "&%-spam_score_int%&&~<&'number'&>"
41126 If a message was scanned by SpamAssassin, this is present. It records the value
41127 of &$spam_score_int$&.
41128
41129 .vitem &%-spool_file_wireformat%&
41130 The -D file for this message is in wire-format (for ESMTP CHUNKING)
41131 rather than Unix-format.
41132 The line-ending is CRLF rather than newline.
41133 There is still, however, no leading-dot-stuffing.
41134
41135 .vitem &%-tls_certificate_verified%&
41136 A TLS certificate was received from the client that sent this message, and the
41137 certificate was verified by the server.
41138
41139 .vitem "&%-tls_cipher%&&~<&'cipher name'&>"
41140 When the message was received over an encrypted connection, this records the
41141 name of the cipher suite that was used.
41142
41143 .vitem "&%-tls_peerdn%&&~<&'peer DN'&>"
41144 When the message was received over an encrypted connection, and a certificate
41145 was received from the client, this records the Distinguished Name from that
41146 certificate.
41147 .endlist
41148
41149 Any of the above may have an extra hyphen prepended, to indicate the the
41150 corresponding data is untrusted.
41151
41152 Following the options there is a list of those addresses to which the message
41153 is not to be delivered. This set of addresses is initialized from the command
41154 line when the &%-t%& option is used and &%extract_addresses_remove_arguments%&
41155 is set; otherwise it starts out empty. Whenever a successful delivery is made,
41156 the address is added to this set. The addresses are kept internally as a
41157 balanced binary tree, and it is a representation of that tree which is written
41158 to the spool file. If an address is expanded via an alias or forward file, the
41159 original address is added to the tree when deliveries to all its child
41160 addresses are complete.
41161
41162 If the tree is empty, there is a single line in the spool file containing just
41163 the text &"XX"&. Otherwise, each line consists of two letters, which are either
41164 Y or N, followed by an address. The address is the value for the node of the
41165 tree, and the letters indicate whether the node has a left branch and/or a
41166 right branch attached to it, respectively. If branches exist, they immediately
41167 follow. Here is an example of a three-node tree:
41168 .code
41169 YY darcy@austen.fict.example
41170 NN alice@wonderland.fict.example
41171 NN editor@thesaurus.ref.example
41172 .endd
41173 After the non-recipients tree, there is a list of the message's recipients.
41174 This is a simple list, preceded by a count. It includes all the original
41175 recipients of the message, including those to whom the message has already been
41176 delivered. In the simplest case, the list contains one address per line. For
41177 example:
41178 .code
41179 4
41180 editor@thesaurus.ref.example
41181 darcy@austen.fict.example
41182 rdo@foundation
41183 alice@wonderland.fict.example
41184 .endd
41185 However, when a child address has been added to the top-level addresses as a
41186 result of the use of the &%one_time%& option on a &(redirect)& router, each
41187 line is of the following form:
41188 .display
41189 <&'top-level address'&> <&'errors_to address'&> &&&
41190   <&'length'&>,<&'parent number'&>#<&'flag bits'&>
41191 .endd
41192 The 01 flag bit indicates the presence of the three other fields that follow
41193 the top-level address. Other bits may be used in future to support additional
41194 fields. The <&'parent number'&> is the offset in the recipients list of the
41195 original parent of the &"one time"& address. The first two fields are the
41196 envelope sender that is associated with this address and its length. If the
41197 length is zero, there is no special envelope sender (there are then two space
41198 characters in the line). A non-empty field can arise from a &(redirect)& router
41199 that has an &%errors_to%& setting.
41200
41201
41202 A blank line separates the envelope and status information from the headers
41203 which follow. A header may occupy several lines of the file, and to save effort
41204 when reading it in, each header is preceded by a number and an identifying
41205 character. The number is the number of characters in the header, including any
41206 embedded newlines and the terminating newline. The character is one of the
41207 following:
41208
41209 .table2 50pt
41210 .row <&'blank'&>         "header in which Exim has no special interest"
41211 .row &`B`&               "&'Bcc:'& header"
41212 .row &`C`&               "&'Cc:'& header"
41213 .row &`F`&               "&'From:'& header"
41214 .row &`I`&               "&'Message-id:'& header"
41215 .row &`P`&               "&'Received:'& header &-- P for &""postmark""&"
41216 .row &`R`&               "&'Reply-To:'& header"
41217 .row &`S`&               "&'Sender:'& header"
41218 .row &`T`&               "&'To:'& header"
41219 .row &`*`&               "replaced or deleted header"
41220 .endtable
41221
41222 Deleted or replaced (rewritten) headers remain in the spool file for debugging
41223 purposes. They are not transmitted when the message is delivered. Here is a
41224 typical set of headers:
41225 .code
41226 111P Received: by hobbit.fict.example with local (Exim 4.00)
41227 id 14y9EI-00026G-00; Fri, 11 May 2001 10:28:59 +0100
41228 049  Message-Id: <E14y9EI-00026G-00@hobbit.fict.example>
41229 038* X-rewrote-sender: bb@hobbit.fict.example
41230 042* From: Bilbo Baggins <bb@hobbit.fict.example>
41231 049F From: Bilbo Baggins <B.Baggins@hobbit.fict.example>
41232 099* To: alice@wonderland.fict.example, rdo@foundation,
41233 darcy@austen.fict.example, editor@thesaurus.ref.example
41234 104T To: alice@wonderland.fict.example, rdo@foundation.example,
41235 darcy@austen.fict.example, editor@thesaurus.ref.example
41236 038  Date: Fri, 11 May 2001 10:28:59 +0100
41237 .endd
41238 The asterisked headers indicate that the envelope sender, &'From:'& header, and
41239 &'To:'& header have been rewritten, the last one because routing expanded the
41240 unqualified domain &'foundation'&.
41241 .ecindex IIDforspo1
41242 .ecindex IIDforspo2
41243 .ecindex IIDforspo3
41244
41245 .section "Format of the -D file" "SECID282a"
41246 The data file is traditionally in Unix-standard format: lines are ended with
41247 an ASCII newline character.
41248 However, when the &%spool_wireformat%& main option is used some -D files
41249 can have an alternate format.
41250 This is flagged by a &%-spool_file_wireformat%& line in the corresponding -H file.
41251 The -D file lines (not including the first name-component line) are
41252 suitable for direct copying to the wire when transmitting using the
41253 ESMTP CHUNKING option, meaning lower processing overhead.
41254 Lines are terminated with an ASCII CRLF pair.
41255 There is no dot-stuffing (and no dot-termination).
41256
41257 . ////////////////////////////////////////////////////////////////////////////
41258 . ////////////////////////////////////////////////////////////////////////////
41259
41260 .chapter "DKIM, SPF, SRS and DMARC" "CHAPdkim" &&&
41261          "DKIM, SPF, SRS and DMARC Support"
41262
41263 .section "DKIM (DomainKeys Identified Mail)" SECDKIM
41264 .cindex "DKIM"
41265
41266 DKIM is a mechanism by which messages sent by some entity can be provably
41267 linked to a domain which that entity controls.  It permits reputation to
41268 be tracked on a per-domain basis, rather than merely upon source IP address.
41269 DKIM is documented in RFC 6376.
41270
41271 As DKIM relies on the message being unchanged in transit, messages handled
41272 by a mailing-list (which traditionally adds to the message) will not match
41273 any original DKIM signature.
41274
41275 DKIM support is compiled into Exim by default if TLS support is present.
41276 It can be disabled by setting DISABLE_DKIM=yes in &_Local/Makefile_&.
41277
41278 Exim's DKIM implementation allows for
41279 .olist
41280 Signing outgoing messages: This function is implemented in the SMTP transport.
41281 It can co-exist with all other Exim features
41282 (including transport filters)
41283 except cutthrough delivery.
41284 .next
41285 Verifying signatures in incoming messages: This is implemented by an additional
41286 ACL (acl_smtp_dkim), which can be called several times per message, with
41287 different signature contexts.
41288 .endlist
41289
41290 In typical Exim style, the verification implementation does not include any
41291 default "policy". Instead it enables you to build your own policy using
41292 Exim's standard controls.
41293
41294 Please note that verification of DKIM signatures in incoming mail is turned
41295 on by default for logging (in the <= line) purposes.
41296
41297 Additional log detail can be enabled using the &%dkim_verbose%& log_selector.
41298 When set, for each signature in incoming email,
41299 exim will log a line displaying the most important signature details, and the
41300 signature status. Here is an example (with line-breaks added for clarity):
41301 .code
41302 2009-09-09 10:22:28 1MlIRf-0003LU-U3 DKIM:
41303     d=facebookmail.com s=q1-2009b
41304     c=relaxed/relaxed a=rsa-sha1
41305     i=@facebookmail.com t=1252484542 [verification succeeded]
41306 .endd
41307
41308 You might want to turn off DKIM verification processing entirely for internal
41309 or relay mail sources. To do that, set the &%dkim_disable_verify%& ACL
41310 control modifier. This should typically be done in the RCPT ACL, at points
41311 where you accept mail from relay sources (internal hosts or authenticated
41312 senders).
41313
41314
41315 .section "Signing outgoing messages" "SECDKIMSIGN"
41316 .cindex "DKIM" "signing"
41317
41318 For signing to be usable you must have published a DKIM record in DNS.
41319 Note that RFC 8301 (which does not cover EC keys) says:
41320 .code
41321 rsa-sha1 MUST NOT be used for signing or verifying.
41322
41323 Signers MUST use RSA keys of at least 1024 bits for all keys.
41324 Signers SHOULD use RSA keys of at least 2048 bits.
41325 .endd
41326
41327 Note also that the key content (the 'p=' field)
41328 in the DNS record is different between RSA and EC keys;
41329 for the former it is the base64 of the ASN.1 for the RSA public key
41330 (equivalent to the private-key .pem with the header/trailer stripped)
41331 but for EC keys it is the base64 of the pure key; no ASN.1 wrapping.
41332
41333 Signing is enabled by setting private options on the SMTP transport.
41334 These options take (expandable) strings as arguments.
41335
41336 .option dkim_domain smtp "string list&!!" unset
41337 The domain(s) you want to sign with.
41338 After expansion, this can be a list.
41339 Each element in turn,
41340 lowercased,
41341 is put into the &%$dkim_domain%& expansion variable
41342 while expanding the remaining signing options.
41343 If it is empty after expansion, DKIM signing is not done,
41344 and no error will result even if &%dkim_strict%& is set.
41345
41346 .option dkim_selector smtp "string list&!!" unset
41347 This sets the key selector string.
41348 After expansion, which can use &$dkim_domain$&, this can be a list.
41349 Each element in turn is put in the expansion
41350 variable &%$dkim_selector%& which may be used in the &%dkim_private_key%&
41351 option along with &%$dkim_domain%&.
41352 If the option is empty after expansion, DKIM signing is not done for this domain,
41353 and no error will result even if &%dkim_strict%& is set.
41354
41355 .new
41356 To do, for example, dual-signing with RSA and EC keys
41357 this could be be used:
41358 .code
41359 dkim_selector = ec_sel : rsa_sel
41360 dkim_private_key = KEYS_DIR/$dkim_selector
41361 .endd
41362 .wen
41363
41364 .option dkim_private_key smtp string&!! unset
41365 This sets the private key to use.
41366 You can use the &%$dkim_domain%& and
41367 &%$dkim_selector%& expansion variables to determine the private key to use.
41368 The result can either
41369 .ilist
41370 be a valid RSA private key in ASCII armor (.pem file), including line breaks
41371 .next
41372 with GnuTLS 3.6.0 or OpenSSL 1.1.1 or later,
41373 be a valid Ed25519 private key (same format as above)
41374 .next
41375 start with a slash, in which case it is treated as a file that contains
41376 the private key
41377 .next
41378 be "0", "false" or the empty string, in which case the message will not
41379 be signed. This case will not result in an error, even if &%dkim_strict%&
41380 is set.
41381 .endlist
41382
41383 To generate keys under OpenSSL:
41384 .code
41385 openssl genrsa -out dkim_rsa.private 2048
41386 openssl rsa -in dkim_rsa.private -out /dev/stdout -pubout -outform PEM
41387 .endd
41388 The result file from the first command should be retained, and
41389 this option set to use it.
41390 Take the base-64 lines from the output of the second command, concatenated,
41391 for the DNS TXT record.
41392 See section 3.6 of RFC6376 for the record specification.
41393
41394 Under GnuTLS:
41395 .code
41396 certtool --generate-privkey --rsa --bits=2048 --password='' -8 --outfile=dkim_rsa.private
41397 certtool --load-privkey=dkim_rsa.private --pubkey-info
41398 .endd
41399
41400 Note that RFC 8301 says:
41401 .code
41402 Signers MUST use RSA keys of at least 1024 bits for all keys.
41403 Signers SHOULD use RSA keys of at least 2048 bits.
41404 .endd
41405
41406 EC keys for DKIM are defined by RFC 8463.
41407 They are considerably smaller than RSA keys for equivalent protection.
41408 As they are a recent development, users should consider dual-signing
41409 (by setting a list of selectors, and an expansion for this option)
41410 for some transition period.
41411 The "_CRYPTO_SIGN_ED25519" macro will be defined if support is present
41412 for EC keys.
41413
41414 OpenSSL 1.1.1 and GnuTLS 3.6.0 can create Ed25519 private keys:
41415 .code
41416 openssl genpkey -algorithm ed25519 -out dkim_ed25519.private
41417 certtool --generate-privkey --key-type=ed25519 --outfile=dkim_ed25519.private
41418 .endd
41419
41420 To produce the required public key value for a DNS record:
41421 .code
41422 openssl pkey -outform DER -pubout -in dkim_ed25519.private | tail -c +13 | base64
41423 certtool --load_privkey=dkim_ed25519.private --pubkey_info --outder | tail -c +13 | base64
41424 .endd
41425
41426 Exim also supports an alternate format
41427 of Ed25519 keys in DNS which was a candidate during development
41428 of the standard, but not adopted.
41429 A future release will probably drop that support.
41430
41431 .option dkim_hash smtp string&!! sha256
41432 Can be set to any one of the supported hash methods, which are:
41433 .ilist
41434 &`sha1`& &-- should not be used, is old and insecure
41435 .next
41436 &`sha256`& &-- the default
41437 .next
41438 &`sha512`& &-- possibly more secure but less well supported
41439 .endlist
41440
41441 Note that RFC 8301 says:
41442 .code
41443 rsa-sha1 MUST NOT be used for signing or verifying.
41444 .endd
41445
41446 .option dkim_identity smtp string&!! unset
41447 If set after expansion, the value is used to set an "i=" tag in
41448 the signing header.  The DKIM standards restrict the permissible
41449 syntax of this optional tag to a mail address, with possibly-empty
41450 local part, an @, and a domain identical to or subdomain of the "d="
41451 tag value.  Note that Exim does not check the value.
41452
41453 .option dkim_canon smtp string&!! unset
41454 This option sets the canonicalization method used when signing a message.
41455 The DKIM RFC currently supports two methods: "simple" and "relaxed".
41456 The option defaults to "relaxed" when unset. Note: the current implementation
41457 only supports signing with the same canonicalization method for both headers and body.
41458
41459 .option dkim_strict smtp string&!! unset
41460 This  option  defines  how  Exim  behaves  when  signing a message that
41461 should be signed fails for some reason.  When the expansion evaluates to
41462 either &"1"& or &"true"&, Exim will defer. Otherwise Exim will send the message
41463 unsigned. You can use the &%$dkim_domain%& and &%$dkim_selector%& expansion
41464 variables here.
41465
41466 .option dkim_sign_headers smtp string&!! "see below"
41467 If set, this option must expand to a colon-separated
41468 list of header names.
41469 Headers with these names, or the absence or such a header, will be included
41470 in the message signature.
41471 When unspecified, the header names listed in RFC4871 will be used,
41472 whether or not each header is present in the message.
41473 The default list is available for the expansion in the macro
41474 &"_DKIM_SIGN_HEADERS"&
41475 and an oversigning variant is in &"_DKIM_OVERSIGN_HEADERS"&.
41476
41477 If a name is repeated, multiple headers by that name (or the absence thereof)
41478 will be signed.  The textually later headers in the headers part of the
41479 message are signed first, if there are multiples.
41480
41481 A name can be prefixed with either an &"="& or a &"+"& character.
41482 If an &"="& prefix is used, all headers that are present with this name
41483 will be signed.
41484 If a &"+"& prefix if used, all headers that are present with this name
41485 will be signed, and one signature added for a missing header with the
41486 name will be appended.
41487
41488 .option dkim_timestamps smtp integer&!! unset
41489 This option controls the inclusion of timestamp information in the signature.
41490 If not set, no such information will be included.
41491 Otherwise, must be an unsigned number giving an offset in seconds from the current time
41492 for the expiry tag
41493 (eg. 1209600 for two weeks);
41494 both creation (t=) and expiry (x=) tags will be included.
41495
41496 RFC 6376 lists these tags as RECOMMENDED.
41497
41498
41499 .section "Verifying DKIM signatures in incoming mail" "SECDKIMVFY"
41500 .cindex "DKIM" "verification"
41501
41502 Verification of DKIM signatures in SMTP incoming email is done for all
41503 messages for which an ACL control &%dkim_disable_verify%& has not been set.
41504 .cindex DKIM "selecting signature algorithms"
41505 Individual classes of signature algorithm can be ignored by changing
41506 the main options &%dkim_verify_hashes%& or &%dkim_verify_keytypes%&.
41507 The &%dkim_verify_minimal%& option can be set to cease verification
41508 processing for a message once the first passing signature is found.
41509
41510 .cindex authentication "expansion item"
41511 Performing verification sets up information used by the
41512 &%authresults%& expansion item.
41513
41514 For most purposes the default option settings suffice and the remainder
41515 of this section can be ignored.
41516
41517 The results of verification are made available to the
41518 &%acl_smtp_dkim%& ACL, which can examine and modify them.
41519 A missing ACL definition defaults to accept.
41520 By default, the ACL is called once for each
41521 syntactically(!) correct signature in the incoming message.
41522 If any ACL call does not accept, the message is not accepted.
41523 If a cutthrough delivery was in progress for the message, that is
41524 summarily dropped (having wasted the transmission effort).
41525
41526 To evaluate the verification result in the ACL
41527 a large number of expansion variables
41528 containing the signature status and its details are set up during the
41529 runtime of the ACL.
41530
41531 Calling the ACL only for existing signatures is not sufficient to build
41532 more advanced policies. For that reason, the main option
41533 &%dkim_verify_signers%&, and an expansion variable
41534 &%$dkim_signers%& exist.
41535
41536 The main option &%dkim_verify_signers%& can be set to a colon-separated
41537 list of DKIM domains or identities for which the ACL &%acl_smtp_dkim%& is
41538 called. It is expanded when the message has been received. At this point,
41539 the expansion variable &%$dkim_signers%& already contains a colon-separated
41540 list of signer domains and identities for the message. When
41541 &%dkim_verify_signers%& is not specified in the main configuration,
41542 it defaults as:
41543 .code
41544 dkim_verify_signers = $dkim_signers
41545 .endd
41546 This leads to the default behaviour of calling &%acl_smtp_dkim%& for each
41547 DKIM signature in the message. Current DKIM verifiers may want to explicitly
41548 call the ACL for known domains or identities. This would be achieved as follows:
41549 .code
41550 dkim_verify_signers = paypal.com:ebay.com:$dkim_signers
41551 .endd
41552 This would result in &%acl_smtp_dkim%& always being called for "paypal.com"
41553 and "ebay.com", plus all domains and identities that have signatures in the message.
41554 You can also be more creative in constructing your policy. For example:
41555 .code
41556 dkim_verify_signers = $sender_address_domain:$dkim_signers
41557 .endd
41558
41559 If a domain or identity is listed several times in the (expanded) value of
41560 &%dkim_verify_signers%&, the ACL is only called once for that domain or identity.
41561
41562 Note that if the option is set using untrustworthy data
41563 (such as the From: header)
41564 care should be taken to force lowercase for domains
41565 and for the domain part if identities.
41566 The default setting can be regarded as trustworthy in this respect.
41567
41568 If multiple signatures match a domain (or identity), the ACL is called once
41569 for each matching signature.
41570
41571
41572 Inside the DKIM ACL, the following expansion variables are
41573 available (from most to least important):
41574
41575
41576 .vlist
41577 .vitem &%$dkim_cur_signer%&
41578 The signer that is being evaluated in this ACL run. This can be a domain or
41579 an identity. This is one of the list items from the expanded main option
41580 &%dkim_verify_signers%& (see above).
41581
41582 .vitem &%$dkim_verify_status%&
41583 Within the DKIM ACL,
41584 a string describing the general status of the signature. One of
41585 .ilist
41586 &%none%&: There is no signature in the message for the current domain or
41587 identity (as reflected by &%$dkim_cur_signer%&).
41588 .next
41589 &%invalid%&: The signature could not be verified due to a processing error.
41590 More detail is available in &%$dkim_verify_reason%&.
41591 .next
41592 &%fail%&: Verification of the signature failed.  More detail is
41593 available in &%$dkim_verify_reason%&.
41594 .next
41595 &%pass%&: The signature passed verification. It is valid.
41596 .endlist
41597
41598 This variable can be overwritten using an ACL 'set' modifier.
41599 This might, for instance, be done to enforce a policy restriction on
41600 hash-method or key-size:
41601 .code
41602   warn condition       = ${if eq {$dkim_verify_status}{pass}}
41603        condition       = ${if eq {${length_3:$dkim_algo}}{rsa}}
41604        condition       = ${if or {{eq {$dkim_algo}{rsa-sha1}} \
41605                                   {< {$dkim_key_length}{1024}}}}
41606        logwrite        = NOTE: forcing DKIM verify fail (was pass)
41607        set dkim_verify_status = fail
41608        set dkim_verify_reason = hash too weak or key too short
41609 .endd
41610
41611 So long as a DKIM ACL is defined (it need do no more than accept),
41612 after all the DKIM ACL runs have completed, the value becomes a
41613 colon-separated list of the values after each run.
41614 This is maintained for the mime, prdr and data ACLs.
41615
41616 .vitem &%$dkim_verify_reason%&
41617 A string giving a little bit more detail when &%$dkim_verify_status%& is either
41618 "fail" or "invalid". One of
41619 .ilist
41620 &%pubkey_unavailable%& (when &%$dkim_verify_status%&="invalid"): The public
41621 key for the domain could not be retrieved. This may be a temporary problem.
41622 .next
41623 &%pubkey_syntax%& (when &%$dkim_verify_status%&="invalid"): The public key
41624 record for the domain is syntactically invalid.
41625 .next
41626 &%bodyhash_mismatch%& (when &%$dkim_verify_status%&="fail"): The calculated
41627 body hash does not match the one specified in the signature header. This
41628 means that the message body was modified in transit.
41629 .next
41630 &%signature_incorrect%& (when &%$dkim_verify_status%&="fail"): The signature
41631 could not be verified. This may mean that headers were modified,
41632 re-written or otherwise changed in a way which is incompatible with
41633 DKIM verification. It may of course also mean that the signature is forged.
41634 .endlist
41635
41636 This variable can be overwritten, with any value, using an ACL 'set' modifier.
41637
41638 .vitem &%$dkim_domain%&
41639 The signing domain. IMPORTANT: This variable is only populated if there is
41640 an actual signature in the message for the current domain or identity (as
41641 reflected by &%$dkim_cur_signer%&).
41642
41643 .vitem &%$dkim_identity%&
41644 The signing identity, if present. IMPORTANT: This variable is only populated
41645 if there is an actual signature in the message for the current domain or
41646 identity (as reflected by &%$dkim_cur_signer%&).
41647
41648 .vitem &%$dkim_selector%&
41649 The key record selector string.
41650
41651 .vitem &%$dkim_algo%&
41652 The algorithm used. One of 'rsa-sha1' or 'rsa-sha256'.
41653 If running under GnuTLS 3.6.0 or OpenSSL 1.1.1 or later,
41654 may also be 'ed25519-sha256'.
41655 The "_CRYPTO_SIGN_ED25519" macro will be defined if support is present
41656 for EC keys.
41657
41658 Note that RFC 8301 says:
41659 .code
41660 rsa-sha1 MUST NOT be used for signing or verifying.
41661
41662 DKIM signatures identified as having been signed with historic
41663 algorithms (currently, rsa-sha1) have permanently failed evaluation
41664 .endd
41665
41666 To enforce this you must either have a DKIM ACL which checks this variable
41667 and overwrites the &$dkim_verify_status$& variable as discussed above,
41668 or have set the main option &%dkim_verify_hashes%& to exclude
41669 processing of such signatures.
41670
41671 .vitem &%$dkim_canon_body%&
41672 The body canonicalization method. One of 'relaxed' or 'simple'.
41673
41674 .vitem &%$dkim_canon_headers%&
41675 The header canonicalization method. One of 'relaxed' or 'simple'.
41676
41677 .vitem &%$dkim_copiedheaders%&
41678 A transcript of headers and their values which are included in the signature
41679 (copied from the 'z=' tag of the signature).
41680 Note that RFC6376 requires that verification fail if the From: header is
41681 not included in the signature.  Exim does not enforce this; sites wishing
41682 strict enforcement should code the check explicitly.
41683
41684 .vitem &%$dkim_bodylength%&
41685 The number of signed body bytes. If zero ("0"), the body is unsigned. If no
41686 limit was set by the signer, "9999999999999" is returned. This makes sure
41687 that this variable always expands to an integer value.
41688 &*Note:*& The presence of the signature tag specifying a signing body length
41689 is one possible route to spoofing of valid DKIM signatures.
41690 A paranoid implementation might wish to regard signature where this variable
41691 shows less than the "no limit" return as being invalid.
41692
41693 .vitem &%$dkim_created%&
41694 UNIX timestamp reflecting the date and time when the signature was created.
41695 When this was not specified by the signer, "0" is returned.
41696
41697 .vitem &%$dkim_expires%&
41698 UNIX timestamp reflecting the date and time when the signer wants the
41699 signature to be treated as "expired". When this was not specified by the
41700 signer, "9999999999999" is returned. This makes it possible to do useful
41701 integer size comparisons against this value.
41702 Note that Exim does not check this value.
41703
41704 .vitem &%$dkim_headernames%&
41705 A colon-separated list of names of headers included in the signature.
41706
41707 .vitem &%$dkim_key_testing%&
41708 "1" if the key record has the "testing" flag set, "0" if not.
41709
41710 .vitem &%$dkim_key_nosubdomains%&
41711 "1" if the key record forbids subdomaining, "0" otherwise.
41712
41713 .vitem &%$dkim_key_srvtype%&
41714 Service type (tag s=) from the key record. Defaults to "*" if not specified
41715 in the key record.
41716
41717 .vitem &%$dkim_key_granularity%&
41718 Key granularity (tag g=) from the key record. Defaults to "*" if not specified
41719 in the key record.
41720
41721 .vitem &%$dkim_key_notes%&
41722 Notes from the key record (tag n=).
41723
41724 .vitem &%$dkim_key_length%&
41725 Number of bits in the key.
41726 Valid only once the key is loaded, which is at the time the header signature
41727 is verified, which is after the body hash is.
41728
41729 Note that RFC 8301 says:
41730 .code
41731 Verifiers MUST NOT consider signatures using RSA keys of
41732 less than 1024 bits as valid signatures.
41733 .endd
41734
41735 This is enforced by the default setting for the &%dkim_verify_min_keysizes%&
41736 option.
41737
41738 .endlist
41739
41740 In addition, two ACL conditions are provided:
41741
41742 .vlist
41743 .vitem &%dkim_signers%&
41744 ACL condition that checks a colon-separated list of domains or identities
41745 for a match against the domain or identity that the ACL is currently verifying
41746 (reflected by &%$dkim_cur_signer%&). This is typically used to restrict an ACL
41747 verb to a group of domains or identities. For example:
41748
41749 .code
41750 # Warn when Mail purportedly from GMail has no gmail signature
41751 warn sender_domains = gmail.com
41752      dkim_signers = gmail.com
41753      dkim_status = none
41754      log_message = GMail sender without gmail.com DKIM signature
41755 .endd
41756
41757 Note that the above does not check for a total lack of DKIM signing;
41758 for that check for empty &$h_DKIM-Signature:$& in the data ACL.
41759
41760 .vitem &%dkim_status%&
41761 ACL condition that checks a colon-separated list of possible DKIM verification
41762 results against the actual result of verification. This is typically used
41763 to restrict an ACL verb to a list of verification outcomes, for example:
41764
41765 .code
41766 deny sender_domains = paypal.com:paypal.de
41767      dkim_signers = paypal.com:paypal.de
41768      dkim_status = none:invalid:fail
41769      message = Mail from Paypal with invalid/missing signature
41770 .endd
41771
41772 The possible status keywords are: 'none','invalid','fail' and 'pass'. Please
41773 see the documentation of the &%$dkim_verify_status%& expansion variable above
41774 for more information of what they mean.
41775 .endlist
41776
41777
41778
41779
41780 .section "SPF (Sender Policy Framework)" SECSPF
41781 .cindex SPF verification
41782
41783 SPF is a mechanism whereby a domain may assert which IP addresses may transmit
41784 messages with its domain in the envelope from, documented by RFC 7208.
41785 For more information on SPF see &url(http://www.open-spf.org), a static copy of
41786 the &url(http://openspf.org).
41787 . --- 2019-10-28: still not https, open-spf.org is told to be a
41788 . --- web-archive copy of the now dead openspf.org site
41789 . --- See https://www.mail-archive.com/mailop@mailop.org/msg08019.html for a
41790 . --- discussion.
41791
41792 Messages sent by a system not authorised will fail checking of such assertions.
41793 This includes retransmissions done by traditional forwarders.
41794
41795 SPF verification support is built into Exim if SUPPORT_SPF=yes is set in
41796 &_Local/Makefile_&.  The support uses the &_libspf2_& library
41797 &url(https://www.libspf2.org/).
41798 There is no Exim involvement in the transmission of messages;
41799 publishing certain DNS records is all that is required.
41800
41801 For verification, an ACL condition and an expansion lookup are provided.
41802 .cindex authentication "expansion item"
41803 Performing verification sets up information used by the
41804 &%authresults%& expansion item.
41805
41806
41807 .cindex SPF "ACL condition"
41808 .cindex ACL "spf condition"
41809 The ACL condition "spf" can be used at or after the MAIL ACL.
41810 It takes as an argument a list of strings giving the outcome of the SPF check,
41811 and will succeed for any matching outcome.
41812 Valid strings are:
41813 .vlist
41814 .vitem &%pass%&
41815 The SPF check passed, the sending host is positively verified by SPF.
41816
41817 .vitem &%fail%&
41818 The SPF check failed, the sending host is NOT allowed to send mail for the
41819 domain in the envelope-from address.
41820
41821 .vitem &%softfail%&
41822 The SPF check failed, but the queried domain can't absolutely confirm that this
41823 is a forgery.
41824
41825 .vitem &%none%&
41826 The queried domain does not publish SPF records.
41827
41828 .vitem &%neutral%&
41829 The SPF check returned a "neutral" state.  This means the queried domain has
41830 published a SPF record, but wants to allow outside servers to send mail under
41831 its domain as well.  This should be treated like "none".
41832
41833 .vitem &%permerror%&
41834 This indicates a syntax error in the SPF record of the queried domain.
41835 You may deny messages when this occurs.
41836
41837 .vitem &%temperror%&
41838 This indicates a temporary error during all processing, including Exim's
41839 SPF processing.  You may defer messages when this occurs.
41840
41841 .vitem &%invalid%&
41842 There was an error during processing of the SPF lookup
41843 .endlist
41844
41845 You can prefix each string with an exclamation mark to  invert
41846 its meaning,  for example  "!fail" will  match all  results but
41847 "fail".  The  string  list is  evaluated  left-to-right,  in a
41848 short-circuit fashion.
41849
41850 Example:
41851 .code
41852 deny spf = fail
41853      message = $sender_host_address is not allowed to send mail from \
41854                ${if def:sender_address_domain \
41855                     {$sender_address_domain}{$sender_helo_name}}.  \
41856                Please see http://www.open-spf.org/Why;\
41857                identity=${if def:sender_address_domain \
41858                              {$sender_address}{$sender_helo_name}};\
41859                ip=$sender_host_address
41860 .endd
41861
41862 Note: The above mentioned URL may not be as helpful as expected. You are
41863 encouraged to replace the link with a link to a site with more
41864 explanations.
41865
41866 When the spf condition has run, it sets up several expansion
41867 variables:
41868
41869 .cindex SPF "verification variables"
41870 .vlist
41871 .vitem &$spf_header_comment$&
41872 .vindex &$spf_header_comment$&
41873   This contains a human-readable string describing the outcome
41874   of the SPF check. You can add it to a custom header or use
41875   it for logging purposes.
41876
41877 .vitem &$spf_received$&
41878 .vindex &$spf_received$&
41879   This contains a complete Received-SPF: header (name and
41880   content) that can be added to the message. Please note that
41881   according to the SPF draft, this header must be added at the
41882   top of the header list, i.e. with
41883 .code
41884 add_header = :at_start:$spf_received
41885 .endd
41886   See section &<<SECTaddheadacl>>& for further details.
41887
41888   Note: in case of "Best-guess" (see below), the convention is
41889   to put this string in a header called X-SPF-Guess: instead.
41890
41891 .vitem &$spf_result$&
41892 .vindex &$spf_result$&
41893   This contains the outcome of the SPF check in string form,
41894   currently one of pass, fail, softfail, none, neutral, permerror,
41895   temperror, or &"(invalid)"&.
41896
41897 .vitem &$spf_result_guessed$&
41898 .vindex &$spf_result_guessed$&
41899   This boolean is true only if a best-guess operation was used
41900   and required in order to obtain a result.
41901
41902 .vitem &$spf_smtp_comment$&
41903 .vindex &$spf_smtp_comment$&
41904 .vindex &%spf_smtp_comment_template%&
41905   This contains a string that can be used in a SMTP response
41906   to the calling party. Useful for "fail".
41907   The string is generated by the SPF library from the template configured in the main config
41908   option &%spf_smtp_comment_template%&.
41909 .endlist
41910
41911
41912 .cindex SPF "ACL condition"
41913 .cindex ACL "spf_guess condition"
41914 .cindex SPF "best guess"
41915 In addition to SPF, you can also perform checks for so-called
41916 "Best-guess".  Strictly speaking, "Best-guess" is not standard
41917 SPF, but it is supported by the same framework that enables SPF
41918 capability.
41919 Refer to &url(http://www.open-spf.org/FAQ/Best_guess_record)
41920 for a description of what it means.
41921 . --- 2019-10-28: still not https:
41922
41923 To access this feature, simply use the spf_guess condition in place
41924 of the spf one.  For example:
41925
41926 .code
41927 deny spf_guess = fail
41928      message = $sender_host_address doesn't look trustworthy to me
41929 .endd
41930
41931 In case you decide to reject messages based on this check, you
41932 should note that although it uses the same framework, "Best-guess"
41933 is not SPF, and therefore you should not mention SPF at all in your
41934 reject message.
41935
41936 When the spf_guess condition has run, it sets up the same expansion
41937 variables as when spf condition is run, described above.
41938
41939 Additionally, since Best-guess is not standardized, you may redefine
41940 what "Best-guess" means to you by redefining the main configuration
41941 &%spf_guess%& option.
41942 For example, the following:
41943
41944 .code
41945 spf_guess = v=spf1 a/16 mx/16 ptr ?all
41946 .endd
41947
41948 would relax host matching rules to a broader network range.
41949
41950
41951 .cindex SPF "lookup expansion"
41952 .cindex lookup spf
41953 A lookup expansion is also available. It takes an email
41954 address as the key and an IP address
41955 (v4 or v6)
41956 as the database:
41957
41958 .code
41959   ${lookup {username@domain} spf {ip.ip.ip.ip}}
41960 .endd
41961
41962 The lookup will return the same result strings as can appear in
41963 &$spf_result$& (pass,fail,softfail,neutral,none,err_perm,err_temp).
41964
41965
41966
41967
41968
41969 .section "SRS (Sender Rewriting Scheme)" SECTSRS
41970 .cindex SRS "sender rewriting scheme"
41971
41972 .new
41973 SRS can be used to modify sender addresses when forwarding so that
41974 SPF verification does not object to them.
41975 It operates by encoding the original envelope sender in a new
41976 sender local part and using a domain run by the forwarding site
41977 as the new domain for the sender.  Any DSN message should be returned
41978 to this new sender at the forwarding site, which can extract the
41979 original sender from the coded local part and forward the DSN to
41980 the originator.
41981
41982 This is a way of avoiding the breakage that SPF does to forwarding.
41983 The constructed local-part will be longer than the original,
41984 leading to possible problems with very long addresses.
41985 The changing of the sender address also hinders the tracing of mail
41986 problems.
41987
41988 Exim can be built to include native SRS support.  To do this
41989 SUPPORT_SRS=yes must be defined in &_Local/Makefile_&.
41990 If this has been done, the macros _HAVE_SRS and _HAVE_NATIVE_SRS
41991 will be defined.
41992 The support is limited to SRS0-encoding; SRS1 is not supported.
41993
41994 .cindex SRS excoding
41995 To encode an address use this expansion item:
41996 .vlist
41997 .vitem &*${srs_encode&~{*&<&'secret'&>&*}{*&<&'return&~path'&>&*}{*&<&'original&~domain'&>&*}}*&
41998 .cindex "&%srs_encode%& expansion item"
41999 .cindex SRS "expansion item"
42000 The first argument should be a secret known and used by all systems
42001 handling the recipient domain for the original message.
42002 There is no need to periodically change this key; a timestamp is also
42003 encoded.
42004 The second argument should be given as the envelope sender address before this
42005 encoding operation.
42006 The third argument should be the recipient domain of the message when
42007 it arrived at this system.
42008 .endlist
42009
42010 .cindex SRS decoding
42011 To decode an address use this expansion condition:
42012 .vlist
42013 .vitem &*inbound_srs&~{*&<&'local&~part'&>&*}{*&<&'secret'&>&*}*&
42014 The first argument should be the recipient local prt as is was received.
42015 The second argument is the site secret.
42016
42017 If the messages is not for an SRS-encoded recipient the condition will
42018 return false.  If it is, the condition will return true and the variable
42019 &$srs_recipient$& will be set to the decoded (original) value.
42020 .endlist
42021
42022 Example usage:
42023 .code
42024   #macro
42025   SRS_SECRET = <pick something unique for your site for this. Use on all MXs.>
42026
42027   #routers
42028
42029   outbound:
42030     driver =    dnslookup
42031     # if outbound, and forwarding has been done, use an alternate transport
42032     domains =   ! +my_domains
42033     transport = ${if eq {$local_part@$domain} \
42034                         {$original_local_part@$original_domain} \
42035                      {remote_smtp} {remote_forwarded_smtp}}
42036
42037   inbound_srs:
42038     driver =    redirect
42039     senders =   :
42040     domains =   +my_domains
42041     # detect inbound bounces which are SRS'd, and decode them
42042     condition = ${if inbound_srs {$local_part} {SRS_SECRET}}
42043     data =      $srs_recipient
42044
42045   inbound_srs_failure:
42046     driver =    redirect
42047     senders =   :
42048     domains =   +my_domains
42049     # detect inbound bounces which look SRS'd but are invalid
42050     condition = ${if inbound_srs {$local_part} {}}
42051     allow_fail
42052     data =      :fail: Invalid SRS recipient address
42053
42054   #... further routers here
42055
42056
42057   # transport; should look like the non-forward outbound
42058   # one, plus the max_rcpt and return_path options
42059   remote_forwarded_smtp:
42060     driver =              smtp
42061     # modify the envelope from, for mails that we forward
42062     max_rcpt =            1
42063     return_path =         ${srs_encode {SRS_SECRET} {$return_path} {$original_domain}}
42064 .endd
42065
42066
42067 .wen
42068
42069
42070
42071 .section DMARC SECDMARC
42072 .cindex DMARC verification
42073
42074 DMARC combines feedback from SPF, DKIM, and header From: in order
42075 to attempt to provide better indicators of the authenticity of an
42076 email.  This document does not explain the fundamentals; you
42077 should read and understand how it works by visiting the website at
42078 &url(http://www.dmarc.org/).
42079
42080 If Exim is built with DMARC support,
42081 the libopendmarc library is used.
42082
42083 For building Exim yourself, obtain the library from
42084 &url(http://sourceforge.net/projects/opendmarc/)
42085 to obtain a copy, or find it in your favorite package
42086 repository.  You will need to attend to the local/Makefile feature
42087 SUPPORT_DMARC and the associated LDFLAGS addition.
42088 This description assumes
42089 that headers will be in /usr/local/include, and that the libraries
42090 are in /usr/local/lib.
42091
42092 . subsection
42093
42094 There are three main-configuration options:
42095 .cindex DMARC "configuration options"
42096
42097 The &%dmarc_tld_file%& option
42098 .oindex &%dmarc_tld_file%&
42099 defines the location of a text file of valid
42100 top level domains the opendmarc library uses
42101 during domain parsing. Maintained by Mozilla,
42102 the most current version can be downloaded
42103 from a link at &url(https://publicsuffix.org/list/public_suffix_list.dat).
42104 See also the util/renew-opendmarc-tlds.sh script.
42105 The default for the option is unset.
42106 If not set, DMARC processing is disabled.
42107
42108
42109 The &%dmarc_history_file%& option, if set
42110 .oindex &%dmarc_history_file%&
42111 defines the location of a file to log results
42112 of dmarc verification on inbound emails. The
42113 contents are importable by the opendmarc tools
42114 which will manage the data, send out DMARC
42115 reports, and expire the data. Make sure the
42116 directory of this file is writable by the user
42117 exim runs as.
42118 The default is unset.
42119
42120 The &%dmarc_forensic_sender%& option
42121 .oindex &%dmarc_forensic_sender%&
42122 defines an alternate email address to use when sending a
42123 forensic report detailing alignment failures
42124 if a sender domain's dmarc record specifies it
42125 and you have configured Exim to send them.
42126 If set, this is expanded and used for the
42127 From: header line; the address is extracted
42128 from it and used for the envelope from.
42129 If not set (the default), the From: header is expanded from
42130 the dsn_from option, and <> is used for the
42131 envelope from.
42132
42133 . I wish we had subsections...
42134
42135 .cindex DMARC controls
42136 By default, the DMARC processing will run for any remote,
42137 non-authenticated user.  It makes sense to only verify DMARC
42138 status of messages coming from remote, untrusted sources.  You can
42139 use standard conditions such as hosts, senders, etc, to decide that
42140 DMARC verification should *not* be performed for them and disable
42141 DMARC with an ACL control modifier:
42142 .code
42143   control = dmarc_disable_verify
42144 .endd
42145 A DMARC record can also specify a "forensic address", which gives
42146 exim an email address to submit reports about failed alignment.
42147 Exim does not do this by default because in certain conditions it
42148 results in unintended information leakage (what lists a user might
42149 be subscribed to, etc).  You must configure exim to submit forensic
42150 reports to the owner of the domain.  If the DMARC record contains a
42151 forensic address and you specify the control statement below, then
42152 exim will send these forensic emails.  It is also advised that you
42153 configure a &%dmarc_forensic_sender%& because the default sender address
42154 construction might be inadequate.
42155 .code
42156   control = dmarc_enable_forensic
42157 .endd
42158 (AGAIN: You can choose not to send these forensic reports by simply
42159 not putting the dmarc_enable_forensic control line at any point in
42160 your exim config.  If you don't tell exim to send them, it will not
42161 send them.)
42162
42163 There are no options to either control.  Both must appear before
42164 the DATA acl.
42165
42166 . subsection
42167
42168 DMARC checks cam be run on incoming SMTP  messages by using the
42169 &"dmarc_status"& ACL condition in the DATA ACL.  You are required to
42170 call the &"spf"& condition first in the ACLs, then the &"dmarc_status"&
42171 condition.  Putting this condition in the ACLs is required in order
42172 for a DMARC check to actually occur.  All of the variables are set
42173 up before the DATA ACL, but there is no actual DMARC check that
42174 occurs until a &"dmarc_status"& condition is encountered in the ACLs.
42175
42176 The &"dmarc_status"& condition takes a list of strings on its
42177 right-hand side.  These strings describe recommended action based
42178 on the DMARC check.  To understand what the policy recommendations
42179 mean, refer to the DMARC website above.  Valid strings are:
42180 .display
42181 &'accept      '& The DMARC check passed and the library recommends accepting the email.
42182 &'reject      '& The DMARC check failed and the library recommends rejecting the email.
42183 &'quarantine  '& The DMARC check failed and the library recommends keeping it for further inspection.
42184 &'none        '& The DMARC check passed and the library recommends no specific action, neutral.
42185 &'norecord    '& No policy section in the DMARC record for this RFC5322.From field
42186 &'nofrom      '& Unable to determine the domain of the sender.
42187 &'temperror   '& Library error or dns error.
42188 &'off         '& The DMARC check was disabled for this email.
42189 .endd
42190 You can prefix each string with an exclamation mark to invert its
42191 meaning, for example "!accept" will match all results but
42192 "accept".  The string list is evaluated left-to-right in a
42193 short-circuit fashion.  When a string matches the outcome of the
42194 DMARC check, the condition succeeds.  If none of the listed
42195 strings matches the outcome of the DMARC check, the condition
42196 fails.
42197
42198 Of course, you can also use any other lookup method that Exim
42199 supports, including LDAP, Postgres, MySQL, etc, as long as the
42200 result is a list of colon-separated strings.
42201
42202 Performing the check sets up information used by the
42203 &%authresults%& expansion item.
42204
42205 Several expansion variables are set before the DATA ACL is
42206 processed, and you can use them in this ACL.  The following
42207 expansion variables are available:
42208
42209 .vlist
42210 .vitem &$dmarc_status$&
42211 .vindex &$dmarc_status$&
42212 .cindex DMARC result
42213 A one word status indicating what the DMARC library
42214 thinks of the email.  It is a combination of the results of
42215 DMARC record lookup and the SPF/DKIM/DMARC processing results
42216 (if a DMARC record was found).  The actual policy declared
42217 in the DMARC record is in a separate expansion variable.
42218
42219 .vitem &$dmarc_status_text$&
42220 .vindex &$dmarc_status_text$&
42221 Slightly longer, human readable status.
42222
42223 .vitem &$dmarc_used_domain$&
42224 .vindex &$dmarc_used_domain$&
42225 The domain which DMARC used to look up the DMARC policy record.
42226
42227 .vitem &$dmarc_domain_policy$&
42228 .vindex &$dmarc_domain_policy$&
42229 The policy declared in the DMARC record.  Valid values
42230 are "none", "reject" and "quarantine".  It is blank when there
42231 is any error, including no DMARC record.
42232 .endlist
42233
42234 . subsection
42235
42236 By default, Exim's DMARC configuration is intended to be
42237 non-intrusive and conservative.  To facilitate this, Exim will not
42238 create any type of logging files without explicit configuration by
42239 you, the admin.  Nor will Exim send out any emails/reports about
42240 DMARC issues without explicit configuration by you, the admin (other
42241 than typical bounce messages that may come about due to ACL
42242 processing or failure delivery issues).
42243
42244 In order to log statistics suitable to be imported by the opendmarc
42245 tools, you need to:
42246 .ilist
42247 Configure the global option &%dmarc_history_file%&
42248 .next
42249 Configure cron jobs to call the appropriate opendmarc history
42250 import scripts and truncating the dmarc_history_file
42251 .endlist
42252
42253 In order to send forensic reports, you need to:
42254 .ilist
42255 Configure the global option &%dmarc_forensic_sender%&
42256 .next
42257 Configure, somewhere before the DATA ACL, the control option to
42258 enable sending DMARC forensic reports
42259 .endlist
42260
42261 . subsection
42262
42263 Example usage:
42264 .code
42265 (RCPT ACL)
42266   warn    domains        = +local_domains
42267           hosts          = +local_hosts
42268           control        = dmarc_disable_verify
42269
42270   warn    !domains       = +screwed_up_dmarc_records
42271           control        = dmarc_enable_forensic
42272
42273   warn    condition      = (lookup if destined to mailing list)
42274           set acl_m_mailing_list = 1
42275
42276 (DATA ACL)
42277   warn    dmarc_status   = accept : none : off
42278           !authenticated = *
42279           log_message    = DMARC DEBUG: $dmarc_status $dmarc_used_domain
42280
42281   warn    dmarc_status   = !accept
42282           !authenticated = *
42283           log_message    = DMARC DEBUG: '$dmarc_status' for $dmarc_used_domain
42284
42285   warn    dmarc_status   = quarantine
42286           !authenticated = *
42287           set $acl_m_quarantine = 1
42288           # Do something in a transport with this flag variable
42289
42290   deny    condition      = ${if eq{$dmarc_domain_policy}{reject}}
42291           condition      = ${if eq{$acl_m_mailing_list}{1}}
42292           message        = Messages from $dmarc_used_domain break mailing lists
42293
42294   deny    dmarc_status   = reject
42295           !authenticated = *
42296           message        = Message from $dmarc_used_domain failed sender's DMARC policy, REJECT
42297
42298   warn    add_header     = :at_start:${authresults {$primary_hostname}}
42299 .endd
42300
42301
42302
42303
42304
42305 . ////////////////////////////////////////////////////////////////////////////
42306 . ////////////////////////////////////////////////////////////////////////////
42307
42308 .chapter "Proxies" "CHAPproxies" &&&
42309          "Proxy support"
42310 .cindex "proxy support"
42311 .cindex "proxy" "access via"
42312
42313 A proxy is an intermediate system through which communication is passed.
42314 Proxies may provide a security, availability or load-distribution function.
42315
42316
42317 .section "Inbound proxies" SECTproxyInbound
42318 .cindex proxy inbound
42319 .cindex proxy "server side"
42320 .cindex proxy "Proxy protocol"
42321 .cindex "Proxy protocol" proxy
42322
42323 Exim has support for receiving inbound SMTP connections via a proxy
42324 that uses &"Proxy Protocol"& to speak to it.
42325 To include this support, include &"SUPPORT_PROXY=yes"&
42326 in Local/Makefile.
42327
42328 It was built on the HAProxy specification, found at
42329 &url(https://www.haproxy.org/download/1.8/doc/proxy-protocol.txt).
42330
42331 The purpose of this facility is so that an application load balancer,
42332 such as HAProxy, can sit in front of several Exim servers
42333 to distribute load.
42334 Exim uses the local protocol communication with the proxy to obtain
42335 the remote SMTP system IP address and port information.
42336 There is no logging if a host passes or
42337 fails Proxy Protocol negotiation, but it can easily be determined and
42338 recorded in an ACL (example is below).
42339
42340 Use of a proxy is enabled by setting the &%hosts_proxy%&
42341 main configuration option to a hostlist; connections from these
42342 hosts will use Proxy Protocol.
42343 Exim supports both version 1 and version 2 of the Proxy Protocol and
42344 automatically determines which version is in use.
42345
42346 The Proxy Protocol header is the first data received on a TCP connection
42347 and is inserted before any TLS-on-connect handshake from the client; Exim
42348 negotiates TLS between Exim-as-server and the remote client, not between
42349 Exim and the proxy server. The Proxy Protocol header must be received
42350 within &%proxy_protocol_timeout%&, which defaults to 3s.
42351
42352 The following expansion variables are usable
42353 (&"internal"& and &"external"& here refer to the interfaces
42354 of the proxy):
42355 .display
42356 &'proxy_external_address   '& IP of host being proxied or IP of remote interface of proxy
42357 &'proxy_external_port      '& Port of host being proxied or Port on remote interface of proxy
42358 &'proxy_local_address      '& IP of proxy server inbound or IP of local interface of proxy
42359 &'proxy_local_port         '& Port of proxy server inbound or Port on local interface of proxy
42360 &'proxy_session            '& boolean: SMTP connection via proxy
42361 .endd
42362 If &$proxy_session$& is set but &$proxy_external_address$& is empty
42363 there was a protocol error.
42364 The variables &$sender_host_address$& and &$sender_host_port$&
42365 will have values for the actual client system, not the proxy.
42366
42367 Since the real connections are all coming from the proxy, and the
42368 per host connection tracking is done before Proxy Protocol is
42369 evaluated, &%smtp_accept_max_per_host%& must be set high enough to
42370 handle all of the parallel volume you expect per inbound proxy.
42371 With the option set so high, you lose the ability
42372 to protect your server from many connections from one IP.
42373 In order to prevent your server from overload, you
42374 need to add a per connection ratelimit to your connect ACL.
42375 A possible solution is:
42376 .display
42377   # Set max number of connections per host
42378   LIMIT   = 5
42379   # Or do some kind of IP lookup in a flat file or database
42380   # LIMIT = ${lookup{$sender_host_address}iplsearch{/etc/exim/proxy_limits}}
42381
42382   defer   ratelimit      = LIMIT / 5s / per_conn / strict
42383           message        = Too many connections from this IP right now
42384 .endd
42385
42386
42387
42388 .section "Outbound proxies" SECTproxySOCKS
42389 .cindex proxy outbound
42390 .cindex proxy "client side"
42391 .cindex proxy SOCKS
42392 .cindex SOCKS proxy
42393 Exim has support for sending outbound SMTP via a proxy
42394 using a protocol called SOCKS5 (defined by RFC1928).
42395 The support can be optionally included by defining SUPPORT_SOCKS=yes in
42396 Local/Makefile.
42397
42398 Use of a proxy is enabled by setting the &%socks_proxy%& option
42399 on an smtp transport.
42400 The option value is expanded and should then be a list
42401 (colon-separated by default) of proxy specifiers.
42402 Each proxy specifier is a list
42403 (space-separated by default) where the initial element
42404 is an IP address and any subsequent elements are options.
42405
42406 Options are a string <name>=<value>.
42407 The list of options is in the following table:
42408 .display
42409 &'auth   '& authentication method
42410 &'name   '& authentication username
42411 &'pass   '& authentication password
42412 &'port   '& tcp port
42413 &'tmo    '& connection timeout
42414 &'pri    '& priority
42415 &'weight '& selection bias
42416 .endd
42417
42418 More details on each of these options follows:
42419
42420 .ilist
42421 .cindex authentication "to proxy"
42422 .cindex proxy authentication
42423 &%auth%&: Either &"none"& (default) or &"name"&.
42424 Using &"name"& selects username/password authentication per RFC 1929
42425 for access to the proxy.
42426 Default is &"none"&.
42427 .next
42428 &%name%&: sets the username for the &"name"& authentication method.
42429 Default is empty.
42430 .next
42431 &%pass%&: sets the password for the &"name"& authentication method.
42432 Default is empty.
42433 .next
42434 &%port%&: the TCP port number to use for the connection to the proxy.
42435 Default is 1080.
42436 .next
42437 &%tmo%&: sets a connection timeout in seconds for this proxy.
42438 Default is 5.
42439 .next
42440 &%pri%&: specifies a priority for the proxy within the list,
42441 higher values being tried first.
42442 The default priority is 1.
42443 .next
42444 &%weight%&: specifies a selection bias.
42445 Within a priority set servers are queried in a random fashion,
42446 weighted by this value.
42447 The default value for selection bias is 1.
42448 .endlist
42449
42450 Proxies from the list are tried according to their priority
42451 and weight settings until one responds.  The timeout for the
42452 overall connection applies to the set of proxied attempts.
42453
42454 .section Logging SECTproxyLog
42455 To log the (local) IP of a proxy in the incoming or delivery logline,
42456 add &"+proxy"& to the &%log_selector%& option.
42457 This will add a component tagged with &"PRX="& to the line.
42458
42459 . ////////////////////////////////////////////////////////////////////////////
42460 . ////////////////////////////////////////////////////////////////////////////
42461
42462 .chapter "Internationalisation" "CHAPi18n" &&&
42463          "Internationalisation""
42464 .cindex internationalisation "email address"
42465 .cindex EAI
42466 .cindex i18n
42467 .cindex utf8 "mail name handling"
42468
42469 Exim has support for Internationalised mail names.
42470 To include this it must be built with SUPPORT_I18N and the libidn library.
42471 Standards supported are RFCs 2060, 5890, 6530 and 6533.
42472
42473 If Exim is built with SUPPORT_I18N_2008 (in addition to SUPPORT_I18N, not
42474 instead of it) then IDNA2008 is supported; this adds an extra library
42475 requirement, upon libidn2.
42476
42477 .section "MTA operations" SECTi18nMTA
42478 .cindex SMTPUTF8 "ESMTP option"
42479 .cindex "ESMTP extensions" SMTPUTF8
42480 The main configuration option &%smtputf8_advertise_hosts%& specifies
42481 a host list.  If this matches the sending host and
42482 accept_8bitmime is true (the default) then the ESMTP option
42483 SMTPUTF8 will be advertised.
42484
42485 If the sender specifies the SMTPUTF8 option on a MAIL command
42486 international handling for the message is enabled and
42487 the expansion variable &$message_smtputf8$& will have value TRUE.
42488
42489 The option &%allow_utf8_domains%& is set to true for this
42490 message. All DNS lookups are converted to a-label form
42491 whatever the setting of &%allow_utf8_domains%&
42492 when Exim is built with SUPPORT_I18N.
42493
42494 Both localparts and domain are maintained as the original
42495 UTF-8 form internally; any comparison or regular-expression use will
42496 require appropriate care.  Filenames created, eg. by
42497 the appendfile transport, will have UTF-8 names.
42498
42499 HELO names sent by the smtp transport will have any UTF-8
42500 components expanded to a-label form,
42501 and any certificate name checks will be done using the a-label
42502 form of the name.
42503
42504 .cindex log protocol
42505 .cindex SMTPUTF8 logging
42506 .cindex i18n logging
42507 Log lines and Received-by: header lines will acquire a "utf8"
42508 prefix on the protocol element, eg. utf8esmtp.
42509
42510 The following expansion operators can be used:
42511 .code
42512 ${utf8_domain_to_alabel:str}
42513 ${utf8_domain_from_alabel:str}
42514 ${utf8_localpart_to_alabel:str}
42515 ${utf8_localpart_from_alabel:str}
42516 .endd
42517
42518 .cindex utf8 "address downconversion"
42519 .cindex i18n "utf8 address downconversion"
42520 The RCPT ACL
42521 may use the following modifier:
42522 .display
42523 control = utf8_downconvert
42524 control = utf8_downconvert/<value>
42525 .endd
42526 This sets a flag requiring that envelope addresses are converted to
42527 a-label form before smtp delivery.
42528 This is usually for use in a Message Submission Agent context,
42529 but could be used for any message.
42530
42531 If a value is appended it may be:
42532 .display
42533 &`1  `& mandatory downconversion
42534 &`0  `& no downconversion
42535 &`-1 `& if SMTPUTF8 not supported by destination host
42536 .endd
42537 If no value is given, 1 is used.
42538
42539 If mua_wrapper is set, the utf8_downconvert control
42540 is initially set to -1.
42541
42542 The smtp transport has an option &%utf8_downconvert%&.
42543 If set it must expand to one of the three values described above,
42544 or an empty string.
42545 If non-empty it overrides value previously set
42546 (due to mua_wrapper or by an ACL control).
42547
42548
42549 There is no explicit support for VRFY and EXPN.
42550 Configurations supporting these should inspect
42551 &$smtp_command_argument$& for an SMTPUTF8 argument.
42552
42553 There is no support for LMTP on Unix sockets.
42554 Using the "lmtp" protocol option on an smtp transport,
42555 for LMTP over TCP, should work as expected.
42556
42557 There is no support for DSN unitext handling,
42558 and no provision for converting logging from or to UTF-8.
42559
42560
42561
42562 .section "MDA operations" SECTi18nMDA
42563 To aid in constructing names suitable for IMAP folders
42564 the following expansion operator can be used:
42565 .code
42566 ${imapfolder {<string>} {<sep>} {<specials>}}
42567 .endd
42568
42569 The string is converted from the charset specified by
42570 the "headers charset" command (in a filter file)
42571 or &%headers_charset%& main configuration option (otherwise),
42572 to the
42573 modified UTF-7 encoding specified by RFC 2060,
42574 with the following exception: All occurrences of <sep>
42575 (which has to be a single character)
42576 are replaced with periods ("."), and all periods and slashes that are not
42577 <sep> and are not in the <specials> string are BASE64 encoded.
42578
42579 The third argument can be omitted, defaulting to an empty string.
42580 The second argument can be omitted, defaulting to "/".
42581
42582 This is the encoding used by Courier for Maildir names on disk, and followed
42583 by many other IMAP servers.
42584
42585 Examples:
42586 .display
42587 &`${imapfolder {Foo/Bar}}       `& yields &`Foo.Bar`&
42588 &`${imapfolder {Foo/Bar}{.}{/}} `& yields &`Foo&&AC8-Bar`&
42589 &`${imapfolder {Räksmörgås}}    `& yields &`R&&AOQ-ksm&&APY-rg&&AOU-s`&
42590 .endd
42591
42592 Note that the source charset setting is vital, and also that characters
42593 must be representable in UTF-16.
42594
42595
42596 . ////////////////////////////////////////////////////////////////////////////
42597 . ////////////////////////////////////////////////////////////////////////////
42598
42599 .chapter "Events" "CHAPevents" &&&
42600          "Events"
42601 .cindex events
42602
42603 The events mechanism in Exim can be used to intercept processing at a number
42604 of points.  It was originally invented to give a way to do customised logging
42605 actions (for example, to a database) but can also be used to modify some
42606 processing actions.
42607
42608 Most installations will never need to use Events.
42609 The support can be left out of a build by defining DISABLE_EVENT=yes
42610 in &_Local/Makefile_&.
42611
42612 There are two major classes of events: main and transport.
42613 The main configuration option &%event_action%& controls reception events;
42614 a transport option &%event_action%& controls delivery events.
42615
42616 Both options are a string which is expanded when the event fires.
42617 An example might look like:
42618 .cindex logging custom
42619 .code
42620 event_action = ${if eq {msg:delivery}{$event_name} \
42621 {${lookup pgsql {SELECT * FROM record_Delivery( \
42622     '${quote_pgsql:$sender_address_domain}',\
42623     '${quote_pgsql:${lc:$sender_address_local_part}}', \
42624     '${quote_pgsql:$domain}', \
42625     '${quote_pgsql:${lc:$local_part}}', \
42626     '${quote_pgsql:$host_address}', \
42627     '${quote_pgsql:${lc:$host}}', \
42628     '${quote_pgsql:$message_exim_id}')}} \
42629 } {}}
42630 .endd
42631
42632 Events have names which correspond to the point in process at which they fire.
42633 The name is placed in the variable &$event_name$& and the event action
42634 expansion must check this, as it will be called for every possible event type.
42635
42636 The current list of events is:
42637 .display
42638 &`dane:fail              after    transport  `& per connection
42639 &`msg:complete           after    main       `& per message
42640 &`msg:defer              after    transport  `& per message per delivery try
42641 &`msg:delivery           after    transport  `& per recipient
42642 &`msg:rcpt:host:defer    after    transport  `& per recipient per host
42643 &`msg:rcpt:defer         after    transport  `& per recipient
42644 &`msg:host:defer         after    transport  `& per host per delivery try; host errors
42645 &`msg:fail:delivery      after    transport  `& per recipient
42646 &`msg:fail:internal      after    main       `& per recipient
42647 &`tcp:connect            before   transport  `& per connection
42648 &`tcp:close              after    transport  `& per connection
42649 &`tls:cert               before   both       `& per certificate in verification chain
42650 &`smtp:connect           after    transport  `& per connection
42651 &`smtp:ehlo              after    transport  `& per connection
42652 .endd
42653 New event types may be added in future.
42654
42655 The event name is a colon-separated list, defining the type of
42656 event in a tree of possibilities.  It may be used as a list
42657 or just matched on as a whole.  There will be no spaces in the name.
42658
42659 The second column in the table above describes whether the event fires
42660 before or after the action is associates with.  Those which fire before
42661 can be used to affect that action (more on this below).
42662
42663 The third column in the table above says what section of the configuration
42664 should define the event action.
42665
42666 An additional variable, &$event_data$&, is filled with information varying
42667 with the event type:
42668 .display
42669 &`dane:fail            `& failure reason
42670 &`msg:defer            `& error string
42671 &`msg:delivery         `& smtp confirmation message
42672 &`msg:fail:internal    `& failure reason
42673 &`msg:fail:delivery    `& smtp error message
42674 &`msg:host:defer       `& error string
42675 &`msg:rcpt:host:defer  `& error string
42676 &`msg:rcpt:defer       `& error string
42677 &`tls:cert             `& verification chain depth
42678 &`smtp:connect         `& smtp banner
42679 &`smtp:ehlo            `& smtp ehlo response
42680 .endd
42681
42682 The :defer events populate one extra variable: &$event_defer_errno$&.
42683
42684 For complex operations an ACL expansion can be used in &%event_action%&
42685 however due to the multiple contexts that Exim operates in during
42686 the course of its processing:
42687 .ilist
42688 variables set in transport events will not be visible outside that
42689 transport call
42690 .next
42691 acl_m variables in a server context are lost on a new connection,
42692 and after smtp helo/ehlo/mail/starttls/rset commands
42693 .endlist
42694 Using an ACL expansion with the logwrite modifier can be
42695 a useful way of writing to the main log.
42696
42697 The expansion of the event_action option should normally
42698 return an empty string.  Should it return anything else the
42699 following will be forced:
42700 .display
42701 &`tcp:connect      `&  do not connect
42702 &`tls:cert         `&  refuse verification
42703 &`smtp:connect     `&  close connection
42704 .endd
42705 All other message types ignore the result string, and
42706 no other use is made of it.
42707
42708 For a tcp:connect event, if the connection is being made to a proxy
42709 then the address and port variables will be that of the proxy and not
42710 the target system.
42711
42712 For tls:cert events, if GnuTLS is in use this will trigger only per
42713 chain element received on the connection.
42714 For OpenSSL it will trigger for every chain element including those
42715 loaded locally.
42716
42717 . ////////////////////////////////////////////////////////////////////////////
42718 . ////////////////////////////////////////////////////////////////////////////
42719
42720 .chapter "Adding new drivers or lookup types" "CHID13" &&&
42721          "Adding drivers or lookups"
42722 .cindex "adding drivers"
42723 .cindex "new drivers, adding"
42724 .cindex "drivers" "adding new"
42725 The following actions have to be taken in order to add a new router, transport,
42726 authenticator, or lookup type to Exim:
42727
42728 .olist
42729 Choose a name for the driver or lookup type that does not conflict with any
42730 existing name; I will use &"newdriver"& in what follows.
42731 .next
42732 Add to &_src/EDITME_& the line:
42733 .display
42734 <&'type'&>&`_NEWDRIVER=yes`&
42735 .endd
42736 where <&'type'&> is ROUTER, TRANSPORT, AUTH, or LOOKUP. If the
42737 code is not to be included in the binary by default, comment this line out. You
42738 should also add any relevant comments about the driver or lookup type.
42739 .next
42740 Add to &_src/config.h.defaults_& the line:
42741 .code
42742 #define <type>_NEWDRIVER
42743 .endd
42744 .next
42745 Edit &_src/drtables.c_&, adding conditional code to pull in the private header
42746 and create a table entry as is done for all the other drivers and lookup types.
42747 .next
42748 Edit &_scripts/lookups-Makefile_& if this is a new lookup; there is a for-loop
42749 near the bottom, ranging the &`name_mod`& variable over a list of all lookups.
42750 Add your &`NEWDRIVER`& to that list.
42751 As long as the dynamic module would be named &_newdriver.so_&, you can use the
42752 simple form that most lookups have.
42753 .next
42754 Edit &_Makefile_& in the appropriate sub-directory (&_src/routers_&,
42755 &_src/transports_&, &_src/auths_&, or &_src/lookups_&); add a line for the new
42756 driver or lookup type and add it to the definition of OBJ.
42757 .next
42758 Edit &_OS/Makefile-Base_& adding a &_.o_& file for the predefined-macros, to the
42759 definition of OBJ_MACRO.  Add a set of line to do the compile also.
42760 .next
42761 Create &_newdriver.h_& and &_newdriver.c_& in the appropriate sub-directory of
42762 &_src_&.
42763 .next
42764 Edit &_scripts/MakeLinks_& and add commands to link the &_.h_& and &_.c_& files
42765 as for other drivers and lookups.
42766 .endlist
42767
42768 Then all you need to do is write the code! A good way to start is to make a
42769 proforma by copying an existing module of the same type, globally changing all
42770 occurrences of the name, and cutting out most of the code. Note that any
42771 options you create must be listed in alphabetical order, because the tables are
42772 searched using a binary chop procedure.
42773
42774 There is a &_README_& file in each of the sub-directories of &_src_& describing
42775 the interface that is expected.
42776
42777
42778
42779
42780 . ////////////////////////////////////////////////////////////////////////////
42781 . ////////////////////////////////////////////////////////////////////////////
42782
42783 . /////////////////////////////////////////////////////////////////////////////
42784 . These lines are processing instructions for the Simple DocBook Processor that
42785 . Philip Hazel has developed as a less cumbersome way of making PostScript and
42786 . PDFs than using xmlto and fop. They will be ignored by all other XML
42787 . processors.
42788 . /////////////////////////////////////////////////////////////////////////////
42789
42790 .literal xml
42791 <?sdop
42792   format="newpage"
42793   foot_right_recto="&chaptertitle;"
42794   foot_right_verso="&chaptertitle;"
42795 ?>
42796 .literal off
42797
42798 .makeindex "Options index"   "option"
42799 .makeindex "Variables index" "variable"
42800 .makeindex "Concept index"   "concept"
42801
42802
42803 . /////////////////////////////////////////////////////////////////////////////
42804 . /////////////////////////////////////////////////////////////////////////////