6d440e9382b15fa034f3e787d35cc89077f9e998
[users/heiko/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 .macro copyyear
55 2020
56 .endmacro
57
58 . /////////////////////////////////////////////////////////////////////////////
59 . Additional xfpt markup used by this document, over and above the default
60 . provided in the xfpt library.
61 . /////////////////////////////////////////////////////////////////////////////
62
63 . --- Override the &$ flag to automatically insert a $ with the variable name.
64
65 .flag &$  $&   "<varname>$"  "</varname>"
66
67 . --- Short flags for daggers in option headings. They will always be inside
68 . --- an italic string, but we want the daggers to be in Roman.
69
70 .flag &!!      "</emphasis>&dagger;<emphasis>"
71 .flag &!?      "</emphasis>&Dagger;<emphasis>"
72
73 . --- A macro for an Exim option definition heading, generating a one-line
74 . --- table with four columns. For cases when the option name is given with
75 . --- a space, so that it can be split, a fifth argument is used for the
76 . --- index entry.
77
78 .macro option
79 .arg 5
80 .oindex "&%$5%&"
81 .endarg
82 .arg -5
83 .oindex "&%$1%&"
84 .endarg
85 .itable all 0 0 4 8* left 6* center 6* center 6* right
86 .row "&%$1%&" "Use: &'$2'&" "Type: &'$3'&" "Default: &'$4'&"
87 .endtable
88 .endmacro
89
90 . --- A macro for the common 2-column tables. The width of the first column
91 . --- is suitable for the many tables at the start of the main options chapter;
92 . --- a small number of other 2-column tables override it.
93
94 .macro table2 196pt 254pt
95 .itable none 0 0 2 $1 left $2 left
96 .endmacro
97
98 . --- A macro that generates .row, but puts &I; at the start of the first
99 . --- argument, thus indenting it. Assume a minimum of two arguments, and
100 . --- allow up to four arguments, which is as many as we'll ever need.
101
102 .macro irow
103 .arg 4
104 .row "&I;$1" "$2" "$3" "$4"
105 .endarg
106 .arg -4
107 .arg 3
108 .row "&I;$1" "$2" "$3"
109 .endarg
110 .arg -3
111 .row "&I;$1" "$2"
112 .endarg
113 .endarg
114 .endmacro
115
116 . --- Macros for option, variable, and concept index entries. For a "range"
117 . --- style of entry, use .scindex for the start and .ecindex for the end. The
118 . --- first argument of .scindex and the only argument of .ecindex must be the
119 . --- ID that ties them together.
120
121 .macro cindex
122 &<indexterm role="concept">&
123 &<primary>&$1&</primary>&
124 .arg 2
125 &<secondary>&$2&</secondary>&
126 .endarg
127 &</indexterm>&
128 .endmacro
129
130 .macro scindex
131 &<indexterm role="concept" id="$1" class="startofrange">&
132 &<primary>&$2&</primary>&
133 .arg 3
134 &<secondary>&$3&</secondary>&
135 .endarg
136 &</indexterm>&
137 .endmacro
138
139 .macro ecindex
140 &<indexterm role="concept" startref="$1" class="endofrange"/>&
141 .endmacro
142
143 .macro oindex
144 &<indexterm role="option">&
145 &<primary>&$1&</primary>&
146 .arg 2
147 &<secondary>&$2&</secondary>&
148 .endarg
149 &</indexterm>&
150 .endmacro
151
152 .macro vindex
153 &<indexterm role="variable">&
154 &<primary>&$1&</primary>&
155 .arg 2
156 &<secondary>&$2&</secondary>&
157 .endarg
158 &</indexterm>&
159 .endmacro
160
161 .macro index
162 .echo "** Don't use .index; use .cindex or .oindex or .vindex"
163 .endmacro
164 . ////////////////////////////////////////////////////////////////////////////
165
166
167 . ////////////////////////////////////////////////////////////////////////////
168 . The <bookinfo> element is removed from the XML before processing for ASCII
169 . output formats.
170 . ////////////////////////////////////////////////////////////////////////////
171
172 .literal xml
173 <bookinfo>
174 <title>Specification of the Exim Mail Transfer Agent</title>
175 <titleabbrev>The Exim MTA</titleabbrev>
176 <date>
177 .fulldate
178 </date>
179 <author><firstname>Exim</firstname><surname>Maintainers</surname></author>
180 <authorinitials>EM</authorinitials>
181 <revhistory><revision>
182 .versiondatexml
183   <authorinitials>EM</authorinitials>
184 </revision></revhistory>
185 <copyright><year>
186 .copyyear
187            </year><holder>University of Cambridge</holder></copyright>
188 </bookinfo>
189 .literal off
190
191
192 . /////////////////////////////////////////////////////////////////////////////
193 . This chunk of literal XML implements index entries of the form "x, see y" and
194 . "x, see also y". However, the DocBook DTD doesn't allow <indexterm> entries
195 . at the top level, so we have to put the .chapter directive first.
196 . /////////////////////////////////////////////////////////////////////////////
197
198 .chapter "Introduction" "CHID1"
199 .literal xml
200
201 <indexterm role="variable">
202   <primary>$1, $2, etc.</primary>
203   <see><emphasis>numerical variables</emphasis></see>
204 </indexterm>
205 <indexterm role="concept">
206   <primary>address</primary>
207   <secondary>rewriting</secondary>
208   <see><emphasis>rewriting</emphasis></see>
209 </indexterm>
210 <indexterm role="concept">
211   <primary>Bounce Address Tag Validation</primary>
212   <see><emphasis>BATV</emphasis></see>
213 </indexterm>
214 <indexterm role="concept">
215   <primary>Client SMTP Authorization</primary>
216   <see><emphasis>CSA</emphasis></see>
217 </indexterm>
218 <indexterm role="concept">
219   <primary>CR character</primary>
220   <see><emphasis>carriage return</emphasis></see>
221 </indexterm>
222 <indexterm role="concept">
223   <primary>CRL</primary>
224   <see><emphasis>certificate revocation list</emphasis></see>
225 </indexterm>
226 <indexterm role="concept">
227   <primary>delivery</primary>
228   <secondary>failure report</secondary>
229   <see><emphasis>bounce message</emphasis></see>
230 </indexterm>
231 <indexterm role="concept">
232   <primary>dialup</primary>
233   <see><emphasis>intermittently connected hosts</emphasis></see>
234 </indexterm>
235 <indexterm role="concept">
236   <primary>exiscan</primary>
237   <see><emphasis>content scanning</emphasis></see>
238 </indexterm>
239 <indexterm role="concept">
240   <primary>failover</primary>
241   <see><emphasis>fallback</emphasis></see>
242 </indexterm>
243 <indexterm role="concept">
244   <primary>fallover</primary>
245   <see><emphasis>fallback</emphasis></see>
246 </indexterm>
247 <indexterm role="concept">
248   <primary>filter</primary>
249   <secondary>Sieve</secondary>
250   <see><emphasis>Sieve filter</emphasis></see>
251 </indexterm>
252 <indexterm role="concept">
253   <primary>ident</primary>
254   <see><emphasis>RFC 1413</emphasis></see>
255 </indexterm>
256 <indexterm role="concept">
257   <primary>LF character</primary>
258   <see><emphasis>linefeed</emphasis></see>
259 </indexterm>
260 <indexterm role="concept">
261   <primary>maximum</primary>
262   <seealso><emphasis>limit</emphasis></seealso>
263 </indexterm>
264 <indexterm role="concept">
265   <primary>monitor</primary>
266   <see><emphasis>Exim monitor</emphasis></see>
267 </indexterm>
268 <indexterm role="concept">
269   <primary>no_<emphasis>xxx</emphasis></primary>
270   <see>entry for xxx</see>
271 </indexterm>
272 <indexterm role="concept">
273   <primary>NUL</primary>
274   <see><emphasis>binary zero</emphasis></see>
275 </indexterm>
276 <indexterm role="concept">
277   <primary>passwd file</primary>
278   <see><emphasis>/etc/passwd</emphasis></see>
279 </indexterm>
280 <indexterm role="concept">
281   <primary>process id</primary>
282   <see><emphasis>pid</emphasis></see>
283 </indexterm>
284 <indexterm role="concept">
285   <primary>RBL</primary>
286   <see><emphasis>DNS list</emphasis></see>
287 </indexterm>
288 <indexterm role="concept">
289   <primary>redirection</primary>
290   <see><emphasis>address redirection</emphasis></see>
291 </indexterm>
292 <indexterm role="concept">
293   <primary>return path</primary>
294   <seealso><emphasis>envelope sender</emphasis></seealso>
295 </indexterm>
296 <indexterm role="concept">
297   <primary>scanning</primary>
298   <see><emphasis>content scanning</emphasis></see>
299 </indexterm>
300 <indexterm role="concept">
301   <primary>SSL</primary>
302   <see><emphasis>TLS</emphasis></see>
303 </indexterm>
304 <indexterm role="concept">
305   <primary>string</primary>
306   <secondary>expansion</secondary>
307   <see><emphasis>expansion</emphasis></see>
308 </indexterm>
309 <indexterm role="concept">
310   <primary>top bit</primary>
311   <see><emphasis>8-bit characters</emphasis></see>
312 </indexterm>
313 <indexterm role="concept">
314   <primary>variables</primary>
315   <see><emphasis>expansion, variables</emphasis></see>
316 </indexterm>
317 <indexterm role="concept">
318   <primary>zero, binary</primary>
319   <see><emphasis>binary zero</emphasis></see>
320 </indexterm>
321
322 .literal off
323
324
325 . /////////////////////////////////////////////////////////////////////////////
326 . This is the real start of the first chapter. See the comment above as to why
327 . we can't have the .chapter line here.
328 . chapter "Introduction"
329 . /////////////////////////////////////////////////////////////////////////////
330
331 Exim is a mail transfer agent (MTA) for hosts that are running Unix or
332 Unix-like operating systems. It was designed on the assumption that it would be
333 run on hosts that are permanently connected to the Internet. However, it can be
334 used on intermittently connected hosts with suitable configuration adjustments.
335
336 Configuration files currently exist for the following operating systems: AIX,
337 BSD/OS (aka BSDI), Darwin (Mac OS X), DGUX, Dragonfly, FreeBSD, GNU/Hurd,
338 GNU/Linux, HI-OSF (Hitachi), HI-UX, HP-UX, IRIX, MIPS RISCOS, NetBSD, OpenBSD,
339 OpenUNIX, QNX, SCO, SCO SVR4.2 (aka UNIX-SV), Solaris (aka SunOS5), SunOS4,
340 Tru64-Unix (formerly Digital UNIX, formerly DEC-OSF1), Ultrix, and UnixWare.
341 Some of these operating systems are no longer current and cannot easily be
342 tested, so the configuration files may no longer work in practice.
343
344 There are also configuration files for compiling Exim in the Cygwin environment
345 that can be installed on systems running Windows. However, this document does
346 not contain any information about running Exim in the Cygwin environment.
347
348 The terms and conditions for the use and distribution of Exim are contained in
349 the file &_NOTICE_&. Exim is distributed under the terms of the GNU General
350 Public Licence, a copy of which may be found in the file &_LICENCE_&.
351
352 The use, supply, or promotion of Exim for the purpose of sending bulk,
353 unsolicited electronic mail is incompatible with the basic aims of Exim,
354 which revolve around the free provision of a service that enhances the quality
355 of personal communications. The author of Exim regards indiscriminate
356 mass-mailing as an antisocial, irresponsible abuse of the Internet.
357
358 Exim owes a great deal to Smail 3 and its author, Ron Karr. Without the
359 experience of running and working on the Smail 3 code, I could never have
360 contemplated starting to write a new MTA. Many of the ideas and user interfaces
361 were originally taken from Smail 3, though the actual code of Exim is entirely
362 new, and has developed far beyond the initial concept.
363
364 Many people, both in Cambridge and around the world, have contributed to the
365 development and the testing of Exim, and to porting it to various operating
366 systems. I am grateful to them all. The distribution now contains a file called
367 &_ACKNOWLEDGMENTS_&, in which I have started recording the names of
368 contributors.
369
370
371 .section "Exim documentation" "SECID1"
372 . Keep this example change bar when updating the documentation!
373
374 .new
375 .cindex "documentation"
376 This edition of the Exim specification applies to version &version() of Exim.
377 Substantive changes from the &previousversion; edition are marked in some
378 renditions of this document; this paragraph is so marked if the rendition is
379 capable of showing a change indicator.
380 .wen
381
382 This document is very much a reference manual; it is not a tutorial. The reader
383 is expected to have some familiarity with the SMTP mail transfer protocol and
384 with general Unix system administration. Although there are some discussions
385 and examples in places, the information is mostly organized in a way that makes
386 it easy to look up, rather than in a natural order for sequential reading.
387 Furthermore, this manual aims to cover every aspect of Exim in detail, including
388 a number of rarely-used, special-purpose features that are unlikely to be of
389 very wide interest.
390
391 .cindex "books about Exim"
392 An &"easier"& discussion of Exim which provides more in-depth explanatory,
393 introductory, and tutorial material can be found in a book entitled &'The Exim
394 SMTP Mail Server'& (second edition, 2007), published by UIT Cambridge
395 (&url(https://www.uit.co.uk/exim-book/)).
396
397 The book also contains a chapter that gives a general introduction to SMTP and
398 Internet mail. Inevitably, however, the book is unlikely to be fully up-to-date
399 with the latest release of Exim. (Note that the earlier book about Exim,
400 published by O'Reilly, covers Exim 3, and many things have changed in Exim 4.)
401
402 .cindex "Debian" "information sources"
403 If you are using a Debian distribution of Exim, you will find information about
404 Debian-specific features in the file
405 &_/usr/share/doc/exim4-base/README.Debian_&.
406 The command &(man update-exim.conf)& is another source of Debian-specific
407 information.
408
409 .cindex "&_doc/NewStuff_&"
410 .cindex "&_doc/ChangeLog_&"
411 .cindex "change log"
412 As Exim develops, there may be features in newer versions that have not
413 yet made it into this document, which is updated only when the most significant
414 digit of the fractional part of the version number changes. Specifications of
415 new features that are not yet in this manual are placed in the file
416 &_doc/NewStuff_& in the Exim distribution.
417
418 Some features may be classified as &"experimental"&. These may change
419 incompatibly while they are developing, or even be withdrawn. For this reason,
420 they are not documented in this manual. Information about experimental features
421 can be found in the file &_doc/experimental.txt_&.
422
423 All changes to Exim (whether new features, bug fixes, or other kinds of
424 change) are noted briefly in the file called &_doc/ChangeLog_&.
425
426 .cindex "&_doc/spec.txt_&"
427 This specification itself is available as an ASCII file in &_doc/spec.txt_& so
428 that it can easily be searched with a text editor. Other files in the &_doc_&
429 directory are:
430
431 .table2 100pt
432 .row &_OptionLists.txt_&     "list of all options in alphabetical order"
433 .row &_dbm.discuss.txt_&     "discussion about DBM libraries"
434 .row &_exim.8_&              "a man page of Exim's command line options"
435 .row &_experimental.txt_&    "documentation of experimental features"
436 .row &_filter.txt_&          "specification of the filter language"
437 .row &_Exim3.upgrade_&       "upgrade notes from release 2 to release 3"
438 .row &_Exim4.upgrade_&       "upgrade notes from release 3 to release 4"
439 .row &_openssl.txt_&         "installing a current OpenSSL release"
440 .endtable
441
442 The main specification and the specification of the filtering language are also
443 available in other formats (HTML, PostScript, PDF, and Texinfo). Section
444 &<<SECTavail>>& below tells you how to get hold of these.
445
446
447
448 .section "FTP site and websites" "SECID2"
449 .cindex "website"
450 .cindex "FTP site"
451 The primary site for Exim source distributions is the &%exim.org%& FTP site,
452 available over HTTPS, HTTP and FTP.  These services, and the &%exim.org%&
453 website, are hosted at the University of Cambridge.
454
455 .cindex "wiki"
456 .cindex "FAQ"
457 As well as Exim distribution tar files, the Exim website contains a number of
458 differently formatted versions of the documentation. A recent addition to the
459 online information is the Exim wiki (&url(https://wiki.exim.org)),
460 which contains what used to be a separate FAQ, as well as various other
461 examples, tips, and know-how that have been contributed by Exim users.
462 The wiki site should always redirect to the correct place, which is currently
463 provided by GitHub, and is open to editing by anyone with a GitHub account.
464
465 .cindex Bugzilla
466 An Exim Bugzilla exists at &url(https://bugs.exim.org). You can use
467 this to report bugs, and also to add items to the wish list. Please search
468 first to check that you are not duplicating a previous entry.
469 Please do not ask for configuration help in the bug-tracker.
470
471
472 .section "Mailing lists" "SECID3"
473 .cindex "mailing lists" "for Exim users"
474 The following Exim mailing lists exist:
475
476 .table2 140pt
477 .row &'exim-announce@exim.org'&   "Moderated, low volume announcements list"
478 .row &'exim-users@exim.org'&      "General discussion list"
479 .row &'exim-dev@exim.org'&        "Discussion of bugs, enhancements, etc."
480 .row &'exim-cvs@exim.org'&        "Automated commit messages from the VCS"
481 .endtable
482
483 You can subscribe to these lists, change your existing subscriptions, and view
484 or search the archives via the mailing lists link on the Exim home page.
485 .cindex "Debian" "mailing list for"
486 If you are using a Debian distribution of Exim, you may wish to subscribe to
487 the Debian-specific mailing list &'pkg-exim4-users@lists.alioth.debian.org'&
488 via this web page:
489 .display
490 &url(https://alioth-lists.debian.net/cgi-bin/mailman/listinfo/pkg-exim4-users)
491 .endd
492 Please ask Debian-specific questions on that list and not on the general Exim
493 lists.
494
495 .section "Bug reports" "SECID5"
496 .cindex "bug reports"
497 .cindex "reporting bugs"
498 Reports of obvious bugs can be emailed to &'bugs@exim.org'& or reported
499 via the Bugzilla (&url(https://bugs.exim.org)). However, if you are unsure
500 whether some behaviour is a bug or not, the best thing to do is to post a
501 message to the &'exim-dev'& mailing list and have it discussed.
502
503
504
505 .section "Where to find the Exim distribution" "SECTavail"
506 .cindex "FTP site"
507 .cindex "HTTPS download site"
508 .cindex "distribution" "FTP site"
509 .cindex "distribution" "https site"
510 The master distribution site for the Exim distribution is
511 .display
512 &url(https://downloads.exim.org/)
513 .endd
514 The service is available over HTTPS, HTTP and FTP.
515 We encourage people to migrate to HTTPS.
516
517 The content served at &url(https://downloads.exim.org/) is identical to the
518 content served at &url(https://ftp.exim.org/pub/exim) and
519 &url(ftp://ftp.exim.org/pub/exim).
520
521 If accessing via a hostname containing &'ftp'&, then the file references that
522 follow are relative to the &_exim_& directories at these sites.
523 If accessing via the hostname &'downloads'& then the subdirectories described
524 here are top-level directories.
525
526 There are now quite a number of independent mirror sites around
527 the world. Those that I know about are listed in the file called &_Mirrors_&.
528
529 Within the top exim directory there are subdirectories called &_exim3_& (for
530 previous Exim 3 distributions), &_exim4_& (for the latest Exim 4
531 distributions), and &_Testing_& for testing versions. In the &_exim4_&
532 subdirectory, the current release can always be found in files called
533 .display
534 &_exim-n.nn.tar.xz_&
535 &_exim-n.nn.tar.gz_&
536 &_exim-n.nn.tar.bz2_&
537 .endd
538 where &'n.nn'& is the highest such version number in the directory. The three
539 files contain identical data; the only difference is the type of compression.
540 The &_.xz_& file is usually the smallest, while the &_.gz_& file is the
541 most portable to old systems.
542
543 .cindex "distribution" "signing details"
544 .cindex "distribution" "public key"
545 .cindex "public key for signed distribution"
546 The distributions will be PGP signed by an individual key of the Release
547 Coordinator.  This key will have a uid containing an email address in the
548 &'exim.org'& domain and will have signatures from other people, including
549 other Exim maintainers.  We expect that the key will be in the "strong set" of
550 PGP keys.  There should be a trust path to that key from the Exim Maintainer's
551 PGP keys, a version of which can be found in the release directory in the file
552 &_Exim-Maintainers-Keyring.asc_&.  All keys used will be available in public keyserver pools,
553 such as &'pool.sks-keyservers.net'&.
554
555 At the time of the last update, releases were being made by Jeremy Harris and signed
556 with key &'0xBCE58C8CE41F32DF'&.  Other recent keys used for signing are those
557 of Heiko Schlittermann, &'0x26101B62F69376CE'&,
558 and of Phil Pennock, &'0x4D1E900E14C1CC04'&.
559
560 The signatures for the tar bundles are in:
561 .display
562 &_exim-n.nn.tar.xz.asc_&
563 &_exim-n.nn.tar.gz.asc_&
564 &_exim-n.nn.tar.bz2.asc_&
565 .endd
566 For each released version, the log of changes is made available in a
567 separate file in the directory &_ChangeLogs_& so that it is possible to
568 find out what has changed without having to download the entire distribution.
569
570 .cindex "documentation" "available formats"
571 The main distribution contains ASCII versions of this specification and other
572 documentation; other formats of the documents are available in separate files
573 inside the &_exim4_& directory of the FTP site:
574 .display
575 &_exim-html-n.nn.tar.gz_&
576 &_exim-pdf-n.nn.tar.gz_&
577 &_exim-postscript-n.nn.tar.gz_&
578 &_exim-texinfo-n.nn.tar.gz_&
579 .endd
580 These tar files contain only the &_doc_& directory, not the complete
581 distribution, and are also available in &_.bz2_& and &_.xz_& forms.
582
583
584 .section "Limitations" "SECID6"
585 .ilist
586 .cindex "limitations of Exim"
587 .cindex "bang paths" "not handled by Exim"
588 Exim is designed for use as an Internet MTA, and therefore handles addresses in
589 RFC 2822 domain format only. It cannot handle UUCP &"bang paths"&, though
590 simple two-component bang paths can be converted by a straightforward rewriting
591 configuration. This restriction does not prevent Exim from being interfaced to
592 UUCP as a transport mechanism, provided that domain addresses are used.
593 .next
594 .cindex "domainless addresses"
595 .cindex "address" "without domain"
596 Exim insists that every address it handles has a domain attached. For incoming
597 local messages, domainless addresses are automatically qualified with a
598 configured domain value. Configuration options specify from which remote
599 systems unqualified addresses are acceptable. These are then qualified on
600 arrival.
601 .next
602 .cindex "transport" "external"
603 .cindex "external transports"
604 The only external transport mechanisms that are currently implemented are SMTP
605 and LMTP over a TCP/IP network (including support for IPv6). However, a pipe
606 transport is available, and there are facilities for writing messages to files
607 and pipes, optionally in &'batched SMTP'& format; these facilities can be used
608 to send messages to other transport mechanisms such as UUCP, provided they can
609 handle domain-style addresses. Batched SMTP input is also catered for.
610 .next
611 Exim is not designed for storing mail for dial-in hosts. When the volumes of
612 such mail are large, it is better to get the messages &"delivered"& into files
613 (that is, off Exim's queue) and subsequently passed on to the dial-in hosts by
614 other means.
615 .next
616 Although Exim does have basic facilities for scanning incoming messages, these
617 are not comprehensive enough to do full virus or spam scanning. Such operations
618 are best carried out using additional specialized software packages. If you
619 compile Exim with the content-scanning extension, straightforward interfaces to
620 a number of common scanners are provided.
621 .endlist
622
623
624 .section "Runtime configuration" "SECID7"
625 Exim's runtime configuration is held in a single text file that is divided
626 into a number of sections. The entries in this file consist of keywords and
627 values, in the style of Smail 3 configuration files. A default configuration
628 file which is suitable for simple online installations is provided in the
629 distribution, and is described in chapter &<<CHAPdefconfil>>& below.
630
631
632 .section "Calling interface" "SECID8"
633 .cindex "Sendmail compatibility" "command line interface"
634 Like many MTAs, Exim has adopted the Sendmail command line interface so that it
635 can be a straight replacement for &_/usr/lib/sendmail_& or
636 &_/usr/sbin/sendmail_& when sending mail, but you do not need to know anything
637 about Sendmail in order to run Exim. For actions other than sending messages,
638 Sendmail-compatible options also exist, but those that produce output (for
639 example, &%-bp%&, which lists the messages in the queue) do so in Exim's own
640 format. There are also some additional options that are compatible with Smail
641 3, and some further options that are new to Exim. Chapter &<<CHAPcommandline>>&
642 documents all Exim's command line options. This information is automatically
643 made into the man page that forms part of the Exim distribution.
644
645 Control of messages in the queue can be done via certain privileged command
646 line options. There is also an optional monitor program called &'eximon'&,
647 which displays current information in an X window, and which contains a menu
648 interface to Exim's command line administration options.
649
650
651
652 .section "Terminology" "SECID9"
653 .cindex "terminology definitions"
654 .cindex "body of message" "definition of"
655 The &'body'& of a message is the actual data that the sender wants to transmit.
656 It is the last part of a message and is separated from the &'header'& (see
657 below) by a blank line.
658
659 .cindex "bounce message" "definition of"
660 When a message cannot be delivered, it is normally returned to the sender in a
661 delivery failure message or a &"non-delivery report"& (NDR). The term
662 &'bounce'& is commonly used for this action, and the error reports are often
663 called &'bounce messages'&. This is a convenient shorthand for &"delivery
664 failure error report"&. Such messages have an empty sender address in the
665 message's &'envelope'& (see below) to ensure that they cannot themselves give
666 rise to further bounce messages.
667
668 The term &'default'& appears frequently in this manual. It is used to qualify a
669 value which is used in the absence of any setting in the configuration. It may
670 also qualify an action which is taken unless a configuration setting specifies
671 otherwise.
672
673 The term &'defer'& is used when the delivery of a message to a specific
674 destination cannot immediately take place for some reason (a remote host may be
675 down, or a user's local mailbox may be full). Such deliveries are &'deferred'&
676 until a later time.
677
678 The word &'domain'& is sometimes used to mean all but the first component of a
679 host's name. It is &'not'& used in that sense here, where it normally refers to
680 the part of an email address following the @ sign.
681
682 .cindex "envelope, definition of"
683 .cindex "sender" "definition of"
684 A message in transit has an associated &'envelope'&, as well as a header and a
685 body. The envelope contains a sender address (to which bounce messages should
686 be delivered), and any number of recipient addresses. References to the
687 sender or the recipients of a message usually mean the addresses in the
688 envelope. An MTA uses these addresses for delivery, and for returning bounce
689 messages, not the addresses that appear in the header lines.
690
691 .cindex "message" "header, definition of"
692 .cindex "header section" "definition of"
693 The &'header'& of a message is the first part of a message's text, consisting
694 of a number of lines, each of which has a name such as &'From:'&, &'To:'&,
695 &'Subject:'&, etc. Long header lines can be split over several text lines by
696 indenting the continuations. The header is separated from the body by a blank
697 line.
698
699 .cindex "local part" "definition of"
700 .cindex "domain" "definition of"
701 The term &'local part'&, which is taken from RFC 2822, is used to refer to the
702 part of an email address that precedes the @ sign. The part that follows the
703 @ sign is called the &'domain'& or &'mail domain'&.
704
705 .cindex "local delivery" "definition of"
706 .cindex "remote delivery, definition of"
707 The terms &'local delivery'& and &'remote delivery'& are used to distinguish
708 delivery to a file or a pipe on the local host from delivery by SMTP over
709 TCP/IP to another host. As far as Exim is concerned, all hosts other than the
710 host it is running on are &'remote'&.
711
712 .cindex "return path" "definition of"
713 &'Return path'& is another name that is used for the sender address in a
714 message's envelope.
715
716 .cindex "queue" "definition of"
717 The term &'queue'& is used to refer to the set of messages awaiting delivery
718 because this term is in widespread use in the context of MTAs. However, in
719 Exim's case, the reality is more like a pool than a queue, because there is
720 normally no ordering of waiting messages.
721
722 .cindex "queue runner" "definition of"
723 The term &'queue runner'& is used to describe a process that scans the queue
724 and attempts to deliver those messages whose retry times have come. This term
725 is used by other MTAs and also relates to the command &%runq%&, but in Exim
726 the waiting messages are normally processed in an unpredictable order.
727
728 .cindex "spool directory" "definition of"
729 The term &'spool directory'& is used for a directory in which Exim keeps the
730 messages in its queue &-- that is, those that it is in the process of
731 delivering. This should not be confused with the directory in which local
732 mailboxes are stored, which is called a &"spool directory"& by some people. In
733 the Exim documentation, &"spool"& is always used in the first sense.
734
735
736
737
738
739
740 . ////////////////////////////////////////////////////////////////////////////
741 . ////////////////////////////////////////////////////////////////////////////
742
743 .chapter "Incorporated code" "CHID2"
744 .cindex "incorporated code"
745 .cindex "regular expressions" "library"
746 .cindex "PCRE"
747 .cindex "OpenDMARC"
748 A number of pieces of external code are included in the Exim distribution.
749
750 .ilist
751 Regular expressions are supported in the main Exim program and in the
752 Exim monitor using the freely-distributable PCRE library, copyright
753 &copy; University of Cambridge. The source to PCRE is no longer shipped with
754 Exim, so you will need to use the version of PCRE shipped with your system,
755 or obtain and install the full version of the library from
756 &url(ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre).
757 .next
758 .cindex "cdb" "acknowledgment"
759 Support for the cdb (Constant DataBase) lookup method is provided by code
760 contributed by Nigel Metheringham of (at the time he contributed it) Planet
761 Online Ltd. The implementation is completely contained within the code of Exim.
762 It does not link against an external cdb library. The code contains the
763 following statements:
764
765 .blockquote
766 Copyright &copy; 1998 Nigel Metheringham, Planet Online Ltd
767
768 This program is free software; you can redistribute it and/or modify it under
769 the terms of the GNU General Public License as published by the Free Software
770 Foundation; either version 2 of the License, or (at your option) any later
771 version.
772 This code implements Dan Bernstein's Constant DataBase (cdb) spec. Information,
773 the spec and sample code for cdb can be obtained from
774 &url(https://cr.yp.to/cdb.html). This implementation borrows
775 some code from Dan Bernstein's implementation (which has no license
776 restrictions applied to it).
777 .endblockquote
778 .next
779 .cindex "SPA authentication"
780 .cindex "Samba project"
781 .cindex "Microsoft Secure Password Authentication"
782 Client support for Microsoft's &'Secure Password Authentication'& is provided
783 by code contributed by Marc Prud'hommeaux. Server support was contributed by
784 Tom Kistner. This includes code taken from the Samba project, which is released
785 under the Gnu GPL.
786 .next
787 .cindex "Cyrus"
788 .cindex "&'pwcheck'& daemon"
789 .cindex "&'pwauthd'& daemon"
790 Support for calling the Cyrus &'pwcheck'& and &'saslauthd'& daemons is provided
791 by code taken from the Cyrus-SASL library and adapted by Alexander S.
792 Sabourenkov. The permission notice appears below, in accordance with the
793 conditions expressed therein.
794
795 .blockquote
796 Copyright &copy; 2001 Carnegie Mellon University.  All rights reserved.
797
798 Redistribution and use in source and binary forms, with or without
799 modification, are permitted provided that the following conditions
800 are met:
801
802 .olist
803 Redistributions of source code must retain the above copyright
804 notice, this list of conditions and the following disclaimer.
805 .next
806 Redistributions in binary form must reproduce the above copyright
807 notice, this list of conditions and the following disclaimer in
808 the documentation and/or other materials provided with the
809 distribution.
810 .next
811 The name &"Carnegie Mellon University"& must not be used to
812 endorse or promote products derived from this software without
813 prior written permission. For permission or any other legal
814 details, please contact
815 .display
816               Office of Technology Transfer
817               Carnegie Mellon University
818               5000 Forbes Avenue
819               Pittsburgh, PA  15213-3890
820               (412) 268-4387, fax: (412) 268-7395
821               tech-transfer@andrew.cmu.edu
822 .endd
823 .next
824 Redistributions of any form whatsoever must retain the following
825 acknowledgment:
826
827 &"This product includes software developed by Computing Services
828 at Carnegie Mellon University (&url(https://www.cmu.edu/computing/)."&
829
830 CARNEGIE MELLON UNIVERSITY DISCLAIMS ALL WARRANTIES WITH REGARD TO
831 THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
832 AND FITNESS, IN NO EVENT SHALL CARNEGIE MELLON UNIVERSITY BE LIABLE
833 FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
834 WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
835 AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
836 OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
837 .endlist
838 .endblockquote
839
840 .next
841 .cindex "Exim monitor" "acknowledgment"
842 .cindex "X-windows"
843 .cindex "Athena"
844 The Exim Monitor program, which is an X-Window application, includes
845 modified versions of the Athena StripChart and TextPop widgets.
846 This code is copyright by DEC and MIT, and their permission notice appears
847 below, in accordance with the conditions expressed therein.
848
849 .blockquote
850 Copyright 1987, 1988 by Digital Equipment Corporation, Maynard, Massachusetts,
851 and the Massachusetts Institute of Technology, Cambridge, Massachusetts.
852
853 All Rights Reserved
854
855 Permission to use, copy, modify, and distribute this software and its
856 documentation for any purpose and without fee is hereby granted,
857 provided that the above copyright notice appear in all copies and that
858 both that copyright notice and this permission notice appear in
859 supporting documentation, and that the names of Digital or MIT not be
860 used in advertising or publicity pertaining to distribution of the
861 software without specific, written prior permission.
862
863 DIGITAL DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING
864 ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL
865 DIGITAL BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR
866 ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
867 WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
868 ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
869 SOFTWARE.
870 .endblockquote
871
872 .next
873 .cindex "opendmarc" "acknowledgment"
874 The DMARC implementation uses the OpenDMARC library which is Copyrighted by
875 The Trusted Domain Project. Portions of Exim source which use OpenDMARC
876 derived code are indicated in the respective source files. The full OpenDMARC
877 license is provided in the LICENSE.opendmarc file contained in the distributed
878 source code.
879
880 .next
881 Many people have contributed code fragments, some large, some small, that were
882 not covered by any specific license requirements. It is assumed that the
883 contributors are happy to see their code incorporated into Exim under the GPL.
884 .endlist
885
886
887
888
889
890 . ////////////////////////////////////////////////////////////////////////////
891 . ////////////////////////////////////////////////////////////////////////////
892
893 .chapter "How Exim receives and delivers mail" "CHID11" &&&
894          "Receiving and delivering mail"
895
896
897 .section "Overall philosophy" "SECID10"
898 .cindex "design philosophy"
899 Exim is designed to work efficiently on systems that are permanently connected
900 to the Internet and are handling a general mix of mail. In such circumstances,
901 most messages can be delivered immediately. Consequently, Exim does not
902 maintain independent queues of messages for specific domains or hosts, though
903 it does try to send several messages in a single SMTP connection after a host
904 has been down, and it also maintains per-host retry information.
905
906
907 .section "Policy control" "SECID11"
908 .cindex "policy control" "overview"
909 Policy controls are now an important feature of MTAs that are connected to the
910 Internet. Perhaps their most important job is to stop MTAs from being abused as
911 &"open relays"& by misguided individuals who send out vast amounts of
912 unsolicited junk and want to disguise its source. Exim provides flexible
913 facilities for specifying policy controls on incoming mail:
914
915 .ilist
916 .cindex "&ACL;" "introduction"
917 Exim 4 (unlike previous versions of Exim) implements policy controls on
918 incoming mail by means of &'Access Control Lists'& (ACLs). Each list is a
919 series of statements that may either grant or deny access. ACLs can be used at
920 several places in the SMTP dialogue while receiving a message from a remote
921 host. However, the most common places are after each RCPT command, and at the
922 very end of the message. The sysadmin can specify conditions for accepting or
923 rejecting individual recipients or the entire message, respectively, at these
924 two points (see chapter &<<CHAPACL>>&). Denial of access results in an SMTP
925 error code.
926 .next
927 An ACL is also available for locally generated, non-SMTP messages. In this
928 case, the only available actions are to accept or deny the entire message.
929 .next
930 When Exim is compiled with the content-scanning extension, facilities are
931 provided in the ACL mechanism for passing the message to external virus and/or
932 spam scanning software. The result of such a scan is passed back to the ACL,
933 which can then use it to decide what to do with the message.
934 .next
935 When a message has been received, either from a remote host or from the local
936 host, but before the final acknowledgment has been sent, a locally supplied C
937 function called &[local_scan()]& can be run to inspect the message and decide
938 whether to accept it or not (see chapter &<<CHAPlocalscan>>&). If the message
939 is accepted, the list of recipients can be modified by the function.
940 .next
941 Using the &[local_scan()]& mechanism is another way of calling external scanner
942 software. The &%SA-Exim%& add-on package works this way. It does not require
943 Exim to be compiled with the content-scanning extension.
944 .next
945 After a message has been accepted, a further checking mechanism is available in
946 the form of the &'system filter'& (see chapter &<<CHAPsystemfilter>>&). This
947 runs at the start of every delivery process.
948 .endlist
949
950
951
952 .section "User filters" "SECID12"
953 .cindex "filter" "introduction"
954 .cindex "Sieve filter"
955 In a conventional Exim configuration, users are able to run private filters by
956 setting up appropriate &_.forward_& files in their home directories. See
957 chapter &<<CHAPredirect>>& (about the &(redirect)& router) for the
958 configuration needed to support this, and the separate document entitled
959 &'Exim's interfaces to mail filtering'& for user details. Two different kinds
960 of filtering are available:
961
962 .ilist
963 Sieve filters are written in the standard filtering language that is defined
964 by RFC 3028.
965 .next
966 Exim filters are written in a syntax that is unique to Exim, but which is more
967 powerful than Sieve, which it pre-dates.
968 .endlist
969
970 User filters are run as part of the routing process, described below.
971
972
973
974 .section "Message identification" "SECTmessiden"
975 .cindex "message ids" "details of format"
976 .cindex "format" "of message id"
977 .cindex "id of message"
978 .cindex "base62"
979 .cindex "base36"
980 .cindex "Darwin"
981 .cindex "Cygwin"
982 Every message handled by Exim is given a &'message id'& which is sixteen
983 characters long. It is divided into three parts, separated by hyphens, for
984 example &`16VDhn-0001bo-D3`&. Each part is a sequence of letters and digits,
985 normally encoding numbers in base 62. However, in the Darwin operating
986 system (Mac OS X) and when Exim is compiled to run under Cygwin, base 36
987 (avoiding the use of lower case letters) is used instead, because the message
988 id is used to construct filenames, and the names of files in those systems are
989 not always case-sensitive.
990
991 .cindex "pid (process id)" "re-use of"
992 The detail of the contents of the message id have changed as Exim has evolved.
993 Earlier versions relied on the operating system not re-using a process id (pid)
994 within one second. On modern operating systems, this assumption can no longer
995 be made, so the algorithm had to be changed. To retain backward compatibility,
996 the format of the message id was retained, which is why the following rules are
997 somewhat eccentric:
998
999 .ilist
1000 The first six characters of the message id are the time at which the message
1001 started to be received, to a granularity of one second. That is, this field
1002 contains the number of seconds since the start of the epoch (the normal Unix
1003 way of representing the date and time of day).
1004 .next
1005 After the first hyphen, the next six characters are the id of the process that
1006 received the message.
1007 .next
1008 There are two different possibilities for the final two characters:
1009 .olist
1010 .oindex "&%localhost_number%&"
1011 If &%localhost_number%& is not set, this value is the fractional part of the
1012 time of reception, normally in units of 1/2000 of a second, but for systems
1013 that must use base 36 instead of base 62 (because of case-insensitive file
1014 systems), the units are 1/1000 of a second.
1015 .next
1016 If &%localhost_number%& is set, it is multiplied by 200 (100) and added to
1017 the fractional part of the time, which in this case is in units of 1/200
1018 (1/100) of a second.
1019 .endlist
1020 .endlist
1021
1022 After a message has been received, Exim waits for the clock to tick at the
1023 appropriate resolution before proceeding, so that if another message is
1024 received by the same process, or by another process with the same (re-used)
1025 pid, it is guaranteed that the time will be different. In most cases, the clock
1026 will already have ticked while the message was being received.
1027
1028
1029 .section "Receiving mail" "SECID13"
1030 .cindex "receiving mail"
1031 .cindex "message" "reception"
1032 The only way Exim can receive mail from another host is using SMTP over
1033 TCP/IP, in which case the sender and recipient addresses are transferred using
1034 SMTP commands. However, from a locally running process (such as a user's MUA),
1035 there are several possibilities:
1036
1037 .ilist
1038 If the process runs Exim with the &%-bm%& option, the message is read
1039 non-interactively (usually via a pipe), with the recipients taken from the
1040 command line, or from the body of the message if &%-t%& is also used.
1041 .next
1042 If the process runs Exim with the &%-bS%& option, the message is also read
1043 non-interactively, but in this case the recipients are listed at the start of
1044 the message in a series of SMTP RCPT commands, terminated by a DATA
1045 command. This is called &"batch SMTP"& format,
1046 but it isn't really SMTP. The SMTP commands are just another way of passing
1047 envelope addresses in a non-interactive submission.
1048 .next
1049 If the process runs Exim with the &%-bs%& option, the message is read
1050 interactively, using the SMTP protocol. A two-way pipe is normally used for
1051 passing data between the local process and the Exim process.
1052 This is &"real"& SMTP and is handled in the same way as SMTP over TCP/IP. For
1053 example, the ACLs for SMTP commands are used for this form of submission.
1054 .next
1055 A local process may also make a TCP/IP call to the host's loopback address
1056 (127.0.0.1) or any other of its IP addresses. When receiving messages, Exim
1057 does not treat the loopback address specially. It treats all such connections
1058 in the same way as connections from other hosts.
1059 .endlist
1060
1061
1062 .cindex "message sender, constructed by Exim"
1063 .cindex "sender" "constructed by Exim"
1064 In the three cases that do not involve TCP/IP, the sender address is
1065 constructed from the login name of the user that called Exim and a default
1066 qualification domain (which can be set by the &%qualify_domain%& configuration
1067 option). For local or batch SMTP, a sender address that is passed using the
1068 SMTP MAIL command is ignored. However, the system administrator may allow
1069 certain users (&"trusted users"&) to specify a different sender addresses
1070 unconditionally, or all users to specify certain forms of different sender
1071 address. The &%-f%& option or the SMTP MAIL command is used to specify these
1072 different addresses. See section &<<SECTtrustedadmin>>& for details of trusted
1073 users, and the &%untrusted_set_sender%& option for a way of allowing untrusted
1074 users to change sender addresses.
1075
1076 Messages received by either of the non-interactive mechanisms are subject to
1077 checking by the non-SMTP ACL if one is defined. Messages received using SMTP
1078 (either over TCP/IP or interacting with a local process) can be checked by a
1079 number of ACLs that operate at different times during the SMTP session. Either
1080 individual recipients or the entire message can be rejected if local policy
1081 requirements are not met. The &[local_scan()]& function (see chapter
1082 &<<CHAPlocalscan>>&) is run for all incoming messages.
1083
1084 Exim can be configured not to start a delivery process when a message is
1085 received; this can be unconditional, or depend on the number of incoming SMTP
1086 connections or the system load. In these situations, new messages wait on the
1087 queue until a queue runner process picks them up. However, in standard
1088 configurations under normal conditions, delivery is started as soon as a
1089 message is received.
1090
1091
1092
1093
1094
1095 .section "Handling an incoming message" "SECID14"
1096 .cindex "spool directory" "files that hold a message"
1097 .cindex "file" "how a message is held"
1098 When Exim accepts a message, it writes two files in its spool directory. The
1099 first contains the envelope information, the current status of the message, and
1100 the header lines, and the second contains the body of the message. The names of
1101 the two spool files consist of the message id, followed by &`-H`& for the
1102 file containing the envelope and header, and &`-D`& for the data file.
1103
1104 .cindex "spool directory" "&_input_& sub-directory"
1105 By default, all these message files are held in a single directory called
1106 &_input_& inside the general Exim spool directory. Some operating systems do
1107 not perform very well if the number of files in a directory gets large; to
1108 improve performance in such cases, the &%split_spool_directory%& option can be
1109 used. This causes Exim to split up the input files into 62 sub-directories
1110 whose names are single letters or digits. When this is done, the queue is
1111 processed one sub-directory at a time instead of all at once, which can improve
1112 overall performance even when there are not enough files in each directory to
1113 affect file system performance.
1114
1115 The envelope information consists of the address of the message's sender and
1116 the addresses of the recipients. This information is entirely separate from
1117 any addresses contained in the header lines. The status of the message includes
1118 a list of recipients who have already received the message. The format of the
1119 first spool file is described in chapter &<<CHAPspool>>&.
1120
1121 .cindex "rewriting" "addresses"
1122 Address rewriting that is specified in the rewrite section of the configuration
1123 (see chapter &<<CHAPrewrite>>&) is done once and for all on incoming addresses,
1124 both in the header lines and the envelope, at the time the message is accepted.
1125 If during the course of delivery additional addresses are generated (for
1126 example, via aliasing), these new addresses are rewritten as soon as they are
1127 generated. At the time a message is actually delivered (transported) further
1128 rewriting can take place; because this is a transport option, it can be
1129 different for different forms of delivery. It is also possible to specify the
1130 addition or removal of certain header lines at the time the message is
1131 delivered (see chapters &<<CHAProutergeneric>>& and
1132 &<<CHAPtransportgeneric>>&).
1133
1134
1135
1136 .section "Life of a message" "SECID15"
1137 .cindex "message" "life of"
1138 .cindex "message" "frozen"
1139 A message remains in the spool directory until it is completely delivered to
1140 its recipients or to an error address, or until it is deleted by an
1141 administrator or by the user who originally created it. In cases when delivery
1142 cannot proceed &-- for example when a message can neither be delivered to its
1143 recipients nor returned to its sender, the message is marked &"frozen"& on the
1144 spool, and no more deliveries are attempted.
1145
1146 .cindex "frozen messages" "thawing"
1147 .cindex "message" "thawing frozen"
1148 An administrator can &"thaw"& such messages when the problem has been
1149 corrected, and can also freeze individual messages by hand if necessary. In
1150 addition, an administrator can force a delivery error, causing a bounce message
1151 to be sent.
1152
1153 .oindex "&%timeout_frozen_after%&"
1154 .oindex "&%ignore_bounce_errors_after%&"
1155 There are options called &%ignore_bounce_errors_after%& and
1156 &%timeout_frozen_after%&, which discard frozen messages after a certain time.
1157 The first applies only to frozen bounces, the second to all frozen messages.
1158
1159 .cindex "message" "log file for"
1160 .cindex "log" "file for each message"
1161 While Exim is working on a message, it writes information about each delivery
1162 attempt to its main log file. This includes successful, unsuccessful, and
1163 delayed deliveries for each recipient (see chapter &<<CHAPlog>>&). The log
1164 lines are also written to a separate &'message log'& file for each message.
1165 These logs are solely for the benefit of the administrator and are normally
1166 deleted along with the spool files when processing of a message is complete.
1167 The use of individual message logs can be disabled by setting
1168 &%no_message_logs%&; this might give an improvement in performance on very busy
1169 systems.
1170
1171 .cindex "journal file"
1172 .cindex "file" "journal"
1173 All the information Exim itself needs to set up a delivery is kept in the first
1174 spool file, along with the header lines. When a successful delivery occurs, the
1175 address is immediately written at the end of a journal file, whose name is the
1176 message id followed by &`-J`&. At the end of a delivery run, if there are some
1177 addresses left to be tried again later, the first spool file (the &`-H`& file)
1178 is updated to indicate which these are, and the journal file is then deleted.
1179 Updating the spool file is done by writing a new file and renaming it, to
1180 minimize the possibility of data loss.
1181
1182 Should the system or Exim crash after a successful delivery but before
1183 the spool file has been updated, the journal is left lying around. The next
1184 time Exim attempts to deliver the message, it reads the journal file and
1185 updates the spool file before proceeding. This minimizes the chances of double
1186 deliveries caused by crashes.
1187
1188
1189
1190 .section "Processing an address for delivery" "SECTprocaddress"
1191 .cindex "drivers" "definition of"
1192 .cindex "router" "definition of"
1193 .cindex "transport" "definition of"
1194 The main delivery processing elements of Exim are called &'routers'& and
1195 &'transports'&, and collectively these are known as &'drivers'&. Code for a
1196 number of them is provided in the source distribution, and compile-time options
1197 specify which ones are included in the binary. Runtime options specify which
1198 ones are actually used for delivering messages.
1199
1200 .cindex "drivers" "instance definition"
1201 Each driver that is specified in the runtime configuration is an &'instance'&
1202 of that particular driver type. Multiple instances are allowed; for example,
1203 you can set up several different &(smtp)& transports, each with different
1204 option values that might specify different ports or different timeouts. Each
1205 instance has its own identifying name. In what follows we will normally use the
1206 instance name when discussing one particular instance (that is, one specific
1207 configuration of the driver), and the generic driver name when discussing
1208 the driver's features in general.
1209
1210 A &'router'& is a driver that operates on an address, either determining how
1211 its delivery should happen, by assigning it to a specific transport, or
1212 converting the address into one or more new addresses (for example, via an
1213 alias file). A router may also explicitly choose to fail an address, causing it
1214 to be bounced.
1215
1216 A &'transport'& is a driver that transmits a copy of the message from Exim's
1217 spool to some destination. There are two kinds of transport: for a &'local'&
1218 transport, the destination is a file or a pipe on the local host, whereas for a
1219 &'remote'& transport the destination is some other host. A message is passed
1220 to a specific transport as a result of successful routing. If a message has
1221 several recipients, it may be passed to a number of different transports.
1222
1223 .cindex "preconditions" "definition of"
1224 An address is processed by passing it to each configured router instance in
1225 turn, subject to certain preconditions, until a router accepts the address or
1226 specifies that it should be bounced. We will describe this process in more
1227 detail shortly. First, as a simple example, we consider how each recipient
1228 address in a message is processed in a small configuration of three routers.
1229
1230 To make this a more concrete example, it is described in terms of some actual
1231 routers, but remember, this is only an example. You can configure Exim's
1232 routers in many different ways, and there may be any number of routers in a
1233 configuration.
1234
1235 The first router that is specified in a configuration is often one that handles
1236 addresses in domains that are not recognized specifically by the local host.
1237 Typically these are addresses for arbitrary domains on the Internet. A precondition
1238 is set up which looks for the special domains known to the host (for example,
1239 its own domain name), and the router is run for addresses that do &'not'&
1240 match. Typically, this is a router that looks up domains in the DNS in order to
1241 find the hosts to which this address routes. If it succeeds, the address is
1242 assigned to a suitable SMTP transport; if it does not succeed, the router is
1243 configured to fail the address.
1244
1245 The second router is reached only when the domain is recognized as one that
1246 &"belongs"& to the local host. This router does redirection &-- also known as
1247 aliasing and forwarding. When it generates one or more new addresses from the
1248 original, each of them is routed independently from the start. Otherwise, the
1249 router may cause an address to fail, or it may simply decline to handle the
1250 address, in which case the address is passed to the next router.
1251
1252 The final router in many configurations is one that checks to see if the
1253 address belongs to a local mailbox. The precondition may involve a check to
1254 see if the local part is the name of a login account, or it may look up the
1255 local part in a file or a database. If its preconditions are not met, or if
1256 the router declines, we have reached the end of the routers. When this happens,
1257 the address is bounced.
1258
1259
1260
1261 .section "Processing an address for verification" "SECID16"
1262 .cindex "router" "for verification"
1263 .cindex "verifying address" "overview"
1264 As well as being used to decide how to deliver to an address, Exim's routers
1265 are also used for &'address verification'&. Verification can be requested as
1266 one of the checks to be performed in an ACL for incoming messages, on both
1267 sender and recipient addresses, and it can be tested using the &%-bv%& and
1268 &%-bvs%& command line options.
1269
1270 When an address is being verified, the routers are run in &"verify mode"&. This
1271 does not affect the way the routers work, but it is a state that can be
1272 detected. By this means, a router can be skipped or made to behave differently
1273 when verifying. A common example is a configuration in which the first router
1274 sends all messages to a message-scanning program unless they have been
1275 previously scanned. Thus, the first router accepts all addresses without any
1276 checking, making it useless for verifying. Normally, the &%no_verify%& option
1277 would be set for such a router, causing it to be skipped in verify mode.
1278
1279
1280
1281
1282 .section "Running an individual router" "SECTrunindrou"
1283 .cindex "router" "running details"
1284 .cindex "preconditions" "checking"
1285 .cindex "router" "result of running"
1286 As explained in the example above, a number of preconditions are checked before
1287 running a router. If any are not met, the router is skipped, and the address is
1288 passed to the next router. When all the preconditions on a router &'are'& met,
1289 the router is run. What happens next depends on the outcome, which is one of
1290 the following:
1291
1292 .ilist
1293 &'accept'&: The router accepts the address, and either assigns it to a
1294 transport or generates one or more &"child"& addresses. Processing the
1295 original address ceases
1296 .oindex "&%unseen%&"
1297 unless the &%unseen%& option is set on the router. This option
1298 can be used to set up multiple deliveries with different routing (for example,
1299 for keeping archive copies of messages). When &%unseen%& is set, the address is
1300 passed to the next router. Normally, however, an &'accept'& return marks the
1301 end of routing.
1302
1303 Any child addresses generated by the router are processed independently,
1304 starting with the first router by default. It is possible to change this by
1305 setting the &%redirect_router%& option to specify which router to start at for
1306 child addresses. Unlike &%pass_router%& (see below) the router specified by
1307 &%redirect_router%& may be anywhere in the router configuration.
1308 .next
1309 &'pass'&: The router recognizes the address, but cannot handle it itself. It
1310 requests that the address be passed to another router. By default, the address
1311 is passed to the next router, but this can be changed by setting the
1312 &%pass_router%& option. However, (unlike &%redirect_router%&) the named router
1313 must be below the current router (to avoid loops).
1314 .next
1315 &'decline'&: The router declines to accept the address because it does not
1316 recognize it at all. By default, the address is passed to the next router, but
1317 this can be prevented by setting the &%no_more%& option. When &%no_more%& is
1318 set, all the remaining routers are skipped. In effect, &%no_more%& converts
1319 &'decline'& into &'fail'&.
1320 .next
1321 &'fail'&: The router determines that the address should fail, and queues it for
1322 the generation of a bounce message. There is no further processing of the
1323 original address unless &%unseen%& is set on the router.
1324 .next
1325 &'defer'&: The router cannot handle the address at the present time. (A
1326 database may be offline, or a DNS lookup may have timed out.) No further
1327 processing of the address happens in this delivery attempt. It is tried again
1328 next time the message is considered for delivery.
1329 .next
1330 &'error'&: There is some error in the router (for example, a syntax error in
1331 its configuration). The action is as for defer.
1332 .endlist
1333
1334 If an address reaches the end of the routers without having been accepted by
1335 any of them, it is bounced as unrouteable. The default error message in this
1336 situation is &"unrouteable address"&, but you can set your own message by
1337 making use of the &%cannot_route_message%& option. This can be set for any
1338 router; the value from the last router that &"saw"& the address is used.
1339
1340 Sometimes while routing you want to fail a delivery when some conditions are
1341 met but others are not, instead of passing the address on for further routing.
1342 You can do this by having a second router that explicitly fails the delivery
1343 when the relevant conditions are met. The &(redirect)& router has a &"fail"&
1344 facility for this purpose.
1345
1346
1347 .section "Duplicate addresses" "SECID17"
1348 .cindex "case of local parts"
1349 .cindex "address duplicate, discarding"
1350 .cindex "duplicate addresses"
1351 Once routing is complete, Exim scans the addresses that are assigned to local
1352 and remote transports and discards any duplicates that it finds. During this
1353 check, local parts are treated case-sensitively. This happens only when
1354 actually delivering a message; when testing routers with &%-bt%&, all the
1355 routed addresses are shown.
1356
1357
1358
1359 .section "Router preconditions" "SECTrouprecon"
1360 .cindex "router" "preconditions, order of processing"
1361 .cindex "preconditions" "order of processing"
1362 The preconditions that are tested for each router are listed below, in the
1363 order in which they are tested. The individual configuration options are
1364 described in more detail in chapter &<<CHAProutergeneric>>&.
1365
1366 .ilist
1367 .cindex affix "router precondition"
1368 The &%local_part_prefix%& and &%local_part_suffix%& options can specify that
1369 the local parts handled by the router may or must have certain prefixes and/or
1370 suffixes. If a mandatory affix (prefix or suffix) is not present, the router is
1371 skipped. These conditions are tested first. When an affix is present, it is
1372 removed from the local part before further processing, including the evaluation
1373 of any other conditions.
1374 .next
1375 Routers can be designated for use only when not verifying an address, that is,
1376 only when routing it for delivery (or testing its delivery routing). If the
1377 &%verify%& option is set false, the router is skipped when Exim is verifying an
1378 address.
1379 Setting the &%verify%& option actually sets two options, &%verify_sender%& and
1380 &%verify_recipient%&, which independently control the use of the router for
1381 sender and recipient verification. You can set these options directly if
1382 you want a router to be used for only one type of verification.
1383 Note that cutthrough delivery is classed as a recipient verification for this purpose.
1384 .next
1385 If the &%address_test%& option is set false, the router is skipped when Exim is
1386 run with the &%-bt%& option to test an address routing. This can be helpful
1387 when the first router sends all new messages to a scanner of some sort; it
1388 makes it possible to use &%-bt%& to test subsequent delivery routing without
1389 having to simulate the effect of the scanner.
1390 .next
1391 Routers can be designated for use only when verifying an address, as
1392 opposed to routing it for delivery. The &%verify_only%& option controls this.
1393 Again, cutthrough delivery counts as a verification.
1394 .next
1395 Individual routers can be explicitly skipped when running the routers to
1396 check an address given in the SMTP EXPN command (see the &%expn%& option).
1397 .next
1398 If the &%domains%& option is set, the domain of the address must be in the set
1399 of domains that it defines.
1400 .next
1401 .vindex "&$local_part_prefix$&"
1402 .vindex "&$local_part_prefix_v$&"
1403 .vindex "&$local_part$&"
1404 .vindex "&$local_part_suffix$&"
1405 .vindex "&$local_part_suffix_v$&"
1406 .cindex affix "router precondition"
1407 If the &%local_parts%& option is set, the local part of the address must be in
1408 the set of local parts that it defines. If &%local_part_prefix%& or
1409 &%local_part_suffix%& is in use, the prefix or suffix is removed from the local
1410 part before this check. If you want to do precondition tests on local parts
1411 that include affixes, you can do so by using a &%condition%& option (see below)
1412 that uses the variables &$local_part$&, &$local_part_prefix$&,
1413 &$local_part_prefix_v$&, &$local_part_suffix$&
1414 and &$local_part_suffix_v$& as necessary.
1415 .next
1416 .vindex "&$local_user_uid$&"
1417 .vindex "&$local_user_gid$&"
1418 .vindex "&$home$&"
1419 If the &%check_local_user%& option is set, the local part must be the name of
1420 an account on the local host. If this check succeeds, the uid and gid of the
1421 local user are placed in &$local_user_uid$& and &$local_user_gid$& and the
1422 user's home directory is placed in &$home$&; these values can be used in the
1423 remaining preconditions.
1424 .next
1425 If the &%router_home_directory%& option is set, it is expanded at this point,
1426 because it overrides the value of &$home$&. If this expansion were left till
1427 later, the value of &$home$& as set by &%check_local_user%& would be used in
1428 subsequent tests. Having two different values of &$home$& in the same router
1429 could lead to confusion.
1430 .next
1431 If the &%senders%& option is set, the envelope sender address must be in the
1432 set of addresses that it defines.
1433 .next
1434 If the &%require_files%& option is set, the existence or non-existence of
1435 specified files is tested.
1436 .next
1437 .cindex "customizing" "precondition"
1438 If the &%condition%& option is set, it is evaluated and tested. This option
1439 uses an expanded string to allow you to set up your own custom preconditions.
1440 Expanded strings are described in chapter &<<CHAPexpand>>&.
1441 .endlist
1442
1443
1444 Note that &%require_files%& comes near the end of the list, so you cannot use
1445 it to check for the existence of a file in which to lookup up a domain, local
1446 part, or sender. However, as these options are all expanded, you can use the
1447 &%exists%& expansion condition to make such tests within each condition. The
1448 &%require_files%& option is intended for checking files that the router may be
1449 going to use internally, or which are needed by a specific transport (for
1450 example, &_.procmailrc_&).
1451
1452
1453
1454 .section "Delivery in detail" "SECID18"
1455 .cindex "delivery" "in detail"
1456 When a message is to be delivered, the sequence of events is as follows:
1457
1458 .ilist
1459 If a system-wide filter file is specified, the message is passed to it. The
1460 filter may add recipients to the message, replace the recipients, discard the
1461 message, cause a new message to be generated, or cause the message delivery to
1462 fail. The format of the system filter file is the same as for Exim user filter
1463 files, described in the separate document entitled &'Exim's interfaces to mail
1464 filtering'&.
1465 .cindex "Sieve filter" "not available for system filter"
1466 (&*Note*&: Sieve cannot be used for system filter files.)
1467
1468 Some additional features are available in system filters &-- see chapter
1469 &<<CHAPsystemfilter>>& for details. Note that a message is passed to the system
1470 filter only once per delivery attempt, however many recipients it has. However,
1471 if there are several delivery attempts because one or more addresses could not
1472 be immediately delivered, the system filter is run each time. The filter
1473 condition &%first_delivery%& can be used to detect the first run of the system
1474 filter.
1475 .next
1476 Each recipient address is offered to each configured router, in turn, subject to
1477 its preconditions, until one is able to handle it. If no router can handle the
1478 address, that is, if they all decline, the address is failed. Because routers
1479 can be targeted at particular domains, several locally handled domains can be
1480 processed entirely independently of each other.
1481 .next
1482 .cindex "routing" "loops in"
1483 .cindex "loop" "while routing"
1484 A router that accepts an address may assign it to a local or a remote
1485 transport. However, the transport is not run at this time. Instead, the address
1486 is placed on a list for the particular transport, which will be run later.
1487 Alternatively, the router may generate one or more new addresses (typically
1488 from alias, forward, or filter files). New addresses are fed back into this
1489 process from the top, but in order to avoid loops, a router ignores any address
1490 which has an identically-named ancestor that was processed by itself.
1491 .next
1492 When all the routing has been done, addresses that have been successfully
1493 handled are passed to their assigned transports. When local transports are
1494 doing real local deliveries, they handle only one address at a time, but if a
1495 local transport is being used as a pseudo-remote transport (for example, to
1496 collect batched SMTP messages for transmission by some other means) multiple
1497 addresses can be handled. Remote transports can always handle more than one
1498 address at a time, but can be configured not to do so, or to restrict multiple
1499 addresses to the same domain.
1500 .next
1501 Each local delivery to a file or a pipe runs in a separate process under a
1502 non-privileged uid, and these deliveries are run one at a time. Remote
1503 deliveries also run in separate processes, normally under a uid that is private
1504 to Exim (&"the Exim user"&), but in this case, several remote deliveries can be
1505 run in parallel. The maximum number of simultaneous remote deliveries for any
1506 one message is set by the &%remote_max_parallel%& option.
1507 The order in which deliveries are done is not defined, except that all local
1508 deliveries happen before any remote deliveries.
1509 .next
1510 .cindex "queue runner"
1511 When it encounters a local delivery during a queue run, Exim checks its retry
1512 database to see if there has been a previous temporary delivery failure for the
1513 address before running the local transport. If there was a previous failure,
1514 Exim does not attempt a new delivery until the retry time for the address is
1515 reached. However, this happens only for delivery attempts that are part of a
1516 queue run. Local deliveries are always attempted when delivery immediately
1517 follows message reception, even if retry times are set for them. This makes for
1518 better behaviour if one particular message is causing problems (for example,
1519 causing quota overflow, or provoking an error in a filter file).
1520 .next
1521 .cindex "delivery" "retry in remote transports"
1522 Remote transports do their own retry handling, since an address may be
1523 deliverable to one of a number of hosts, each of which may have a different
1524 retry time. If there have been previous temporary failures and no host has
1525 reached its retry time, no delivery is attempted, whether in a queue run or
1526 not. See chapter &<<CHAPretry>>& for details of retry strategies.
1527 .next
1528 If there were any permanent errors, a bounce message is returned to an
1529 appropriate address (the sender in the common case), with details of the error
1530 for each failing address. Exim can be configured to send copies of bounce
1531 messages to other addresses.
1532 .next
1533 .cindex "delivery" "deferral"
1534 If one or more addresses suffered a temporary failure, the message is left on
1535 the queue, to be tried again later. Delivery of these addresses is said to be
1536 &'deferred'&.
1537 .next
1538 When all the recipient addresses have either been delivered or bounced,
1539 handling of the message is complete. The spool files and message log are
1540 deleted, though the message log can optionally be preserved if required.
1541 .endlist
1542
1543
1544
1545
1546 .section "Retry mechanism" "SECID19"
1547 .cindex "delivery" "retry mechanism"
1548 .cindex "retry" "description of mechanism"
1549 .cindex "queue runner"
1550 Exim's mechanism for retrying messages that fail to get delivered at the first
1551 attempt is the queue runner process. You must either run an Exim daemon that
1552 uses the &%-q%& option with a time interval to start queue runners at regular
1553 intervals or use some other means (such as &'cron'&) to start them. If you do
1554 not arrange for queue runners to be run, messages that fail temporarily at the
1555 first attempt will remain in your queue forever. A queue runner process works
1556 its way through the queue, one message at a time, trying each delivery that has
1557 passed its retry time.
1558 You can run several queue runners at once.
1559
1560 Exim uses a set of configured rules to determine when next to retry the failing
1561 address (see chapter &<<CHAPretry>>&). These rules also specify when Exim
1562 should give up trying to deliver to the address, at which point it generates a
1563 bounce message. If no retry rules are set for a particular host, address, and
1564 error combination, no retries are attempted, and temporary errors are treated
1565 as permanent.
1566
1567
1568
1569 .section "Temporary delivery failure" "SECID20"
1570 .cindex "delivery" "temporary failure"
1571 There are many reasons why a message may not be immediately deliverable to a
1572 particular address. Failure to connect to a remote machine (because it, or the
1573 connection to it, is down) is one of the most common. Temporary failures may be
1574 detected during routing as well as during the transport stage of delivery.
1575 Local deliveries may be delayed if NFS files are unavailable, or if a mailbox
1576 is on a file system where the user is over quota. Exim can be configured to
1577 impose its own quotas on local mailboxes; where system quotas are set they will
1578 also apply.
1579
1580 If a host is unreachable for a period of time, a number of messages may be
1581 waiting for it by the time it recovers, and sending them in a single SMTP
1582 connection is clearly beneficial. Whenever a delivery to a remote host is
1583 deferred,
1584 .cindex "hints database" "deferred deliveries"
1585 Exim makes a note in its hints database, and whenever a successful
1586 SMTP delivery has happened, it looks to see if any other messages are waiting
1587 for the same host. If any are found, they are sent over the same SMTP
1588 connection, subject to a configuration limit as to the maximum number in any
1589 one connection.
1590
1591
1592
1593 .section "Permanent delivery failure" "SECID21"
1594 .cindex "delivery" "permanent failure"
1595 .cindex "bounce message" "when generated"
1596 When a message cannot be delivered to some or all of its intended recipients, a
1597 bounce message is generated. Temporary delivery failures turn into permanent
1598 errors when their timeout expires. All the addresses that fail in a given
1599 delivery attempt are listed in a single message. If the original message has
1600 many recipients, it is possible for some addresses to fail in one delivery
1601 attempt and others to fail subsequently, giving rise to more than one bounce
1602 message. The wording of bounce messages can be customized by the administrator.
1603 See chapter &<<CHAPemsgcust>>& for details.
1604
1605 .cindex "&'X-Failed-Recipients:'& header line"
1606 Bounce messages contain an &'X-Failed-Recipients:'& header line that lists the
1607 failed addresses, for the benefit of programs that try to analyse such messages
1608 automatically.
1609
1610 .cindex "bounce message" "recipient of"
1611 A bounce message is normally sent to the sender of the original message, as
1612 obtained from the message's envelope. For incoming SMTP messages, this is the
1613 address given in the MAIL command. However, when an address is expanded via a
1614 forward or alias file, an alternative address can be specified for delivery
1615 failures of the generated addresses. For a mailing list expansion (see section
1616 &<<SECTmailinglists>>&) it is common to direct bounce messages to the manager
1617 of the list.
1618
1619
1620
1621 .section "Failures to deliver bounce messages" "SECID22"
1622 .cindex "bounce message" "failure to deliver"
1623 If a bounce message (either locally generated or received from a remote host)
1624 itself suffers a permanent delivery failure, the message is left in the queue,
1625 but it is frozen, awaiting the attention of an administrator. There are options
1626 that can be used to make Exim discard such failed messages, or to keep them
1627 for only a short time (see &%timeout_frozen_after%& and
1628 &%ignore_bounce_errors_after%&).
1629
1630
1631
1632
1633
1634 . ////////////////////////////////////////////////////////////////////////////
1635 . ////////////////////////////////////////////////////////////////////////////
1636
1637 .chapter "Building and installing Exim" "CHID3"
1638 .scindex IIDbuex "building Exim"
1639
1640 .section "Unpacking" "SECID23"
1641 Exim is distributed as a gzipped or bzipped tar file which, when unpacked,
1642 creates a directory with the name of the current release (for example,
1643 &_exim-&version()_&) into which the following files are placed:
1644
1645 .table2 140pt
1646 .irow &_ACKNOWLEDGMENTS_& "contains some acknowledgments"
1647 .irow &_CHANGES_&         "contains a reference to where changes are &&&
1648   documented"
1649 .irow &_LICENCE_&         "the GNU General Public Licence"
1650 .irow &_Makefile_&        "top-level make file"
1651 .irow &_NOTICE_&          "conditions for the use of Exim"
1652 .irow &_README_&          "list of files, directories and simple build &&&
1653   instructions"
1654 .endtable
1655
1656 Other files whose names begin with &_README_& may also be present. The
1657 following subdirectories are created:
1658
1659 .table2 140pt
1660 .irow &_Local_&           "an empty directory for local configuration files"
1661 .irow &_OS_&              "OS-specific files"
1662 .irow &_doc_&             "documentation files"
1663 .irow &_exim_monitor_&    "source files for the Exim monitor"
1664 .irow &_scripts_&         "scripts used in the build process"
1665 .irow &_src_&             "remaining source files"
1666 .irow &_util_&            "independent utilities"
1667 .endtable
1668
1669 The main utility programs are contained in the &_src_& directory and are built
1670 with the Exim binary. The &_util_& directory contains a few optional scripts
1671 that may be useful to some sites.
1672
1673
1674 .section "Multiple machine architectures and operating systems" "SECID24"
1675 .cindex "building Exim" "multiple OS/architectures"
1676 The building process for Exim is arranged to make it easy to build binaries for
1677 a number of different architectures and operating systems from the same set of
1678 source files. Compilation does not take place in the &_src_& directory.
1679 Instead, a &'build directory'& is created for each architecture and operating
1680 system.
1681 .cindex "symbolic link" "to build directory"
1682 Symbolic links to the sources are installed in this directory, which is where
1683 the actual building takes place. In most cases, Exim can discover the machine
1684 architecture and operating system for itself, but the defaults can be
1685 overridden if necessary.
1686 .cindex compiler requirements
1687 .cindex compiler version
1688 A C99-capable compiler will be required for the build.
1689
1690
1691 .section "PCRE library" "SECTpcre"
1692 .cindex "PCRE library"
1693 Exim no longer has an embedded PCRE library as the vast majority of
1694 modern systems include PCRE as a system library, although you may need to
1695 install the PCRE package or the PCRE development package for your operating
1696 system. If your system has a normal PCRE installation the Exim build
1697 process will need no further configuration. If the library or the
1698 headers are in an unusual location you will need to either set the PCRE_LIBS
1699 and INCLUDE directives appropriately,
1700 or set PCRE_CONFIG=yes to use the installed &(pcre-config)& command.
1701 If your operating system has no
1702 PCRE support then you will need to obtain and build the current PCRE
1703 from &url(ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/).
1704 More information on PCRE is available at &url(https://www.pcre.org/).
1705
1706 .section "DBM libraries" "SECTdb"
1707 .cindex "DBM libraries" "discussion of"
1708 .cindex "hints database" "DBM files used for"
1709 Even if you do not use any DBM files in your configuration, Exim still needs a
1710 DBM library in order to operate, because it uses indexed files for its hints
1711 databases. Unfortunately, there are a number of DBM libraries in existence, and
1712 different operating systems often have different ones installed.
1713
1714 .cindex "Solaris" "DBM library for"
1715 .cindex "IRIX, DBM library for"
1716 .cindex "BSD, DBM library for"
1717 .cindex "Linux, DBM library for"
1718 If you are using Solaris, IRIX, one of the modern BSD systems, or a modern
1719 Linux distribution, the DBM configuration should happen automatically, and you
1720 may be able to ignore this section. Otherwise, you may have to learn more than
1721 you would like about DBM libraries from what follows.
1722
1723 .cindex "&'ndbm'& DBM library"
1724 Licensed versions of Unix normally contain a library of DBM functions operating
1725 via the &'ndbm'& interface, and this is what Exim expects by default. Free
1726 versions of Unix seem to vary in what they contain as standard. In particular,
1727 some early versions of Linux have no default DBM library, and different
1728 distributors have chosen to bundle different libraries with their packaged
1729 versions. However, the more recent releases seem to have standardized on the
1730 Berkeley DB library.
1731
1732 Different DBM libraries have different conventions for naming the files they
1733 use. When a program opens a file called &_dbmfile_&, there are several
1734 possibilities:
1735
1736 .olist
1737 A traditional &'ndbm'& implementation, such as that supplied as part of
1738 Solaris, operates on two files called &_dbmfile.dir_& and &_dbmfile.pag_&.
1739 .next
1740 .cindex "&'gdbm'& DBM library"
1741 The GNU library, &'gdbm'&, operates on a single file. If used via its &'ndbm'&
1742 compatibility interface it makes two different hard links to it with names
1743 &_dbmfile.dir_& and &_dbmfile.pag_&, but if used via its native interface, the
1744 filename is used unmodified.
1745 .next
1746 .cindex "Berkeley DB library"
1747 The Berkeley DB package, if called via its &'ndbm'& compatibility interface,
1748 operates on a single file called &_dbmfile.db_&, but otherwise looks to the
1749 programmer exactly the same as the traditional &'ndbm'& implementation.
1750 .next
1751 If the Berkeley package is used in its native mode, it operates on a single
1752 file called &_dbmfile_&; the programmer's interface is somewhat different to
1753 the traditional &'ndbm'& interface.
1754 .next
1755 To complicate things further, there are several very different versions of the
1756 Berkeley DB package. Version 1.85 was stable for a very long time, releases
1757 2.&'x'& and 3.&'x'& were current for a while, but the latest versions when Exim last revamped support were numbered 4.&'x'&.
1758 Maintenance of some of the earlier releases has ceased. All versions of
1759 Berkeley DB could be obtained from
1760 &url(http://www.sleepycat.com/), which is now a redirect to their new owner's
1761 page with far newer versions listed.
1762 It is probably wise to plan to move your storage configurations away from
1763 Berkeley DB format, as today there are smaller and simpler alternatives more
1764 suited to Exim's usage model.
1765 .next
1766 .cindex "&'tdb'& DBM library"
1767 Yet another DBM library, called &'tdb'&, is available from
1768 &url(https://sourceforge.net/projects/tdb/files/). It has its own interface, and also
1769 operates on a single file.
1770 .endlist
1771
1772 .cindex "USE_DB"
1773 .cindex "DBM libraries" "configuration for building"
1774 Exim and its utilities can be compiled to use any of these interfaces. In order
1775 to use any version of the Berkeley DB package in native mode, you must set
1776 USE_DB in an appropriate configuration file (typically
1777 &_Local/Makefile_&). For example:
1778 .code
1779 USE_DB=yes
1780 .endd
1781 Similarly, for gdbm you set USE_GDBM, and for tdb you set USE_TDB. An
1782 error is diagnosed if you set more than one of these.
1783
1784 At the lowest level, the build-time configuration sets none of these options,
1785 thereby assuming an interface of type (1). However, some operating system
1786 configuration files (for example, those for the BSD operating systems and
1787 Linux) assume type (4) by setting USE_DB as their default, and the
1788 configuration files for Cygwin set USE_GDBM. Anything you set in
1789 &_Local/Makefile_&, however, overrides these system defaults.
1790
1791 As well as setting USE_DB, USE_GDBM, or USE_TDB, it may also be
1792 necessary to set DBMLIB, to cause inclusion of the appropriate library, as
1793 in one of these lines:
1794 .code
1795 DBMLIB = -ldb
1796 DBMLIB = -ltdb
1797 .endd
1798 Settings like that will work if the DBM library is installed in the standard
1799 place. Sometimes it is not, and the library's header file may also not be in
1800 the default path. You may need to set INCLUDE to specify where the header
1801 file is, and to specify the path to the library more fully in DBMLIB, as in
1802 this example:
1803 .code
1804 INCLUDE=-I/usr/local/include/db-4.1
1805 DBMLIB=/usr/local/lib/db-4.1/libdb.a
1806 .endd
1807 There is further detailed discussion about the various DBM libraries in the
1808 file &_doc/dbm.discuss.txt_& in the Exim distribution.
1809
1810
1811
1812 .section "Pre-building configuration" "SECID25"
1813 .cindex "building Exim" "pre-building configuration"
1814 .cindex "configuration for building Exim"
1815 .cindex "&_Local/Makefile_&"
1816 .cindex "&_src/EDITME_&"
1817 Before building Exim, a local configuration file that specifies options
1818 independent of any operating system has to be created with the name
1819 &_Local/Makefile_&. A template for this file is supplied as the file
1820 &_src/EDITME_&, and it contains full descriptions of all the option settings
1821 therein. These descriptions are therefore not repeated here. If you are
1822 building Exim for the first time, the simplest thing to do is to copy
1823 &_src/EDITME_& to &_Local/Makefile_&, then read it and edit it appropriately.
1824
1825 There are three settings that you must supply, because Exim will not build
1826 without them. They are the location of the runtime configuration file
1827 (CONFIGURE_FILE), the directory in which Exim binaries will be installed
1828 (BIN_DIRECTORY), and the identity of the Exim user (EXIM_USER and
1829 maybe EXIM_GROUP as well). The value of CONFIGURE_FILE can in fact be
1830 a colon-separated list of filenames; Exim uses the first of them that exists.
1831
1832 There are a few other parameters that can be specified either at build time or
1833 at runtime, to enable the same binary to be used on a number of different
1834 machines. However, if the locations of Exim's spool directory and log file
1835 directory (if not within the spool directory) are fixed, it is recommended that
1836 you specify them in &_Local/Makefile_& instead of at runtime, so that errors
1837 detected early in Exim's execution (such as a malformed configuration file) can
1838 be logged.
1839
1840 .cindex "content scanning" "specifying at build time"
1841 Exim's interfaces for calling virus and spam scanning software directly from
1842 access control lists are not compiled by default. If you want to include these
1843 facilities, you need to set
1844 .code
1845 WITH_CONTENT_SCAN=yes
1846 .endd
1847 in your &_Local/Makefile_&. For details of the facilities themselves, see
1848 chapter &<<CHAPexiscan>>&.
1849
1850
1851 .cindex "&_Local/eximon.conf_&"
1852 .cindex "&_exim_monitor/EDITME_&"
1853 If you are going to build the Exim monitor, a similar configuration process is
1854 required. The file &_exim_monitor/EDITME_& must be edited appropriately for
1855 your installation and saved under the name &_Local/eximon.conf_&. If you are
1856 happy with the default settings described in &_exim_monitor/EDITME_&,
1857 &_Local/eximon.conf_& can be empty, but it must exist.
1858
1859 This is all the configuration that is needed in straightforward cases for known
1860 operating systems. However, the building process is set up so that it is easy
1861 to override options that are set by default or by operating-system-specific
1862 configuration files, for example, to change the C compiler, which
1863 defaults to &%gcc%&. See section &<<SECToverride>>& below for details of how to
1864 do this.
1865
1866
1867
1868 .section "Support for iconv()" "SECID26"
1869 .cindex "&[iconv()]& support"
1870 .cindex "RFC 2047"
1871 The contents of header lines in messages may be encoded according to the rules
1872 described RFC 2047. This makes it possible to transmit characters that are not
1873 in the ASCII character set, and to label them as being in a particular
1874 character set. When Exim is inspecting header lines by means of the &%$h_%&
1875 mechanism, it decodes them, and translates them into a specified character set
1876 (default is set at build time). The translation is possible only if the operating system
1877 supports the &[iconv()]& function.
1878
1879 However, some of the operating systems that supply &[iconv()]& do not support
1880 very many conversions. The GNU &%libiconv%& library (available from
1881 &url(https://www.gnu.org/software/libiconv/)) can be installed on such
1882 systems to remedy this deficiency, as well as on systems that do not supply
1883 &[iconv()]& at all. After installing &%libiconv%&, you should add
1884 .code
1885 HAVE_ICONV=yes
1886 .endd
1887 to your &_Local/Makefile_& and rebuild Exim.
1888
1889
1890
1891 .section "Including TLS/SSL encryption support" "SECTinctlsssl"
1892 .cindex "TLS" "including support for TLS"
1893 .cindex "encryption" "including support for"
1894 .cindex "OpenSSL" "building Exim with"
1895 .cindex "GnuTLS" "building Exim with"
1896 Exim is usually built to support encrypted SMTP connections, using the STARTTLS
1897 command as per RFC 2487. It can also support clients that expect to
1898 start a TLS session immediately on connection to a non-standard port (see the
1899 &%tls_on_connect_ports%& runtime option and the &%-tls-on-connect%& command
1900 line option).
1901
1902 If you want to build Exim with TLS support, you must first install either the
1903 OpenSSL or GnuTLS library. There is no cryptographic code in Exim itself for
1904 implementing SSL.
1905
1906 If you do not want TLS support you should set
1907 .code
1908 DISABLE_TLS=yes
1909 .endd
1910 in &_Local/Makefile_&.
1911
1912 If OpenSSL is installed, you should set
1913 .code
1914 USE_OPENSL=yes
1915 TLS_LIBS=-lssl -lcrypto
1916 .endd
1917 in &_Local/Makefile_&. You may also need to specify the locations of the
1918 OpenSSL library and include files. For example:
1919 .code
1920 USE_OPENSSL=yes
1921 TLS_LIBS=-L/usr/local/openssl/lib -lssl -lcrypto
1922 TLS_INCLUDE=-I/usr/local/openssl/include/
1923 .endd
1924 .cindex "pkg-config" "OpenSSL"
1925 If you have &'pkg-config'& available, then instead you can just use:
1926 .code
1927 USE_OPENSSL=yes
1928 USE_OPENSSL_PC=openssl
1929 .endd
1930 .cindex "USE_GNUTLS"
1931 If GnuTLS is installed, you should set
1932 .code
1933 USE_GNUTLS=yes
1934 TLS_LIBS=-lgnutls -ltasn1 -lgcrypt
1935 .endd
1936 in &_Local/Makefile_&, and again you may need to specify the locations of the
1937 library and include files. For example:
1938 .code
1939 USE_GNUTLS=yes
1940 TLS_LIBS=-L/usr/gnu/lib -lgnutls -ltasn1 -lgcrypt
1941 TLS_INCLUDE=-I/usr/gnu/include
1942 .endd
1943 .cindex "pkg-config" "GnuTLS"
1944 If you have &'pkg-config'& available, then instead you can just use:
1945 .code
1946 USE_GNUTLS=yes
1947 USE_GNUTLS_PC=gnutls
1948 .endd
1949
1950 You do not need to set TLS_INCLUDE if the relevant directory is already
1951 specified in INCLUDE. Details of how to configure Exim to make use of TLS are
1952 given in chapter &<<CHAPTLS>>&.
1953
1954
1955
1956
1957 .section "Use of tcpwrappers" "SECID27"
1958
1959 .cindex "tcpwrappers, building Exim to support"
1960 .cindex "USE_TCP_WRAPPERS"
1961 .cindex "TCP_WRAPPERS_DAEMON_NAME"
1962 .cindex "tcp_wrappers_daemon_name"
1963 Exim can be linked with the &'tcpwrappers'& library in order to check incoming
1964 SMTP calls using the &'tcpwrappers'& control files. This may be a convenient
1965 alternative to Exim's own checking facilities for installations that are
1966 already making use of &'tcpwrappers'& for other purposes. To do this, you
1967 should set USE_TCP_WRAPPERS in &_Local/Makefile_&, arrange for the file
1968 &_tcpd.h_& to be available at compile time, and also ensure that the library
1969 &_libwrap.a_& is available at link time, typically by including &%-lwrap%& in
1970 EXTRALIBS_EXIM. For example, if &'tcpwrappers'& is installed in &_/usr/local_&,
1971 you might have
1972 .code
1973 USE_TCP_WRAPPERS=yes
1974 CFLAGS=-O -I/usr/local/include
1975 EXTRALIBS_EXIM=-L/usr/local/lib -lwrap
1976 .endd
1977 in &_Local/Makefile_&. The daemon name to use in the &'tcpwrappers'& control
1978 files is &"exim"&. For example, the line
1979 .code
1980 exim : LOCAL  192.168.1.  .friendly.domain.example
1981 .endd
1982 in your &_/etc/hosts.allow_& file allows connections from the local host, from
1983 the subnet 192.168.1.0/24, and from all hosts in &'friendly.domain.example'&.
1984 All other connections are denied. The daemon name used by &'tcpwrappers'&
1985 can be changed at build time by setting TCP_WRAPPERS_DAEMON_NAME in
1986 &_Local/Makefile_&, or by setting tcp_wrappers_daemon_name in the
1987 configure file. Consult the &'tcpwrappers'& documentation for
1988 further details.
1989
1990
1991 .section "Including support for IPv6" "SECID28"
1992 .cindex "IPv6" "including support for"
1993 Exim contains code for use on systems that have IPv6 support. Setting
1994 &`HAVE_IPV6=YES`& in &_Local/Makefile_& causes the IPv6 code to be included;
1995 it may also be necessary to set IPV6_INCLUDE and IPV6_LIBS on systems
1996 where the IPv6 support is not fully integrated into the normal include and
1997 library files.
1998
1999 Two different types of DNS record for handling IPv6 addresses have been
2000 defined. AAAA records (analogous to A records for IPv4) are in use, and are
2001 currently seen as the mainstream. Another record type called A6 was proposed
2002 as better than AAAA because it had more flexibility. However, it was felt to be
2003 over-complex, and its status was reduced to &"experimental"&.
2004 Exim used to
2005 have a compile option for including A6 record support but this has now been
2006 withdrawn.
2007
2008
2009
2010 .section "Dynamically loaded lookup module support" "SECTdynamicmodules"
2011 .cindex "lookup modules"
2012 .cindex "dynamic modules"
2013 .cindex ".so building"
2014 On some platforms, Exim supports not compiling all lookup types directly into
2015 the main binary, instead putting some into external modules which can be loaded
2016 on demand.
2017 This permits packagers to build Exim with support for lookups with extensive
2018 library dependencies without requiring all users to install all of those
2019 dependencies.
2020 Most, but not all, lookup types can be built this way.
2021
2022 Set &`LOOKUP_MODULE_DIR`& to the directory into which the modules will be
2023 installed; Exim will only load modules from that directory, as a security
2024 measure.  You will need to set &`CFLAGS_DYNAMIC`& if not already defined
2025 for your OS; see &_OS/Makefile-Linux_& for an example.
2026 Some other requirements for adjusting &`EXTRALIBS`& may also be necessary,
2027 see &_src/EDITME_& for details.
2028
2029 Then, for each module to be loaded dynamically, define the relevant
2030 &`LOOKUP_`&<&'lookup_type'&> flags to have the value "2" instead of "yes".
2031 For example, this will build in lsearch but load sqlite and mysql support
2032 on demand:
2033 .code
2034 LOOKUP_LSEARCH=yes
2035 LOOKUP_SQLITE=2
2036 LOOKUP_MYSQL=2
2037 .endd
2038
2039
2040 .section "The building process" "SECID29"
2041 .cindex "build directory"
2042 Once &_Local/Makefile_& (and &_Local/eximon.conf_&, if required) have been
2043 created, run &'make'& at the top level. It determines the architecture and
2044 operating system types, and creates a build directory if one does not exist.
2045 For example, on a Sun system running Solaris 8, the directory
2046 &_build-SunOS5-5.8-sparc_& is created.
2047 .cindex "symbolic link" "to source files"
2048 Symbolic links to relevant source files are installed in the build directory.
2049
2050 If this is the first time &'make'& has been run, it calls a script that builds
2051 a make file inside the build directory, using the configuration files from the
2052 &_Local_& directory. The new make file is then passed to another instance of
2053 &'make'&. This does the real work, building a number of utility scripts, and
2054 then compiling and linking the binaries for the Exim monitor (if configured), a
2055 number of utility programs, and finally Exim itself. The command &`make
2056 makefile`& can be used to force a rebuild of the make file in the build
2057 directory, should this ever be necessary.
2058
2059 If you have problems building Exim, check for any comments there may be in the
2060 &_README_& file concerning your operating system, and also take a look at the
2061 FAQ, where some common problems are covered.
2062
2063
2064
2065 .section 'Output from &"make"&' "SECID283"
2066 The output produced by the &'make'& process for compile lines is often very
2067 unreadable, because these lines can be very long. For this reason, the normal
2068 output is suppressed by default, and instead output similar to that which
2069 appears when compiling the 2.6 Linux kernel is generated: just a short line for
2070 each module that is being compiled or linked. However, it is still possible to
2071 get the full output, by calling &'make'& like this:
2072 .code
2073 FULLECHO='' make -e
2074 .endd
2075 The value of FULLECHO defaults to &"@"&, the flag character that suppresses
2076 command reflection in &'make'&. When you ask for the full output, it is
2077 given in addition to the short output.
2078
2079
2080
2081 .section "Overriding build-time options for Exim" "SECToverride"
2082 .cindex "build-time options, overriding"
2083 The main make file that is created at the beginning of the building process
2084 consists of the concatenation of a number of files which set configuration
2085 values, followed by a fixed set of &'make'& instructions. If a value is set
2086 more than once, the last setting overrides any previous ones. This provides a
2087 convenient way of overriding defaults. The files that are concatenated are, in
2088 order:
2089 .display
2090 &_OS/Makefile-Default_&
2091 &_OS/Makefile-_&<&'ostype'&>
2092 &_Local/Makefile_&
2093 &_Local/Makefile-_&<&'ostype'&>
2094 &_Local/Makefile-_&<&'archtype'&>
2095 &_Local/Makefile-_&<&'ostype'&>-<&'archtype'&>
2096 &_OS/Makefile-Base_&
2097 .endd
2098 .cindex "&_Local/Makefile_&"
2099 .cindex "building Exim" "operating system type"
2100 .cindex "building Exim" "architecture type"
2101 where <&'ostype'&> is the operating system type and <&'archtype'&> is the
2102 architecture type. &_Local/Makefile_& is required to exist, and the building
2103 process fails if it is absent. The other three &_Local_& files are optional,
2104 and are often not needed.
2105
2106 The values used for <&'ostype'&> and <&'archtype'&> are obtained from scripts
2107 called &_scripts/os-type_& and &_scripts/arch-type_& respectively. If either of
2108 the environment variables EXIM_OSTYPE or EXIM_ARCHTYPE is set, their
2109 values are used, thereby providing a means of forcing particular settings.
2110 Otherwise, the scripts try to get values from the &%uname%& command. If this
2111 fails, the shell variables OSTYPE and ARCHTYPE are inspected. A number
2112 of &'ad hoc'& transformations are then applied, to produce the standard names
2113 that Exim expects. You can run these scripts directly from the shell in order
2114 to find out what values are being used on your system.
2115
2116
2117 &_OS/Makefile-Default_& contains comments about the variables that are set
2118 therein. Some (but not all) are mentioned below. If there is something that
2119 needs changing, review the contents of this file and the contents of the make
2120 file for your operating system (&_OS/Makefile-<ostype>_&) to see what the
2121 default values are.
2122
2123
2124 .cindex "building Exim" "overriding default settings"
2125 If you need to change any of the values that are set in &_OS/Makefile-Default_&
2126 or in &_OS/Makefile-<ostype>_&, or to add any new definitions, you do not
2127 need to change the original files. Instead, you should make the changes by
2128 putting the new values in an appropriate &_Local_& file. For example,
2129 .cindex "Tru64-Unix build-time settings"
2130 when building Exim in many releases of the Tru64-Unix (formerly Digital UNIX,
2131 formerly DEC-OSF1) operating system, it is necessary to specify that the C
2132 compiler is called &'cc'& rather than &'gcc'&. Also, the compiler must be
2133 called with the option &%-std1%&, to make it recognize some of the features of
2134 Standard C that Exim uses. (Most other compilers recognize Standard C by
2135 default.) To do this, you should create a file called &_Local/Makefile-OSF1_&
2136 containing the lines
2137 .code
2138 CC=cc
2139 CFLAGS=-std1
2140 .endd
2141 If you are compiling for just one operating system, it may be easier to put
2142 these lines directly into &_Local/Makefile_&.
2143
2144 Keeping all your local configuration settings separate from the distributed
2145 files makes it easy to transfer them to new versions of Exim simply by copying
2146 the contents of the &_Local_& directory.
2147
2148
2149 .cindex "NIS lookup type" "including support for"
2150 .cindex "NIS+ lookup type" "including support for"
2151 .cindex "LDAP" "including support for"
2152 .cindex "lookup" "inclusion in binary"
2153 Exim contains support for doing LDAP, NIS, NIS+, and other kinds of file
2154 lookup, but not all systems have these components installed, so the default is
2155 not to include the relevant code in the binary. All the different kinds of file
2156 and database lookup that Exim supports are implemented as separate code modules
2157 which are included only if the relevant compile-time options are set. In the
2158 case of LDAP, NIS, and NIS+, the settings for &_Local/Makefile_& are:
2159 .code
2160 LOOKUP_LDAP=yes
2161 LOOKUP_NIS=yes
2162 LOOKUP_NISPLUS=yes
2163 .endd
2164 and similar settings apply to the other lookup types. They are all listed in
2165 &_src/EDITME_&. In many cases the relevant include files and interface
2166 libraries need to be installed before compiling Exim.
2167 .cindex "cdb" "including support for"
2168 However, there are some optional lookup types (such as cdb) for which
2169 the code is entirely contained within Exim, and no external include
2170 files or libraries are required. When a lookup type is not included in the
2171 binary, attempts to configure Exim to use it cause runtime configuration
2172 errors.
2173
2174 .cindex "pkg-config" "lookups"
2175 .cindex "pkg-config" "authenticators"
2176 Many systems now use a tool called &'pkg-config'& to encapsulate information
2177 about how to compile against a library; Exim has some initial support for
2178 being able to use pkg-config for lookups and authenticators.  For any given
2179 makefile variable which starts &`LOOKUP_`& or &`AUTH_`&, you can add a new
2180 variable with the &`_PC`& suffix in the name and assign as the value the
2181 name of the package to be queried.  The results of querying via the
2182 &'pkg-config'& command will be added to the appropriate Makefile variables
2183 with &`+=`& directives, so your version of &'make'& will need to support that
2184 syntax.  For instance:
2185 .code
2186 LOOKUP_SQLITE=yes
2187 LOOKUP_SQLITE_PC=sqlite3
2188 AUTH_GSASL=yes
2189 AUTH_GSASL_PC=libgsasl
2190 AUTH_HEIMDAL_GSSAPI=yes
2191 AUTH_HEIMDAL_GSSAPI_PC=heimdal-gssapi
2192 .endd
2193
2194 .cindex "Perl" "including support for"
2195 Exim can be linked with an embedded Perl interpreter, allowing Perl
2196 subroutines to be called during string expansion. To enable this facility,
2197 .code
2198 EXIM_PERL=perl.o
2199 .endd
2200 must be defined in &_Local/Makefile_&. Details of this facility are given in
2201 chapter &<<CHAPperl>>&.
2202
2203 .cindex "X11 libraries, location of"
2204 The location of the X11 libraries is something that varies a lot between
2205 operating systems, and there may be different versions of X11 to cope
2206 with. Exim itself makes no use of X11, but if you are compiling the Exim
2207 monitor, the X11 libraries must be available.
2208 The following three variables are set in &_OS/Makefile-Default_&:
2209 .code
2210 X11=/usr/X11R6
2211 XINCLUDE=-I$(X11)/include
2212 XLFLAGS=-L$(X11)/lib
2213 .endd
2214 These are overridden in some of the operating-system configuration files. For
2215 example, in &_OS/Makefile-SunOS5_& there is
2216 .code
2217 X11=/usr/openwin
2218 XINCLUDE=-I$(X11)/include
2219 XLFLAGS=-L$(X11)/lib -R$(X11)/lib
2220 .endd
2221 If you need to override the default setting for your operating system, place a
2222 definition of all three of these variables into your
2223 &_Local/Makefile-<ostype>_& file.
2224
2225 .cindex "EXTRALIBS"
2226 If you need to add any extra libraries to the link steps, these can be put in a
2227 variable called EXTRALIBS, which appears in all the link commands, but by
2228 default is not defined. In contrast, EXTRALIBS_EXIM is used only on the
2229 command for linking the main Exim binary, and not for any associated utilities.
2230
2231 .cindex "DBM libraries" "configuration for building"
2232 There is also DBMLIB, which appears in the link commands for binaries that
2233 use DBM functions (see also section &<<SECTdb>>&). Finally, there is
2234 EXTRALIBS_EXIMON, which appears only in the link step for the Exim monitor
2235 binary, and which can be used, for example, to include additional X11
2236 libraries.
2237
2238 .cindex "configuration file" "editing"
2239 The make file copes with rebuilding Exim correctly if any of the configuration
2240 files are edited. However, if an optional configuration file is deleted, it is
2241 necessary to touch the associated non-optional file (that is,
2242 &_Local/Makefile_& or &_Local/eximon.conf_&) before rebuilding.
2243
2244
2245 .section "OS-specific header files" "SECID30"
2246 .cindex "&_os.h_&"
2247 .cindex "building Exim" "OS-specific C header files"
2248 The &_OS_& directory contains a number of files with names of the form
2249 &_os.h-<ostype>_&. These are system-specific C header files that should not
2250 normally need to be changed. There is a list of macro settings that are
2251 recognized in the file &_OS/os.configuring_&, which should be consulted if you
2252 are porting Exim to a new operating system.
2253
2254
2255
2256 .section "Overriding build-time options for the monitor" "SECID31"
2257 .cindex "building Eximon"
2258 A similar process is used for overriding things when building the Exim monitor,
2259 where the files that are involved are
2260 .display
2261 &_OS/eximon.conf-Default_&
2262 &_OS/eximon.conf-_&<&'ostype'&>
2263 &_Local/eximon.conf_&
2264 &_Local/eximon.conf-_&<&'ostype'&>
2265 &_Local/eximon.conf-_&<&'archtype'&>
2266 &_Local/eximon.conf-_&<&'ostype'&>-<&'archtype'&>
2267 .endd
2268 .cindex "&_Local/eximon.conf_&"
2269 As with Exim itself, the final three files need not exist, and in this case the
2270 &_OS/eximon.conf-<ostype>_& file is also optional. The default values in
2271 &_OS/eximon.conf-Default_& can be overridden dynamically by setting environment
2272 variables of the same name, preceded by EXIMON_. For example, setting
2273 EXIMON_LOG_DEPTH in the environment overrides the value of
2274 LOG_DEPTH at runtime.
2275 .ecindex IIDbuex
2276
2277
2278 .section "Installing Exim binaries and scripts" "SECID32"
2279 .cindex "installing Exim"
2280 .cindex "BIN_DIRECTORY"
2281 The command &`make install`& runs the &(exim_install)& script with no
2282 arguments. The script copies binaries and utility scripts into the directory
2283 whose name is specified by the BIN_DIRECTORY setting in &_Local/Makefile_&.
2284 .cindex "setuid" "installing Exim with"
2285 The install script copies files only if they are newer than the files they are
2286 going to replace. The Exim binary is required to be owned by root and have the
2287 &'setuid'& bit set, for normal configurations. Therefore, you must run &`make
2288 install`& as root so that it can set up the Exim binary in this way. However, in
2289 some special situations (for example, if a host is doing no local deliveries)
2290 it may be possible to run Exim without making the binary setuid root (see
2291 chapter &<<CHAPsecurity>>& for details).
2292
2293 .cindex "CONFIGURE_FILE"
2294 Exim's runtime configuration file is named by the CONFIGURE_FILE setting
2295 in &_Local/Makefile_&. If this names a single file, and the file does not
2296 exist, the default configuration file &_src/configure.default_& is copied there
2297 by the installation script. If a runtime configuration file already exists, it
2298 is left alone. If CONFIGURE_FILE is a colon-separated list, naming several
2299 alternative files, no default is installed.
2300
2301 .cindex "system aliases file"
2302 .cindex "&_/etc/aliases_&"
2303 One change is made to the default configuration file when it is installed: the
2304 default configuration contains a router that references a system aliases file.
2305 The path to this file is set to the value specified by
2306 SYSTEM_ALIASES_FILE in &_Local/Makefile_& (&_/etc/aliases_& by default).
2307 If the system aliases file does not exist, the installation script creates it,
2308 and outputs a comment to the user.
2309
2310 The created file contains no aliases, but it does contain comments about the
2311 aliases a site should normally have. Mail aliases have traditionally been
2312 kept in &_/etc/aliases_&. However, some operating systems are now using
2313 &_/etc/mail/aliases_&. You should check if yours is one of these, and change
2314 Exim's configuration if necessary.
2315
2316 The default configuration uses the local host's name as the only local domain,
2317 and is set up to do local deliveries into the shared directory &_/var/mail_&,
2318 running as the local user. System aliases and &_.forward_& files in users' home
2319 directories are supported, but no NIS or NIS+ support is configured. Domains
2320 other than the name of the local host are routed using the DNS, with delivery
2321 over SMTP.
2322
2323 It is possible to install Exim for special purposes (such as building a binary
2324 distribution) in a private part of the file system. You can do this by a
2325 command such as
2326 .code
2327 make DESTDIR=/some/directory/ install
2328 .endd
2329 This has the effect of pre-pending the specified directory to all the file
2330 paths, except the name of the system aliases file that appears in the default
2331 configuration. (If a default alias file is created, its name &'is'& modified.)
2332 For backwards compatibility, ROOT is used if DESTDIR is not set,
2333 but this usage is deprecated.
2334
2335 .cindex "installing Exim" "what is not installed"
2336 Running &'make install'& does not copy the Exim 4 conversion script
2337 &'convert4r4'&. You will probably run this only once if you are
2338 upgrading from Exim 3. None of the documentation files in the &_doc_&
2339 directory are copied, except for the info files when you have set
2340 INFO_DIRECTORY, as described in section &<<SECTinsinfdoc>>& below.
2341
2342 For the utility programs, old versions are renamed by adding the suffix &_.O_&
2343 to their names. The Exim binary itself, however, is handled differently. It is
2344 installed under a name that includes the version number and the compile number,
2345 for example, &_exim-&version()-1_&. The script then arranges for a symbolic link
2346 called &_exim_& to point to the binary. If you are updating a previous version
2347 of Exim, the script takes care to ensure that the name &_exim_& is never absent
2348 from the directory (as seen by other processes).
2349
2350 .cindex "installing Exim" "testing the script"
2351 If you want to see what the &'make install'& will do before running it for
2352 real, you can pass the &%-n%& option to the installation script by this
2353 command:
2354 .code
2355 make INSTALL_ARG=-n install
2356 .endd
2357 The contents of the variable INSTALL_ARG are passed to the installation
2358 script. You do not need to be root to run this test. Alternatively, you can run
2359 the installation script directly, but this must be from within the build
2360 directory. For example, from the top-level Exim directory you could use this
2361 command:
2362 .code
2363 (cd build-SunOS5-5.5.1-sparc; ../scripts/exim_install -n)
2364 .endd
2365 .cindex "installing Exim" "install script options"
2366 There are two other options that can be supplied to the installation script.
2367
2368 .ilist
2369 &%-no_chown%& bypasses the call to change the owner of the installed binary
2370 to root, and the call to make it a setuid binary.
2371 .next
2372 &%-no_symlink%& bypasses the setting up of the symbolic link &_exim_& to the
2373 installed binary.
2374 .endlist
2375
2376 INSTALL_ARG can be used to pass these options to the script. For example:
2377 .code
2378 make INSTALL_ARG=-no_symlink install
2379 .endd
2380 The installation script can also be given arguments specifying which files are
2381 to be copied. For example, to install just the Exim binary, and nothing else,
2382 without creating the symbolic link, you could use:
2383 .code
2384 make INSTALL_ARG='-no_symlink exim' install
2385 .endd
2386
2387
2388
2389 .section "Installing info documentation" "SECTinsinfdoc"
2390 .cindex "installing Exim" "&'info'& documentation"
2391 Not all systems use the GNU &'info'& system for documentation, and for this
2392 reason, the Texinfo source of Exim's documentation is not included in the main
2393 distribution. Instead it is available separately from the FTP site (see section
2394 &<<SECTavail>>&).
2395
2396 If you have defined INFO_DIRECTORY in &_Local/Makefile_& and the Texinfo
2397 source of the documentation is found in the source tree, running &`make
2398 install`& automatically builds the info files and installs them.
2399
2400
2401
2402 .section "Setting up the spool directory" "SECID33"
2403 .cindex "spool directory" "creating"
2404 When it starts up, Exim tries to create its spool directory if it does not
2405 exist. The Exim uid and gid are used for the owner and group of the spool
2406 directory. Sub-directories are automatically created in the spool directory as
2407 necessary.
2408
2409
2410
2411
2412 .section "Testing" "SECID34"
2413 .cindex "testing" "installation"
2414 Having installed Exim, you can check that the runtime configuration file is
2415 syntactically valid by running the following command, which assumes that the
2416 Exim binary directory is within your PATH environment variable:
2417 .code
2418 exim -bV
2419 .endd
2420 If there are any errors in the configuration file, Exim outputs error messages.
2421 Otherwise it outputs the version number and build date,
2422 the DBM library that is being used, and information about which drivers and
2423 other optional code modules are included in the binary.
2424 Some simple routing tests can be done by using the address testing option. For
2425 example,
2426 .display
2427 &`exim -bt`& <&'local username'&>
2428 .endd
2429 should verify that it recognizes a local mailbox, and
2430 .display
2431 &`exim -bt`& <&'remote address'&>
2432 .endd
2433 a remote one. Then try getting it to deliver mail, both locally and remotely.
2434 This can be done by passing messages directly to Exim, without going through a
2435 user agent. For example:
2436 .code
2437 exim -v postmaster@your.domain.example
2438 From: user@your.domain.example
2439 To: postmaster@your.domain.example
2440 Subject: Testing Exim
2441
2442 This is a test message.
2443 ^D
2444 .endd
2445 The &%-v%& option causes Exim to output some verification of what it is doing.
2446 In this case you should see copies of three log lines, one for the message's
2447 arrival, one for its delivery, and one containing &"Completed"&.
2448
2449 .cindex "delivery" "problems with"
2450 If you encounter problems, look at Exim's log files (&'mainlog'& and
2451 &'paniclog'&) to see if there is any relevant information there. Another source
2452 of information is running Exim with debugging turned on, by specifying the
2453 &%-d%& option. If a message is stuck on Exim's spool, you can force a delivery
2454 with debugging turned on by a command of the form
2455 .display
2456 &`exim -d -M`& <&'exim-message-id'&>
2457 .endd
2458 You must be root or an &"admin user"& in order to do this. The &%-d%& option
2459 produces rather a lot of output, but you can cut this down to specific areas.
2460 For example, if you use &%-d-all+route%& only the debugging information
2461 relevant to routing is included. (See the &%-d%& option in chapter
2462 &<<CHAPcommandline>>& for more details.)
2463
2464 .cindex '&"sticky"& bit'
2465 .cindex "lock files"
2466 One specific problem that has shown up on some sites is the inability to do
2467 local deliveries into a shared mailbox directory, because it does not have the
2468 &"sticky bit"& set on it. By default, Exim tries to create a lock file before
2469 writing to a mailbox file, and if it cannot create the lock file, the delivery
2470 is deferred. You can get round this either by setting the &"sticky bit"& on the
2471 directory, or by setting a specific group for local deliveries and allowing
2472 that group to create files in the directory (see the comments above the
2473 &(local_delivery)& transport in the default configuration file). Another
2474 approach is to configure Exim not to use lock files, but just to rely on
2475 &[fcntl()]& locking instead. However, you should do this only if all user
2476 agents also use &[fcntl()]& locking. For further discussion of locking issues,
2477 see chapter &<<CHAPappendfile>>&.
2478
2479 One thing that cannot be tested on a system that is already running an MTA is
2480 the receipt of incoming SMTP mail on the standard SMTP port. However, the
2481 &%-oX%& option can be used to run an Exim daemon that listens on some other
2482 port, or &'inetd'& can be used to do this. The &%-bh%& option and the
2483 &'exim_checkaccess'& utility can be used to check out policy controls on
2484 incoming SMTP mail.
2485
2486 Testing a new version on a system that is already running Exim can most easily
2487 be done by building a binary with a different CONFIGURE_FILE setting. From
2488 within the runtime configuration, all other file and directory names
2489 that Exim uses can be altered, in order to keep it entirely clear of the
2490 production version.
2491
2492
2493 .section "Replacing another MTA with Exim" "SECID35"
2494 .cindex "replacing another MTA"
2495 Building and installing Exim for the first time does not of itself put it in
2496 general use. The name by which the system's MTA is called by mail user agents
2497 is either &_/usr/sbin/sendmail_&, or &_/usr/lib/sendmail_& (depending on the
2498 operating system), and it is necessary to make this name point to the &'exim'&
2499 binary in order to get the user agents to pass messages to Exim. This is
2500 normally done by renaming any existing file and making &_/usr/sbin/sendmail_&
2501 or &_/usr/lib/sendmail_&
2502 .cindex "symbolic link" "to &'exim'& binary"
2503 a symbolic link to the &'exim'& binary. It is a good idea to remove any setuid
2504 privilege and executable status from the old MTA. It is then necessary to stop
2505 and restart the mailer daemon, if one is running.
2506
2507 .cindex "FreeBSD, MTA indirection"
2508 .cindex "&_/etc/mail/mailer.conf_&"
2509 Some operating systems have introduced alternative ways of switching MTAs. For
2510 example, if you are running FreeBSD, you need to edit the file
2511 &_/etc/mail/mailer.conf_& instead of setting up a symbolic link as just
2512 described. A typical example of the contents of this file for running Exim is
2513 as follows:
2514 .code
2515 sendmail            /usr/exim/bin/exim
2516 send-mail           /usr/exim/bin/exim
2517 mailq               /usr/exim/bin/exim -bp
2518 newaliases          /usr/bin/true
2519 .endd
2520 Once you have set up the symbolic link, or edited &_/etc/mail/mailer.conf_&,
2521 your Exim installation is &"live"&. Check it by sending a message from your
2522 favourite user agent.
2523
2524 You should consider what to tell your users about the change of MTA. Exim may
2525 have different capabilities to what was previously running, and there are
2526 various operational differences such as the text of messages produced by
2527 command line options and in bounce messages. If you allow your users to make
2528 use of Exim's filtering capabilities, you should make the document entitled
2529 &'Exim's interface to mail filtering'& available to them.
2530
2531
2532
2533 .section "Upgrading Exim" "SECID36"
2534 .cindex "upgrading Exim"
2535 If you are already running Exim on your host, building and installing a new
2536 version automatically makes it available to MUAs, or any other programs that
2537 call the MTA directly. However, if you are running an Exim daemon, you do need
2538 .cindex restart "on HUP signal"
2539 .cindex signal "HUP, to restart"
2540 to send it a HUP signal, to make it re-execute itself, and thereby pick up the
2541 new binary. You do not need to stop processing mail in order to install a new
2542 version of Exim. The install script does not modify an existing runtime
2543 configuration file.
2544
2545
2546
2547
2548 .section "Stopping the Exim daemon on Solaris" "SECID37"
2549 .cindex "Solaris" "stopping Exim on"
2550 The standard command for stopping the mailer daemon on Solaris is
2551 .code
2552 /etc/init.d/sendmail stop
2553 .endd
2554 If &_/usr/lib/sendmail_& has been turned into a symbolic link, this script
2555 fails to stop Exim because it uses the command &'ps -e'& and greps the output
2556 for the text &"sendmail"&; this is not present because the actual program name
2557 (that is, &"exim"&) is given by the &'ps'& command with these options. A
2558 solution is to replace the line that finds the process id with something like
2559 .code
2560 pid=`cat /var/spool/exim/exim-daemon.pid`
2561 .endd
2562 to obtain the daemon's pid directly from the file that Exim saves it in.
2563
2564 Note, however, that stopping the daemon does not &"stop Exim"&. Messages can
2565 still be received from local processes, and if automatic delivery is configured
2566 (the normal case), deliveries will still occur.
2567
2568
2569
2570
2571 . ////////////////////////////////////////////////////////////////////////////
2572 . ////////////////////////////////////////////////////////////////////////////
2573
2574 .chapter "The Exim command line" "CHAPcommandline"
2575 .scindex IIDclo1 "command line" "options"
2576 .scindex IIDclo2 "options" "command line"
2577 Exim's command line takes the standard Unix form of a sequence of options,
2578 each starting with a hyphen character, followed by a number of arguments. The
2579 options are compatible with the main options of Sendmail, and there are also
2580 some additional options, some of which are compatible with Smail 3. Certain
2581 combinations of options do not make sense, and provoke an error if used.
2582 The form of the arguments depends on which options are set.
2583
2584
2585 .section "Setting options by program name" "SECID38"
2586 .cindex "&'mailq'&"
2587 If Exim is called under the name &'mailq'&, it behaves as if the option &%-bp%&
2588 were present before any other options.
2589 The &%-bp%& option requests a listing of the contents of the mail queue on the
2590 standard output.
2591 This feature is for compatibility with some systems that contain a command of
2592 that name in one of the standard libraries, symbolically linked to
2593 &_/usr/sbin/sendmail_& or &_/usr/lib/sendmail_&.
2594
2595 .cindex "&'rsmtp'&"
2596 If Exim is called under the name &'rsmtp'& it behaves as if the option &%-bS%&
2597 were present before any other options, for compatibility with Smail. The
2598 &%-bS%& option is used for reading in a number of messages in batched SMTP
2599 format.
2600
2601 .cindex "&'rmail'&"
2602 If Exim is called under the name &'rmail'& it behaves as if the &%-i%& and
2603 &%-oee%& options were present before any other options, for compatibility with
2604 Smail. The name &'rmail'& is used as an interface by some UUCP systems.
2605
2606 .cindex "&'runq'&"
2607 .cindex "queue runner"
2608 If Exim is called under the name &'runq'& it behaves as if the option &%-q%&
2609 were present before any other options, for compatibility with Smail. The &%-q%&
2610 option causes a single queue runner process to be started.
2611
2612 .cindex "&'newaliases'&"
2613 .cindex "alias file" "building"
2614 .cindex "Sendmail compatibility" "calling Exim as &'newaliases'&"
2615 If Exim is called under the name &'newaliases'& it behaves as if the option
2616 &%-bi%& were present before any other options, for compatibility with Sendmail.
2617 This option is used for rebuilding Sendmail's alias file. Exim does not have
2618 the concept of a single alias file, but can be configured to run a given
2619 command if called with the &%-bi%& option.
2620
2621
2622 .section "Trusted and admin users" "SECTtrustedadmin"
2623 Some Exim options are available only to &'trusted users'& and others are
2624 available only to &'admin users'&. In the description below, the phrases &"Exim
2625 user"& and &"Exim group"& mean the user and group defined by EXIM_USER and
2626 EXIM_GROUP in &_Local/Makefile_& or set by the &%exim_user%& and
2627 &%exim_group%& options. These do not necessarily have to use the name &"exim"&.
2628
2629 .ilist
2630 .cindex "trusted users" "definition of"
2631 .cindex "user" "trusted definition of"
2632 The trusted users are root, the Exim user, any user listed in the
2633 &%trusted_users%& configuration option, and any user whose current group or any
2634 supplementary group is one of those listed in the &%trusted_groups%&
2635 configuration option. Note that the Exim group is not automatically trusted.
2636
2637 .cindex '&"From"& line'
2638 .cindex "envelope from"
2639 .cindex "envelope sender"
2640 Trusted users are always permitted to use the &%-f%& option or a leading
2641 &"From&~"& line to specify the envelope sender of a message that is passed to
2642 Exim through the local interface (see the &%-bm%& and &%-f%& options below).
2643 See the &%untrusted_set_sender%& option for a way of permitting non-trusted
2644 users to set envelope senders.
2645
2646 .cindex "&'From:'& header line"
2647 .cindex "&'Sender:'& header line"
2648 .cindex "header lines" "From:"
2649 .cindex "header lines" "Sender:"
2650 For a trusted user, there is never any check on the contents of the &'From:'&
2651 header line, and a &'Sender:'& line is never added. Furthermore, any existing
2652 &'Sender:'& line in incoming local (non-TCP/IP) messages is not removed.
2653
2654 Trusted users may also specify a host name, host address, interface address,
2655 protocol name, ident value, and authentication data when submitting a message
2656 locally. Thus, they are able to insert messages into Exim's queue locally that
2657 have the characteristics of messages received from a remote host. Untrusted
2658 users may in some circumstances use &%-f%&, but can never set the other values
2659 that are available to trusted users.
2660 .next
2661 .cindex "user" "admin definition of"
2662 .cindex "admin user" "definition of"
2663 The admin users are root, the Exim user, and any user that is a member of the
2664 Exim group or of any group listed in the &%admin_groups%& configuration option.
2665 The current group does not have to be one of these groups.
2666
2667 Admin users are permitted to list the queue, and to carry out certain
2668 operations on messages, for example, to force delivery failures. It is also
2669 necessary to be an admin user in order to see the full information provided by
2670 the Exim monitor, and full debugging output.
2671
2672 By default, the use of the &%-M%&, &%-q%&, &%-R%&, and &%-S%& options to cause
2673 Exim to attempt delivery of messages on its queue is restricted to admin users.
2674 However, this restriction can be relaxed by setting the &%prod_requires_admin%&
2675 option false (that is, specifying &%no_prod_requires_admin%&).
2676
2677 Similarly, the use of the &%-bp%& option to list all the messages in the queue
2678 is restricted to admin users unless &%queue_list_requires_admin%& is set
2679 false.
2680 .endlist
2681
2682
2683 &*Warning*&: If you configure your system so that admin users are able to
2684 edit Exim's configuration file, you are giving those users an easy way of
2685 getting root. There is further discussion of this issue at the start of chapter
2686 &<<CHAPconf>>&.
2687
2688
2689
2690
2691 .section "Command line options" "SECID39"
2692 Exim's command line options are described in alphabetical order below. If none
2693 of the options that specifies a specific action (such as starting the daemon or
2694 a queue runner, or testing an address, or receiving a message in a specific
2695 format, or listing the queue) are present, and there is at least one argument
2696 on the command line, &%-bm%& (accept a local message on the standard input,
2697 with the arguments specifying the recipients) is assumed. Otherwise, Exim
2698 outputs a brief message about itself and exits.
2699
2700 . ////////////////////////////////////////////////////////////////////////////
2701 . Insert a stylized XML comment here, to identify the start of the command line
2702 . options. This is for the benefit of the Perl script that automatically
2703 . creates a man page for the options.
2704 . ////////////////////////////////////////////////////////////////////////////
2705
2706 .literal xml
2707 <!-- === Start of command line options === -->
2708 .literal off
2709
2710
2711 .vlist
2712 .vitem &%--%&
2713 .oindex "--"
2714 .cindex "options" "command line; terminating"
2715 This is a pseudo-option whose only purpose is to terminate the options and
2716 therefore to cause subsequent command line items to be treated as arguments
2717 rather than options, even if they begin with hyphens.
2718
2719 .vitem &%--help%&
2720 .oindex "&%--help%&"
2721 This option causes Exim to output a few sentences stating what it is.
2722 The same output is generated if the Exim binary is called with no options and
2723 no arguments.
2724
2725 .vitem &%--version%&
2726 .oindex "&%--version%&"
2727 This option is an alias for &%-bV%& and causes version information to be
2728 displayed.
2729
2730 .vitem &%-Ac%& &&&
2731        &%-Am%&
2732 .oindex "&%-Ac%&"
2733 .oindex "&%-Am%&"
2734 These options are used by Sendmail for selecting configuration files and are
2735 ignored by Exim.
2736
2737 .vitem &%-B%&<&'type'&>
2738 .oindex "&%-B%&"
2739 .cindex "8-bit characters"
2740 .cindex "Sendmail compatibility" "8-bit characters"
2741 This is a Sendmail option for selecting 7 or 8 bit processing. Exim is 8-bit
2742 clean; it ignores this option.
2743
2744 .vitem &%-bd%&
2745 .oindex "&%-bd%&"
2746 .cindex "daemon"
2747 .cindex "SMTP" "listener"
2748 .cindex "queue runner"
2749 This option runs Exim as a daemon, awaiting incoming SMTP connections. Usually
2750 the &%-bd%& option is combined with the &%-q%&<&'time'&> option, to specify
2751 that the daemon should also initiate periodic queue runs.
2752
2753 The &%-bd%& option can be used only by an admin user. If either of the &%-d%&
2754 (debugging) or &%-v%& (verifying) options are set, the daemon does not
2755 disconnect from the controlling terminal. When running this way, it can be
2756 stopped by pressing ctrl-C.
2757
2758 By default, Exim listens for incoming connections to the standard SMTP port on
2759 all the host's running interfaces. However, it is possible to listen on other
2760 ports, on multiple ports, and only on specific interfaces. Chapter
2761 &<<CHAPinterfaces>>& contains a description of the options that control this.
2762
2763 When a listening daemon
2764 .cindex "daemon" "process id (pid)"
2765 .cindex "pid (process id)" "of daemon"
2766 is started without the use of &%-oX%& (that is, without overriding the normal
2767 configuration), it writes its process id to a file called &_exim-daemon.pid_&
2768 in Exim's spool directory. This location can be overridden by setting
2769 PID_FILE_PATH in &_Local/Makefile_&. The file is written while Exim is still
2770 running as root.
2771
2772 When &%-oX%& is used on the command line to start a listening daemon, the
2773 process id is not written to the normal pid file path. However, &%-oP%& can be
2774 used to specify a path on the command line if a pid file is required.
2775
2776 The SIGHUP signal
2777 .cindex "SIGHUP"
2778 .cindex restart "on HUP signal"
2779 .cindex signal "HUP, to restart"
2780 .cindex "daemon" "restarting"
2781 .cindex signal "to reload configuration"
2782 .cindex daemon "reload configuration"
2783 .cindex reload configuration
2784 can be used to cause the daemon to re-execute itself. This should be done
2785 whenever Exim's configuration file, or any file that is incorporated into it by
2786 means of the &%.include%& facility, is changed, and also whenever a new version
2787 of Exim is installed. It is not necessary to do this when other files that are
2788 referenced from the configuration (for example, alias files) are changed,
2789 because these are reread each time they are used.
2790
2791 .vitem &%-bdf%&
2792 .oindex "&%-bdf%&"
2793 This option has the same effect as &%-bd%& except that it never disconnects
2794 from the controlling terminal, even when no debugging is specified.
2795
2796 .vitem &%-be%&
2797 .oindex "&%-be%&"
2798 .cindex "testing" "string expansion"
2799 .cindex "expansion" "testing"
2800 Run Exim in expansion testing mode. Exim discards its root privilege, to
2801 prevent ordinary users from using this mode to read otherwise inaccessible
2802 files. If no arguments are given, Exim runs interactively, prompting for lines
2803 of data. Otherwise, it processes each argument in turn.
2804
2805 If Exim was built with USE_READLINE=yes in &_Local/Makefile_&, it tries
2806 to load the &%libreadline%& library dynamically whenever the &%-be%& option is
2807 used without command line arguments. If successful, it uses the &[readline()]&
2808 function, which provides extensive line-editing facilities, for reading the
2809 test data. A line history is supported.
2810
2811 Long expansion expressions can be split over several lines by using backslash
2812 continuations. As in Exim's runtime configuration, white space at the start of
2813 continuation lines is ignored. Each argument or data line is passed through the
2814 string expansion mechanism, and the result is output. Variable values from the
2815 configuration file (for example, &$qualify_domain$&) are available, but no
2816 message-specific values (such as &$message_exim_id$&) are set, because no message
2817 is being processed (but see &%-bem%& and &%-Mset%&).
2818
2819 &*Note*&: If you use this mechanism to test lookups, and you change the data
2820 files or databases you are using, you must exit and restart Exim before trying
2821 the same lookup again. Otherwise, because each Exim process caches the results
2822 of lookups, you will just get the same result as before.
2823
2824 Macro processing is done on lines before string-expansion: new macros can be
2825 defined and macros will be expanded.
2826 Because macros in the config file are often used for secrets, those are only
2827 available to admin users.
2828
2829 .vitem &%-bem%&&~<&'filename'&>
2830 .oindex "&%-bem%&"
2831 .cindex "testing" "string expansion"
2832 .cindex "expansion" "testing"
2833 This option operates like &%-be%& except that it must be followed by the name
2834 of a file. For example:
2835 .code
2836 exim -bem /tmp/testmessage
2837 .endd
2838 The file is read as a message (as if receiving a locally-submitted non-SMTP
2839 message) before any of the test expansions are done. Thus, message-specific
2840 variables such as &$message_size$& and &$header_from:$& are available. However,
2841 no &'Received:'& header is added to the message. If the &%-t%& option is set,
2842 recipients are read from the headers in the normal way, and are shown in the
2843 &$recipients$& variable. Note that recipients cannot be given on the command
2844 line, because further arguments are taken as strings to expand (just like
2845 &%-be%&).
2846
2847 .vitem &%-bF%&&~<&'filename'&>
2848 .oindex "&%-bF%&"
2849 .cindex "system filter" "testing"
2850 .cindex "testing" "system filter"
2851 This option is the same as &%-bf%& except that it assumes that the filter being
2852 tested is a system filter. The additional commands that are available only in
2853 system filters are recognized.
2854
2855 .vitem &%-bf%&&~<&'filename'&>
2856 .oindex "&%-bf%&"
2857 .cindex "filter" "testing"
2858 .cindex "testing" "filter file"
2859 .cindex "forward file" "testing"
2860 .cindex "testing" "forward file"
2861 .cindex "Sieve filter" "testing"
2862 This option runs Exim in user filter testing mode; the file is the filter file
2863 to be tested, and a test message must be supplied on the standard input. If
2864 there are no message-dependent tests in the filter, an empty file can be
2865 supplied.
2866
2867 If you want to test a system filter file, use &%-bF%& instead of &%-bf%&. You
2868 can use both &%-bF%& and &%-bf%& on the same command, in order to test a system
2869 filter and a user filter in the same run. For example:
2870 .code
2871 exim -bF /system/filter -bf /user/filter </test/message
2872 .endd
2873 This is helpful when the system filter adds header lines or sets filter
2874 variables that are used by the user filter.
2875
2876 If the test filter file does not begin with one of the special lines
2877 .code
2878 # Exim filter
2879 # Sieve filter
2880 .endd
2881 it is taken to be a normal &_.forward_& file, and is tested for validity under
2882 that interpretation. See sections &<<SECTitenonfilred>>& to
2883 &<<SECTspecitredli>>& for a description of the possible contents of non-filter
2884 redirection lists.
2885
2886 The result of an Exim command that uses &%-bf%&, provided no errors are
2887 detected, is a list of the actions that Exim would try to take if presented
2888 with the message for real. More details of filter testing are given in the
2889 separate document entitled &'Exim's interfaces to mail filtering'&.
2890
2891 When testing a filter file,
2892 .cindex "&""From""& line"
2893 .cindex "envelope from"
2894 .cindex "envelope sender"
2895 .oindex "&%-f%&" "for filter testing"
2896 the envelope sender can be set by the &%-f%& option,
2897 or by a &"From&~"& line at the start of the test message. Various parameters
2898 that would normally be taken from the envelope recipient address of the message
2899 can be set by means of additional command line options (see the next four
2900 options).
2901
2902 .vitem &%-bfd%&&~<&'domain'&>
2903 .oindex "&%-bfd%&"
2904 .vindex "&$qualify_domain$&"
2905 This sets the domain of the recipient address when a filter file is being
2906 tested by means of the &%-bf%& option. The default is the value of
2907 &$qualify_domain$&.
2908
2909 .vitem &%-bfl%&&~<&'local&~part'&>
2910 .oindex "&%-bfl%&"
2911 This sets the local part of the recipient address when a filter file is being
2912 tested by means of the &%-bf%& option. The default is the username of the
2913 process that calls Exim. A local part should be specified with any prefix or
2914 suffix stripped, because that is how it appears to the filter when a message is
2915 actually being delivered.
2916
2917 .vitem &%-bfp%&&~<&'prefix'&>
2918 .oindex "&%-bfp%&"
2919 .cindex affix "filter testing"
2920 This sets the prefix of the local part of the recipient address when a filter
2921 file is being tested by means of the &%-bf%& option. The default is an empty
2922 prefix.
2923
2924 .vitem &%-bfs%&&~<&'suffix'&>
2925 .oindex "&%-bfs%&"
2926 .cindex affix "filter testing"
2927 This sets the suffix of the local part of the recipient address when a filter
2928 file is being tested by means of the &%-bf%& option. The default is an empty
2929 suffix.
2930
2931 .vitem &%-bh%&&~<&'IP&~address'&>
2932 .oindex "&%-bh%&"
2933 .cindex "testing" "incoming SMTP"
2934 .cindex "SMTP" "testing incoming"
2935 .cindex "testing" "relay control"
2936 .cindex "relaying" "testing configuration"
2937 .cindex "policy control" "testing"
2938 .cindex "debugging" "&%-bh%& option"
2939 This option runs a fake SMTP session as if from the given IP address, using the
2940 standard input and output. The IP address may include a port number at the end,
2941 after a full stop. For example:
2942 .code
2943 exim -bh 10.9.8.7.1234
2944 exim -bh fe80::a00:20ff:fe86:a061.5678
2945 .endd
2946 When an IPv6 address is given, it is converted into canonical form. In the case
2947 of the second example above, the value of &$sender_host_address$& after
2948 conversion to the canonical form is
2949 &`fe80:0000:0000:0a00:20ff:fe86:a061.5678`&.
2950
2951 Comments as to what is going on are written to the standard error file. These
2952 include lines beginning with &"LOG"& for anything that would have been logged.
2953 This facility is provided for testing configuration options for incoming
2954 messages, to make sure they implement the required policy. For example, you can
2955 test your relay controls using &%-bh%&.
2956
2957 &*Warning 1*&:
2958 .cindex "RFC 1413"
2959 You can test features of the configuration that rely on ident (RFC 1413)
2960 information by using the &%-oMt%& option. However, Exim cannot actually perform
2961 an ident callout when testing using &%-bh%& because there is no incoming SMTP
2962 connection.
2963
2964 &*Warning 2*&: Address verification callouts (see section &<<SECTcallver>>&)
2965 are also skipped when testing using &%-bh%&. If you want these callouts to
2966 occur, use &%-bhc%& instead.
2967
2968 Messages supplied during the testing session are discarded, and nothing is
2969 written to any of the real log files. There may be pauses when DNS (and other)
2970 lookups are taking place, and of course these may time out. The &%-oMi%& option
2971 can be used to specify a specific IP interface and port if this is important,
2972 and &%-oMaa%& and &%-oMai%& can be used to set parameters as if the SMTP
2973 session were authenticated.
2974
2975 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%& whose
2976 output just states whether a given recipient address from a given host is
2977 acceptable or not. See section &<<SECTcheckaccess>>&.
2978
2979 Features such as authentication and encryption, where the client input is not
2980 plain text, cannot easily be tested with &%-bh%&. Instead, you should use a
2981 specialized SMTP test program such as
2982 &url(https://www.jetmore.org/john/code/swaks/,swaks).
2983
2984 .vitem &%-bhc%&&~<&'IP&~address'&>
2985 .oindex "&%-bhc%&"
2986 This option operates in the same way as &%-bh%&, except that address
2987 verification callouts are performed if required. This includes consulting and
2988 updating the callout cache database.
2989
2990 .vitem &%-bi%&
2991 .oindex "&%-bi%&"
2992 .cindex "alias file" "building"
2993 .cindex "building alias file"
2994 .cindex "Sendmail compatibility" "&%-bi%& option"
2995 Sendmail interprets the &%-bi%& option as a request to rebuild its alias file.
2996 Exim does not have the concept of a single alias file, and so it cannot mimic
2997 this behaviour. However, calls to &_/usr/lib/sendmail_& with the &%-bi%& option
2998 tend to appear in various scripts such as NIS make files, so the option must be
2999 recognized.
3000
3001 If &%-bi%& is encountered, the command specified by the &%bi_command%&
3002 configuration option is run, under the uid and gid of the caller of Exim. If
3003 the &%-oA%& option is used, its value is passed to the command as an argument.
3004 The command set by &%bi_command%& may not contain arguments. The command can
3005 use the &'exim_dbmbuild'& utility, or some other means, to rebuild alias files
3006 if this is required. If the &%bi_command%& option is not set, calling Exim with
3007 &%-bi%& is a no-op.
3008
3009 . // Keep :help first, then the rest in alphabetical order
3010 .vitem &%-bI:help%&
3011 .oindex "&%-bI:help%&"
3012 .cindex "querying exim information"
3013 We shall provide various options starting &`-bI:`& for querying Exim for
3014 information.  The output of many of these will be intended for machine
3015 consumption.  This one is not.  The &%-bI:help%& option asks Exim for a
3016 synopsis of supported options beginning &`-bI:`&.  Use of any of these
3017 options shall cause Exim to exit after producing the requested output.
3018
3019 .vitem &%-bI:dscp%&
3020 .oindex "&%-bI:dscp%&"
3021 .cindex "DSCP" "values"
3022 This option causes Exim to emit an alphabetically sorted list of all
3023 recognised DSCP names.
3024
3025 .vitem &%-bI:sieve%&
3026 .oindex "&%-bI:sieve%&"
3027 .cindex "Sieve filter" "capabilities"
3028 This option causes Exim to emit an alphabetically sorted list of all supported
3029 Sieve protocol extensions on stdout, one per line.  This is anticipated to be
3030 useful for ManageSieve (RFC 5804) implementations, in providing that protocol's
3031 &`SIEVE`& capability response line.  As the precise list may depend upon
3032 compile-time build options, which this option will adapt to, this is the only
3033 way to guarantee a correct response.
3034
3035 .vitem &%-bm%&
3036 .oindex "&%-bm%&"
3037 .cindex "local message reception"
3038 This option runs an Exim receiving process that accepts an incoming,
3039 locally-generated message on the standard input. The recipients are given as the
3040 command arguments (except when &%-t%& is also present &-- see below). Each
3041 argument can be a comma-separated list of RFC 2822 addresses. This is the
3042 default option for selecting the overall action of an Exim call; it is assumed
3043 if no other conflicting option is present.
3044
3045 If any addresses in the message are unqualified (have no domain), they are
3046 qualified by the values of the &%qualify_domain%& or &%qualify_recipient%&
3047 options, as appropriate. The &%-bnq%& option (see below) provides a way of
3048 suppressing this for special cases.
3049
3050 Policy checks on the contents of local messages can be enforced by means of
3051 the non-SMTP ACL. See chapter &<<CHAPACL>>& for details.
3052
3053 .cindex "return code" "for &%-bm%&"
3054 The return code is zero if the message is successfully accepted. Otherwise, the
3055 action is controlled by the &%-oe%&&'x'& option setting &-- see below.
3056
3057 The format
3058 .cindex "message" "format"
3059 .cindex "format" "message"
3060 .cindex "&""From""& line"
3061 .cindex "UUCP" "&""From""& line"
3062 .cindex "Sendmail compatibility" "&""From""& line"
3063 of the message must be as defined in RFC 2822, except that, for
3064 compatibility with Sendmail and Smail, a line in one of the forms
3065 .code
3066 From sender Fri Jan  5 12:55 GMT 1997
3067 From sender Fri, 5 Jan 97 12:55:01
3068 .endd
3069 (with the weekday optional, and possibly with additional text after the date)
3070 is permitted to appear at the start of the message. There appears to be no
3071 authoritative specification of the format of this line. Exim recognizes it by
3072 matching against the regular expression defined by the &%uucp_from_pattern%&
3073 option, which can be changed if necessary.
3074
3075 .oindex "&%-f%&" "overriding &""From""& line"
3076 The specified sender is treated as if it were given as the argument to the
3077 &%-f%& option, but if a &%-f%& option is also present, its argument is used in
3078 preference to the address taken from the message. The caller of Exim must be a
3079 trusted user for the sender of a message to be set in this way.
3080
3081 .vitem &%-bmalware%&&~<&'filename'&>
3082 .oindex "&%-bmalware%&"
3083 .cindex "testing", "malware"
3084 .cindex "malware scan test"
3085 This debugging option causes Exim to scan the given file or directory
3086 (depending on the used scanner interface),
3087 using the malware scanning framework.  The option of &%av_scanner%& influences
3088 this option, so if &%av_scanner%&'s value is dependent upon an expansion then
3089 the expansion should have defaults which apply to this invocation.  ACLs are
3090 not invoked, so if &%av_scanner%& references an ACL variable then that variable
3091 will never be populated and &%-bmalware%& will fail.
3092
3093 Exim will have changed working directory before resolving the filename, so
3094 using fully qualified pathnames is advisable.  Exim will be running as the Exim
3095 user when it tries to open the file, rather than as the invoking user.
3096 This option requires admin privileges.
3097
3098 The &%-bmalware%& option will not be extended to be more generally useful,
3099 there are better tools for file-scanning.  This option exists to help
3100 administrators verify their Exim and AV scanner configuration.
3101
3102 .vitem &%-bnq%&
3103 .oindex "&%-bnq%&"
3104 .cindex "address qualification, suppressing"
3105 By default, Exim automatically qualifies unqualified addresses (those
3106 without domains) that appear in messages that are submitted locally (that
3107 is, not over TCP/IP). This qualification applies both to addresses in
3108 envelopes, and addresses in header lines. Sender addresses are qualified using
3109 &%qualify_domain%&, and recipient addresses using &%qualify_recipient%& (which
3110 defaults to the value of &%qualify_domain%&).
3111
3112 Sometimes, qualification is not wanted. For example, if &%-bS%& (batch SMTP) is
3113 being used to re-submit messages that originally came from remote hosts after
3114 content scanning, you probably do not want to qualify unqualified addresses in
3115 header lines. (Such lines will be present only if you have not enabled a header
3116 syntax check in the appropriate ACL.)
3117
3118 The &%-bnq%& option suppresses all qualification of unqualified addresses in
3119 messages that originate on the local host. When this is used, unqualified
3120 addresses in the envelope provoke errors (causing message rejection) and
3121 unqualified addresses in header lines are left alone.
3122
3123
3124 .vitem &%-bP%&
3125 .oindex "&%-bP%&"
3126 .cindex "configuration options" "extracting"
3127 .cindex "options" "configuration &-- extracting"
3128 If this option is given with no arguments, it causes the values of all Exim's
3129 main configuration options to be written to the standard output. The values
3130 of one or more specific options can be requested by giving their names as
3131 arguments, for example:
3132 .code
3133 exim -bP qualify_domain hold_domains
3134 .endd
3135 .cindex "hiding configuration option values"
3136 .cindex "configuration options" "hiding value of"
3137 .cindex "options" "hiding value of"
3138 However, any option setting that is preceded by the word &"hide"& in the
3139 configuration file is not shown in full, except to an admin user. For other
3140 users, the output is as in this example:
3141 .code
3142 mysql_servers = <value not displayable>
3143 .endd
3144 If &%config%& is given as an argument, the config is
3145 output, as it was parsed, any include file resolved, any comment removed.
3146
3147 If &%config_file%& is given as an argument, the name of the runtime
3148 configuration file is output. (&%configure_file%& works too, for
3149 backward compatibility.)
3150 If a list of configuration files was supplied, the value that is output here
3151 is the name of the file that was actually used.
3152
3153 .cindex "options" "hiding name of"
3154 If the &%-n%& flag is given, then for most modes of &%-bP%& operation the
3155 name will not be output.
3156
3157 .cindex "daemon" "process id (pid)"
3158 .cindex "pid (process id)" "of daemon"
3159 If &%log_file_path%& or &%pid_file_path%& are given, the names of the
3160 directories where log files and daemon pid files are written are output,
3161 respectively. If these values are unset, log files are written in a
3162 sub-directory of the spool directory called &%log%&, and the pid file is
3163 written directly into the spool directory.
3164
3165 If &%-bP%& is followed by a name preceded by &`+`&, for example,
3166 .code
3167 exim -bP +local_domains
3168 .endd
3169 it searches for a matching named list of any type (domain, host, address, or
3170 local part) and outputs what it finds.
3171
3172 .cindex "options" "router &-- extracting"
3173 .cindex "options" "transport &-- extracting"
3174 .cindex "options" "authenticator &-- extracting"
3175 If one of the words &%router%&, &%transport%&, or &%authenticator%& is given,
3176 followed by the name of an appropriate driver instance, the option settings for
3177 that driver are output. For example:
3178 .code
3179 exim -bP transport local_delivery
3180 .endd
3181 The generic driver options are output first, followed by the driver's private
3182 options. A list of the names of drivers of a particular type can be obtained by
3183 using one of the words &%router_list%&, &%transport_list%&, or
3184 &%authenticator_list%&, and a complete list of all drivers with their option
3185 settings can be obtained by using &%routers%&, &%transports%&, or
3186 &%authenticators%&.
3187
3188 .cindex "environment"
3189 If &%environment%& is given as an argument, the set of environment
3190 variables is output, line by line. Using the &%-n%& flag suppresses the value of the
3191 variables.
3192
3193 .cindex "options" "macro &-- extracting"
3194 If invoked by an admin user, then &%macro%&, &%macro_list%& and &%macros%&
3195 are available, similarly to the drivers.  Because macros are sometimes used
3196 for storing passwords, this option is restricted.
3197 The output format is one item per line.
3198 For the "-bP macro <name>" form, if no such macro is found
3199 the exit status will be nonzero.
3200
3201 .vitem &%-bp%&
3202 .oindex "&%-bp%&"
3203 .cindex "queue" "listing messages in"
3204 .cindex "listing" "messages in the queue"
3205 This option requests a listing of the contents of the mail queue on the
3206 standard output. If the &%-bp%& option is followed by a list of message ids,
3207 just those messages are listed. By default, this option can be used only by an
3208 admin user. However, the &%queue_list_requires_admin%& option can be set false
3209 to allow any user to see the queue.
3210
3211 Each message in the queue is displayed as in the following example:
3212 .code
3213 25m  2.9K 0t5C6f-0000c8-00 <alice@wonderland.fict.example>
3214           red.king@looking-glass.fict.example
3215           <other addresses>
3216 .endd
3217 .cindex "message" "size in queue listing"
3218 .cindex "size" "of message"
3219 The first line contains the length of time the message has been in the queue
3220 (in this case 25 minutes), the size of the message (2.9K), the unique local
3221 identifier for the message, and the message sender, as contained in the
3222 envelope. For bounce messages, the sender address is empty, and appears as
3223 &"<>"&. If the message was submitted locally by an untrusted user who overrode
3224 the default sender address, the user's login name is shown in parentheses
3225 before the sender address.
3226
3227 .cindex "frozen messages" "in queue listing"
3228 If the message is frozen (attempts to deliver it are suspended) then the text
3229 &"*** frozen ***"& is displayed at the end of this line.
3230
3231 The recipients of the message (taken from the envelope, not the headers) are
3232 displayed on subsequent lines. Those addresses to which the message has already
3233 been delivered are marked with the letter D. If an original address gets
3234 expanded into several addresses via an alias or forward file, the original is
3235 displayed with a D only when deliveries for all of its child addresses are
3236 complete.
3237
3238
3239 .vitem &%-bpa%&
3240 .oindex "&%-bpa%&"
3241 This option operates like &%-bp%&, but in addition it shows delivered addresses
3242 that were generated from the original top level address(es) in each message by
3243 alias or forwarding operations. These addresses are flagged with &"+D"& instead
3244 of just &"D"&.
3245
3246
3247 .vitem &%-bpc%&
3248 .oindex "&%-bpc%&"
3249 .cindex "queue" "count of messages on"
3250 This option counts the number of messages in the queue, and writes the total
3251 to the standard output. It is restricted to admin users, unless
3252 &%queue_list_requires_admin%& is set false.
3253
3254
3255 .vitem &%-bpr%&
3256 .oindex "&%-bpr%&"
3257 This option operates like &%-bp%&, but the output is not sorted into
3258 chronological order of message arrival. This can speed it up when there are
3259 lots of messages in the queue, and is particularly useful if the output is
3260 going to be post-processed in a way that doesn't need the sorting.
3261
3262 .vitem &%-bpra%&
3263 .oindex "&%-bpra%&"
3264 This option is a combination of &%-bpr%& and &%-bpa%&.
3265
3266 .vitem &%-bpru%&
3267 .oindex "&%-bpru%&"
3268 This option is a combination of &%-bpr%& and &%-bpu%&.
3269
3270
3271 .vitem &%-bpu%&
3272 .oindex "&%-bpu%&"
3273 This option operates like &%-bp%& but shows only undelivered top-level
3274 addresses for each message displayed. Addresses generated by aliasing or
3275 forwarding are not shown, unless the message was deferred after processing by a
3276 router with the &%one_time%& option set.
3277
3278
3279 .vitem &%-brt%&
3280 .oindex "&%-brt%&"
3281 .cindex "testing" "retry configuration"
3282 .cindex "retry" "configuration testing"
3283 This option is for testing retry rules, and it must be followed by up to three
3284 arguments. It causes Exim to look for a retry rule that matches the values
3285 and to write it to the standard output. For example:
3286 .code
3287 exim -brt bach.comp.mus.example
3288 Retry rule: *.comp.mus.example  F,2h,15m; F,4d,30m;
3289 .endd
3290 See chapter &<<CHAPretry>>& for a description of Exim's retry rules. The first
3291 argument, which is required, can be a complete address in the form
3292 &'local_part@domain'&, or it can be just a domain name. If the second argument
3293 contains a dot, it is interpreted as an optional second domain name; if no
3294 retry rule is found for the first argument, the second is tried. This ties in
3295 with Exim's behaviour when looking for retry rules for remote hosts &-- if no
3296 rule is found that matches the host, one that matches the mail domain is
3297 sought. Finally, an argument that is the name of a specific delivery error, as
3298 used in setting up retry rules, can be given. For example:
3299 .code
3300 exim -brt haydn.comp.mus.example quota_3d
3301 Retry rule: *@haydn.comp.mus.example quota_3d  F,1h,15m
3302 .endd
3303
3304 .vitem &%-brw%&
3305 .oindex "&%-brw%&"
3306 .cindex "testing" "rewriting"
3307 .cindex "rewriting" "testing"
3308 This option is for testing address rewriting rules, and it must be followed by
3309 a single argument, consisting of either a local part without a domain, or a
3310 complete address with a fully qualified domain. Exim outputs how this address
3311 would be rewritten for each possible place it might appear. See chapter
3312 &<<CHAPrewrite>>& for further details.
3313
3314 .vitem &%-bS%&
3315 .oindex "&%-bS%&"
3316 .cindex "SMTP" "batched incoming"
3317 .cindex "batched SMTP input"
3318 This option is used for batched SMTP input, which is an alternative interface
3319 for non-interactive local message submission. A number of messages can be
3320 submitted in a single run. However, despite its name, this is not really SMTP
3321 input. Exim reads each message's envelope from SMTP commands on the standard
3322 input, but generates no responses. If the caller is trusted, or
3323 &%untrusted_set_sender%& is set, the senders in the SMTP MAIL commands are
3324 believed; otherwise the sender is always the caller of Exim.
3325
3326 The message itself is read from the standard input, in SMTP format (leading
3327 dots doubled), terminated by a line containing just a single dot. An error is
3328 provoked if the terminating dot is missing. A further message may then follow.
3329
3330 As for other local message submissions, the contents of incoming batch SMTP
3331 messages can be checked using the non-SMTP ACL (see chapter &<<CHAPACL>>&).
3332 Unqualified addresses are automatically qualified using &%qualify_domain%& and
3333 &%qualify_recipient%&, as appropriate, unless the &%-bnq%& option is used.
3334
3335 Some other SMTP commands are recognized in the input. HELO and EHLO act
3336 as RSET; VRFY, EXPN, ETRN, and HELP act as NOOP;
3337 QUIT quits, ignoring the rest of the standard input.
3338
3339 .cindex "return code" "for &%-bS%&"
3340 If any error is encountered, reports are written to the standard output and
3341 error streams, and Exim gives up immediately. The return code is 0 if no error
3342 was detected; it is 1 if one or more messages were accepted before the error
3343 was detected; otherwise it is 2.
3344
3345 More details of input using batched SMTP are given in section
3346 &<<SECTincomingbatchedSMTP>>&.
3347
3348 .vitem &%-bs%&
3349 .oindex "&%-bs%&"
3350 .cindex "SMTP" "local input"
3351 .cindex "local SMTP input"
3352 This option causes Exim to accept one or more messages by reading SMTP commands
3353 on the standard input, and producing SMTP replies on the standard output. SMTP
3354 policy controls, as defined in ACLs (see chapter &<<CHAPACL>>&) are applied.
3355 Some user agents use this interface as a way of passing locally-generated
3356 messages to the MTA.
3357
3358 In
3359 .cindex "sender" "source of"
3360 this usage, if the caller of Exim is trusted, or &%untrusted_set_sender%& is
3361 set, the senders of messages are taken from the SMTP MAIL commands.
3362 Otherwise the content of these commands is ignored and the sender is set up as
3363 the calling user. Unqualified addresses are automatically qualified using
3364 &%qualify_domain%& and &%qualify_recipient%&, as appropriate, unless the
3365 &%-bnq%& option is used.
3366
3367 .cindex "inetd"
3368 The
3369 &%-bs%& option is also used to run Exim from &'inetd'&, as an alternative to
3370 using a listening daemon. Exim can distinguish the two cases by checking
3371 whether the standard input is a TCP/IP socket. When Exim is called from
3372 &'inetd'&, the source of the mail is assumed to be remote, and the comments
3373 above concerning senders and qualification do not apply. In this situation,
3374 Exim behaves in exactly the same way as it does when receiving a message via
3375 the listening daemon.
3376
3377 .vitem &%-bt%&
3378 .oindex "&%-bt%&"
3379 .cindex "testing" "addresses"
3380 .cindex "address" "testing"
3381 This option runs Exim in address testing mode, in which each argument is taken
3382 as a recipient address to be tested for deliverability. The results are
3383 written to the standard output. If a test fails, and the caller is not an admin
3384 user, no details of the failure are output, because these might contain
3385 sensitive information such as usernames and passwords for database lookups.
3386
3387 If no arguments are given, Exim runs in an interactive manner, prompting with a
3388 right angle bracket for addresses to be tested.
3389
3390 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3391 &[readline()]& function, because it is running as &'root'& and there are
3392 security issues.
3393
3394 Each address is handled as if it were the recipient address of a message
3395 (compare the &%-bv%& option). It is passed to the routers and the result is
3396 written to the standard output. However, any router that has
3397 &%no_address_test%& set is bypassed. This can make &%-bt%& easier to use for
3398 genuine routing tests if your first router passes everything to a scanner
3399 program.
3400
3401 .cindex "return code" "for &%-bt%&"
3402 The return code is 2 if any address failed outright; it is 1 if no address
3403 failed outright but at least one could not be resolved for some reason. Return
3404 code 0 is given only when all addresses succeed.
3405
3406 .cindex "duplicate addresses"
3407 &*Note*&: When actually delivering a message, Exim removes duplicate recipient
3408 addresses after routing is complete, so that only one delivery takes place.
3409 This does not happen when testing with &%-bt%&; the full results of routing are
3410 always shown.
3411
3412 &*Warning*&: &%-bt%& can only do relatively simple testing. If any of the
3413 routers in the configuration makes any tests on the sender address of a
3414 message,
3415 .oindex "&%-f%&" "for address testing"
3416 you can use the &%-f%& option to set an appropriate sender when running
3417 &%-bt%& tests. Without it, the sender is assumed to be the calling user at the
3418 default qualifying domain. However, if you have set up (for example) routers
3419 whose behaviour depends on the contents of an incoming message, you cannot test
3420 those conditions using &%-bt%&. The &%-N%& option provides a possible way of
3421 doing such tests.
3422
3423 .vitem &%-bV%&
3424 .oindex "&%-bV%&"
3425 .cindex "version number of Exim"
3426 This option causes Exim to write the current version number, compilation
3427 number, and compilation date of the &'exim'& binary to the standard output.
3428 It also lists the DBM library that is being used, the optional modules (such as
3429 specific lookup types), the drivers that are included in the binary, and the
3430 name of the runtime configuration file that is in use.
3431
3432 As part of its operation, &%-bV%& causes Exim to read and syntax check its
3433 configuration file. However, this is a static check only. It cannot check
3434 values that are to be expanded. For example, although a misspelt ACL verb is
3435 detected, an error in the verb's arguments is not. You cannot rely on &%-bV%&
3436 alone to discover (for example) all the typos in the configuration; some
3437 realistic testing is needed. The &%-bh%& and &%-N%& options provide more
3438 dynamic testing facilities.
3439
3440 .vitem &%-bv%&
3441 .oindex "&%-bv%&"
3442 .cindex "verifying address" "using &%-bv%&"
3443 .cindex "address" "verification"
3444 This option runs Exim in address verification mode, in which each argument is
3445 taken as a recipient address to be verified by the routers. (This does
3446 not involve any verification callouts). During normal operation, verification
3447 happens mostly as a consequence processing a &%verify%& condition in an ACL
3448 (see chapter &<<CHAPACL>>&). If you want to test an entire ACL, possibly
3449 including callouts, see the &%-bh%& and &%-bhc%& options.
3450
3451 If verification fails, and the caller is not an admin user, no details of the
3452 failure are output, because these might contain sensitive information such as
3453 usernames and passwords for database lookups.
3454
3455 If no arguments are given, Exim runs in an interactive manner, prompting with a
3456 right angle bracket for addresses to be verified.
3457
3458 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3459 &[readline()]& function, because it is running as &'exim'& and there are
3460 security issues.
3461
3462 Verification differs from address testing (the &%-bt%& option) in that routers
3463 that have &%no_verify%& set are skipped, and if the address is accepted by a
3464 router that has &%fail_verify%& set, verification fails. The address is
3465 verified as a recipient if &%-bv%& is used; to test verification for a sender
3466 address, &%-bvs%& should be used.
3467
3468 If the &%-v%& option is not set, the output consists of a single line for each
3469 address, stating whether it was verified or not, and giving a reason in the
3470 latter case. Without &%-v%&, generating more than one address by redirection
3471 causes verification to end successfully, without considering the generated
3472 addresses. However, if just one address is generated, processing continues,
3473 and the generated address must verify successfully for the overall verification
3474 to succeed.
3475
3476 When &%-v%& is set, more details are given of how the address has been handled,
3477 and in the case of address redirection, all the generated addresses are also
3478 considered. Verification may succeed for some and fail for others.
3479
3480 The
3481 .cindex "return code" "for &%-bv%&"
3482 return code is 2 if any address failed outright; it is 1 if no address
3483 failed outright but at least one could not be resolved for some reason. Return
3484 code 0 is given only when all addresses succeed.
3485
3486 If any of the routers in the configuration makes any tests on the sender
3487 address of a message, you should use the &%-f%& option to set an appropriate
3488 sender when running &%-bv%& tests. Without it, the sender is assumed to be the
3489 calling user at the default qualifying domain.
3490
3491 .vitem &%-bvs%&
3492 .oindex "&%-bvs%&"
3493 This option acts like &%-bv%&, but verifies the address as a sender rather
3494 than a recipient address. This affects any rewriting and qualification that
3495 might happen.
3496
3497 .vitem &%-bw%&
3498 .oindex "&%-bw%&"
3499 .cindex "daemon"
3500 .cindex "inetd"
3501 .cindex "inetd" "wait mode"
3502 This option runs Exim as a daemon, awaiting incoming SMTP connections,
3503 similarly to the &%-bd%& option.  All port specifications on the command-line
3504 and in the configuration file are ignored.  Queue-running may not be specified.
3505
3506 In this mode, Exim expects to be passed a socket as fd 0 (stdin) which is
3507 listening for connections.  This permits the system to start up and have
3508 inetd (or equivalent) listen on the SMTP ports, starting an Exim daemon for
3509 each port only when the first connection is received.
3510
3511 If the option is given as &%-bw%&<&'time'&> then the time is a timeout, after
3512 which the daemon will exit, which should cause inetd to listen once more.
3513
3514 .vitem &%-C%&&~<&'filelist'&>
3515 .oindex "&%-C%&"
3516 .cindex "configuration file" "alternate"
3517 .cindex "CONFIGURE_FILE"
3518 .cindex "alternate configuration file"
3519 This option causes Exim to find the runtime configuration file from the given
3520 list instead of from the list specified by the CONFIGURE_FILE
3521 compile-time setting. Usually, the list will consist of just a single filename,
3522 but it can be a colon-separated list of names. In this case, the first
3523 file that exists is used. Failure to open an existing file stops Exim from
3524 proceeding any further along the list, and an error is generated.
3525
3526 When this option is used by a caller other than root, and the list is different
3527 from the compiled-in list, Exim gives up its root privilege immediately, and
3528 runs with the real and effective uid and gid set to those of the caller.
3529 However, if a TRUSTED_CONFIG_LIST file is defined in &_Local/Makefile_&, that
3530 file contains a list of full pathnames, one per line, for configuration files
3531 which are trusted. Root privilege is retained for any configuration file so
3532 listed, as long as the caller is the Exim user (or the user specified in the
3533 CONFIGURE_OWNER option, if any), and as long as the configuration file is
3534 not writeable by inappropriate users or groups.
3535
3536 Leaving TRUSTED_CONFIG_LIST unset precludes the possibility of testing a
3537 configuration using &%-C%& right through message reception and delivery,
3538 even if the caller is root. The reception works, but by that time, Exim is
3539 running as the Exim user, so when it re-executes to regain privilege for the
3540 delivery, the use of &%-C%& causes privilege to be lost. However, root can
3541 test reception and delivery using two separate commands (one to put a message
3542 in the queue, using &%-odq%&, and another to do the delivery, using &%-M%&).
3543
3544 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
3545 prefix string with which any file named in a &%-C%& command line option
3546 must start. In addition, the filename must not contain the sequence &`/../`&.
3547 However, if the value of the &%-C%& option is identical to the value of
3548 CONFIGURE_FILE in &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as
3549 usual. There is no default setting for ALT_CONFIG_PREFIX; when it is
3550 unset, any filename can be used with &%-C%&.
3551
3552 ALT_CONFIG_PREFIX can be used to confine alternative configuration files
3553 to a directory to which only root has access. This prevents someone who has
3554 broken into the Exim account from running a privileged Exim with an arbitrary
3555 configuration file.
3556
3557 The &%-C%& facility is useful for ensuring that configuration files are
3558 syntactically correct, but cannot be used for test deliveries, unless the
3559 caller is privileged, or unless it is an exotic configuration that does not
3560 require privilege. No check is made on the owner or group of the files
3561 specified by this option.
3562
3563
3564 .vitem &%-D%&<&'macro'&>=<&'value'&>
3565 .oindex "&%-D%&"
3566 .cindex "macro" "setting on command line"
3567 This option can be used to override macro definitions in the configuration file
3568 (see section &<<SECTmacrodefs>>&). However, like &%-C%&, if it is used by an
3569 unprivileged caller, it causes Exim to give up its root privilege.
3570 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
3571 completely disabled, and its use causes an immediate error exit.
3572
3573 If WHITELIST_D_MACROS is defined in &_Local/Makefile_& then it should be a
3574 colon-separated list of macros which are considered safe and, if &%-D%& only
3575 supplies macros from this list, and the values are acceptable, then Exim will
3576 not give up root privilege if the caller is root, the Exim run-time user, or
3577 the CONFIGURE_OWNER, if set.  This is a transition mechanism and is expected
3578 to be removed in the future.  Acceptable values for the macros satisfy the
3579 regexp: &`^[A-Za-z0-9_/.-]*$`&
3580
3581 The entire option (including equals sign if present) must all be within one
3582 command line item. &%-D%& can be used to set the value of a macro to the empty
3583 string, in which case the equals sign is optional. These two commands are
3584 synonymous:
3585 .code
3586 exim -DABC  ...
3587 exim -DABC= ...
3588 .endd
3589 To include spaces in a macro definition item, quotes must be used. If you use
3590 quotes, spaces are permitted around the macro name and the equals sign. For
3591 example:
3592 .code
3593 exim '-D ABC = something' ...
3594 .endd
3595 &%-D%& may be repeated up to 10 times on a command line.
3596 Only macro names up to 22 letters long can be set.
3597
3598
3599 .vitem &%-d%&<&'debug&~options'&>
3600 .oindex "&%-d%&"
3601 .cindex "debugging" "list of selectors"
3602 .cindex "debugging" "&%-d%& option"
3603 This option causes debugging information to be written to the standard
3604 error stream. It is restricted to admin users because debugging output may show
3605 database queries that contain password information. Also, the details of users'
3606 filter files should be protected. If a non-admin user uses &%-d%&, Exim
3607 writes an error message to the standard error stream and exits with a non-zero
3608 return code.
3609
3610 When &%-d%& is used, &%-v%& is assumed. If &%-d%& is given on its own, a lot of
3611 standard debugging data is output. This can be reduced, or increased to include
3612 some more rarely needed information, by directly following &%-d%& with a string
3613 made up of names preceded by plus or minus characters. These add or remove sets
3614 of debugging data, respectively. For example, &%-d+filter%& adds filter
3615 debugging, whereas &%-d-all+filter%& selects only filter debugging. Note that
3616 no spaces are allowed in the debug setting. The available debugging categories
3617 are:
3618 .display
3619 &`acl            `& ACL interpretation
3620 &`auth           `& authenticators
3621 &`deliver        `& general delivery logic
3622 &`dns            `& DNS lookups (see also resolver)
3623 &`dnsbl          `& DNS black list (aka RBL) code
3624 &`exec           `& arguments for &[execv()]& calls
3625 &`expand         `& detailed debugging for string expansions
3626 &`filter         `& filter handling
3627 &`hints_lookup   `& hints data lookups
3628 &`host_lookup    `& all types of name-to-IP address handling
3629 &`ident          `& ident lookup
3630 &`interface      `& lists of local interfaces
3631 &`lists          `& matching things in lists
3632 &`load           `& system load checks
3633 &`local_scan     `& can be used by &[local_scan()]& (see chapter &&&
3634                     &<<CHAPlocalscan>>&)
3635 &`lookup         `& general lookup code and all lookups
3636 &`memory         `& memory handling
3637 &`noutf8         `& modifier: avoid UTF-8 line-drawing
3638 &`pid            `& modifier: add pid to debug output lines
3639 &`process_info   `& setting info for the process log
3640 &`queue_run      `& queue runs
3641 &`receive        `& general message reception logic
3642 &`resolver       `& turn on the DNS resolver's debugging output
3643 &`retry          `& retry handling
3644 &`rewrite        `& address rewriting
3645 &`route          `& address routing
3646 &`timestamp      `& modifier: add timestamp to debug output lines
3647 &`tls            `& TLS logic
3648 &`transport      `& transports
3649 &`uid            `& changes of uid/gid and looking up uid/gid
3650 &`verify         `& address verification logic
3651 &`all            `& almost all of the above (see below), and also &%-v%&
3652 .endd
3653 The &`all`& option excludes &`memory`& when used as &`+all`&, but includes it
3654 for &`-all`&. The reason for this is that &`+all`& is something that people
3655 tend to use when generating debug output for Exim maintainers. If &`+memory`&
3656 is included, an awful lot of output that is very rarely of interest is
3657 generated, so it now has to be explicitly requested. However, &`-all`& does
3658 turn everything off.
3659
3660 .cindex "resolver, debugging output"
3661 .cindex "DNS resolver, debugging output"
3662 The &`resolver`& option produces output only if the DNS resolver was compiled
3663 with DEBUG enabled. This is not the case in some operating systems. Also,
3664 unfortunately, debugging output from the DNS resolver is written to stdout
3665 rather than stderr.
3666
3667 The default (&%-d%& with no argument) omits &`expand`&, &`filter`&,
3668 &`interface`&, &`load`&, &`memory`&, &`pid`&, &`resolver`&, and &`timestamp`&.
3669 However, the &`pid`& selector is forced when debugging is turned on for a
3670 daemon, which then passes it on to any re-executed Exims. Exim also
3671 automatically adds the pid to debug lines when several remote deliveries are
3672 run in parallel.
3673
3674 The &`timestamp`& selector causes the current time to be inserted at the start
3675 of all debug output lines. This can be useful when trying to track down delays
3676 in processing.
3677
3678 .cindex debugging "UTF-8 in"
3679 .cindex UTF-8 "in debug output"
3680 The &`noutf8`& selector disables the use of
3681 UTF-8 line-drawing characters to group related information.
3682 When disabled. ascii-art is used instead.
3683 Using the &`+all`& option does not set this modifier,
3684
3685 If the &%debug_print%& option is set in any driver, it produces output whenever
3686 any debugging is selected, or if &%-v%& is used.
3687
3688 .vitem &%-dd%&<&'debug&~options'&>
3689 .oindex "&%-dd%&"
3690 This option behaves exactly like &%-d%& except when used on a command that
3691 starts a daemon process. In that case, debugging is turned off for the
3692 subprocesses that the daemon creates. Thus, it is useful for monitoring the
3693 behaviour of the daemon without creating as much output as full debugging does.
3694
3695 .vitem &%-dropcr%&
3696 .oindex "&%-dropcr%&"
3697 This is an obsolete option that is now a no-op. It used to affect the way Exim
3698 handled CR and LF characters in incoming messages. What happens now is
3699 described in section &<<SECTlineendings>>&.
3700
3701 .vitem &%-E%&
3702 .oindex "&%-E%&"
3703 .cindex "bounce message" "generating"
3704 This option specifies that an incoming message is a locally-generated delivery
3705 failure report. It is used internally by Exim when handling delivery failures
3706 and is not intended for external use. Its only effect is to stop Exim
3707 generating certain messages to the postmaster, as otherwise message cascades
3708 could occur in some situations. As part of the same option, a message id may
3709 follow the characters &%-E%&. If it does, the log entry for the receipt of the
3710 new message contains the id, following &"R="&, as a cross-reference.
3711
3712 .vitem &%-e%&&'x'&
3713 .oindex "&%-e%&&'x'&"
3714 There are a number of Sendmail options starting with &%-oe%& which seem to be
3715 called by various programs without the leading &%o%& in the option. For
3716 example, the &%vacation%& program uses &%-eq%&. Exim treats all options of the
3717 form &%-e%&&'x'& as synonymous with the corresponding &%-oe%&&'x'& options.
3718
3719 .vitem &%-F%&&~<&'string'&>
3720 .oindex "&%-F%&"
3721 .cindex "sender" "name"
3722 .cindex "name" "of sender"
3723 This option sets the sender's full name for use when a locally-generated
3724 message is being accepted. In the absence of this option, the user's &'gecos'&
3725 entry from the password data is used. As users are generally permitted to alter
3726 their &'gecos'& entries, no security considerations are involved. White space
3727 between &%-F%& and the <&'string'&> is optional.
3728
3729 .vitem &%-f%&&~<&'address'&>
3730 .oindex "&%-f%&"
3731 .cindex "sender" "address"
3732 .cindex "address" "sender"
3733 .cindex "trusted users"
3734 .cindex "envelope from"
3735 .cindex "envelope sender"
3736 .cindex "user" "trusted"
3737 This option sets the address of the envelope sender of a locally-generated
3738 message (also known as the return path). The option can normally be used only
3739 by a trusted user, but &%untrusted_set_sender%& can be set to allow untrusted
3740 users to use it.
3741
3742 Processes running as root or the Exim user are always trusted. Other
3743 trusted users are defined by the &%trusted_users%& or &%trusted_groups%&
3744 options. In the absence of &%-f%&, or if the caller is not trusted, the sender
3745 of a local message is set to the caller's login name at the default qualify
3746 domain.
3747
3748 There is one exception to the restriction on the use of &%-f%&: an empty sender
3749 can be specified by any user, trusted or not, to create a message that can
3750 never provoke a bounce. An empty sender can be specified either as an empty
3751 string, or as a pair of angle brackets with nothing between them, as in these
3752 examples of shell commands:
3753 .code
3754 exim -f '<>' user@domain
3755 exim -f "" user@domain
3756 .endd
3757 In addition, the use of &%-f%& is not restricted when testing a filter file
3758 with &%-bf%& or when testing or verifying addresses using the &%-bt%& or
3759 &%-bv%& options.
3760
3761 Allowing untrusted users to change the sender address does not of itself make
3762 it possible to send anonymous mail. Exim still checks that the &'From:'& header
3763 refers to the local user, and if it does not, it adds a &'Sender:'& header,
3764 though this can be overridden by setting &%no_local_from_check%&.
3765
3766 White
3767 .cindex "&""From""& line"
3768 space between &%-f%& and the <&'address'&> is optional (that is, they can be
3769 given as two arguments or one combined argument). The sender of a
3770 locally-generated message can also be set (when permitted) by an initial
3771 &"From&~"& line in the message &-- see the description of &%-bm%& above &-- but
3772 if &%-f%& is also present, it overrides &"From&~"&.
3773
3774 .vitem &%-G%&
3775 .oindex "&%-G%&"
3776 .cindex "submission fixups, suppressing (command-line)"
3777 This option is equivalent to an ACL applying:
3778 .code
3779 control = suppress_local_fixups
3780 .endd
3781 for every message received.  Note that Sendmail will complain about such
3782 bad formatting, where Exim silently just does not fix it up.  This may change
3783 in future.
3784
3785 As this affects audit information, the caller must be a trusted user to use
3786 this option.
3787
3788 .vitem &%-h%&&~<&'number'&>
3789 .oindex "&%-h%&"
3790 .cindex "Sendmail compatibility" "&%-h%& option ignored"
3791 This option is accepted for compatibility with Sendmail, but has no effect. (In
3792 Sendmail it overrides the &"hop count"& obtained by counting &'Received:'&
3793 headers.)
3794
3795 .vitem &%-i%&
3796 .oindex "&%-i%&"
3797 .cindex "Solaris" "&'mail'& command"
3798 .cindex "dot" "in incoming non-SMTP message"
3799 This option, which has the same effect as &%-oi%&, specifies that a dot on a
3800 line by itself should not terminate an incoming, non-SMTP message. I can find
3801 no documentation for this option in Solaris 2.4 Sendmail, but the &'mailx'&
3802 command in Solaris 2.4 uses it. See also &%-ti%&.
3803
3804 .vitem &%-L%&&~<&'tag'&>
3805 .oindex "&%-L%&"
3806 .cindex "syslog" "process name; set with flag"
3807 This option is equivalent to setting &%syslog_processname%& in the config
3808 file and setting &%log_file_path%& to &`syslog`&.
3809 Its use is restricted to administrators.  The configuration file has to be
3810 read and parsed, to determine access rights, before this is set and takes
3811 effect, so early configuration file errors will not honour this flag.
3812
3813 The tag should not be longer than 32 characters.
3814
3815 .vitem &%-M%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3816 .oindex "&%-M%&"
3817 .cindex "forcing delivery"
3818 .cindex "delivery" "forcing attempt"
3819 .cindex "frozen messages" "forcing delivery"
3820 This option requests Exim to run a delivery attempt on each message in turn. If
3821 any of the messages are frozen, they are automatically thawed before the
3822 delivery attempt. The settings of &%queue_domains%&, &%queue_smtp_domains%&,
3823 and &%hold_domains%& are ignored.
3824
3825 Retry
3826 .cindex "hints database" "overriding retry hints"
3827 hints for any of the addresses are overridden &-- Exim tries to deliver even if
3828 the normal retry time has not yet been reached. This option requires the caller
3829 to be an admin user. However, there is an option called &%prod_requires_admin%&
3830 which can be set false to relax this restriction (and also the same requirement
3831 for the &%-q%&, &%-R%&, and &%-S%& options).
3832
3833 The deliveries happen synchronously, that is, the original Exim process does
3834 not terminate until all the delivery attempts have finished. No output is
3835 produced unless there is a serious error. If you want to see what is happening,
3836 use the &%-v%& option as well, or inspect Exim's main log.
3837
3838 .vitem &%-Mar%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3839 .oindex "&%-Mar%&"
3840 .cindex "message" "adding recipients"
3841 .cindex "recipient" "adding"
3842 This option requests Exim to add the addresses to the list of recipients of the
3843 message (&"ar"& for &"add recipients"&). The first argument must be a message
3844 id, and the remaining ones must be email addresses. However, if the message is
3845 active (in the middle of a delivery attempt), it is not altered. This option
3846 can be used only by an admin user.
3847
3848 .vitem "&%-MC%&&~<&'transport'&>&~<&'hostname'&>&~<&'sequence&~number'&>&&&
3849         &~<&'message&~id'&>"
3850 .oindex "&%-MC%&"
3851 .cindex "SMTP" "passed connection"
3852 .cindex "SMTP" "multiple deliveries"
3853 .cindex "multiple SMTP deliveries"
3854 This option is not intended for use by external callers. It is used internally
3855 by Exim to invoke another instance of itself to deliver a waiting message using
3856 an existing SMTP connection, which is passed as the standard input. Details are
3857 given in chapter &<<CHAPSMTP>>&. This must be the final option, and the caller
3858 must be root or the Exim user in order to use it.
3859
3860 .vitem &%-MCA%&
3861 .oindex "&%-MCA%&"
3862 This option is not intended for use by external callers. It is used internally
3863 by Exim in conjunction with the &%-MC%& option. It signifies that the
3864 connection to the remote host has been authenticated.
3865
3866 .vitem &%-MCD%&
3867 .oindex "&%-MCD%&"
3868 This option is not intended for use by external callers. It is used internally
3869 by Exim in conjunction with the &%-MC%& option. It signifies that the
3870 remote host supports the ESMTP &_DSN_& extension.
3871
3872 .vitem &%-MCd%&
3873 .oindex "&%-MCd%&"
3874 This option is not intended for use by external callers. It is used internally
3875 by Exim in conjunction with the &%-d%& option
3876 to pass on an information string on the purpose of the process.
3877
3878 .vitem &%-MCG%&&~<&'queue&~name'&>
3879 .oindex "&%-MCG%&"
3880 This option is not intended for use by external callers. It is used internally
3881 by Exim in conjunction with the &%-MC%& option. It signifies that an
3882 alternate queue is used, named by the following argument.
3883
3884 .vitem &%-MCK%&
3885 .oindex "&%-MCK%&"
3886 This option is not intended for use by external callers. It is used internally
3887 by Exim in conjunction with the &%-MC%& option. It signifies that a
3888 remote host supports the ESMTP &_CHUNKING_& extension.
3889
3890 .vitem &%-MCP%&
3891 .oindex "&%-MCP%&"
3892 This option is not intended for use by external callers. It is used internally
3893 by Exim in conjunction with the &%-MC%& option. It signifies that the server to
3894 which Exim is connected supports pipelining.
3895
3896 .vitem &%-MCQ%&&~<&'process&~id'&>&~<&'pipe&~fd'&>
3897 .oindex "&%-MCQ%&"
3898 This option is not intended for use by external callers. It is used internally
3899 by Exim in conjunction with the &%-MC%& option when the original delivery was
3900 started by a queue runner. It passes on the process id of the queue runner,
3901 together with the file descriptor number of an open pipe. Closure of the pipe
3902 signals the final completion of the sequence of processes that are passing
3903 messages through the same SMTP connection.
3904
3905 .new
3906 .vitem &%-MCq%&&~<&'recipient&~address'&>&~<&'size'&>
3907 .oindex "&%-MCq%&"
3908 This option is not intended for use by external callers. It is used internally
3909 by Exim to implement quota checking for local users.
3910 .wen
3911
3912 .vitem &%-MCS%&
3913 .oindex "&%-MCS%&"
3914 This option is not intended for use by external callers. It is used internally
3915 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3916 ESMTP SIZE option should be used on messages delivered down the existing
3917 connection.
3918
3919 .vitem &%-MCT%&
3920 .oindex "&%-MCT%&"
3921 This option is not intended for use by external callers. It is used internally
3922 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3923 host to which Exim is connected supports TLS encryption.
3924
3925 .vitem &%-MCt%&&~<&'IP&~address'&>&~<&'port'&>&~<&'cipher'&>
3926 .oindex "&%-MCt%&"
3927 This option is not intended for use by external callers. It is used internally
3928 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3929 connection is being proxied by a parent process for handling TLS encryption.
3930 The arguments give the local address and port being proxied, and the TLS cipher.
3931
3932 .vitem &%-Mc%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3933 .oindex "&%-Mc%&"
3934 .cindex "hints database" "not overridden by &%-Mc%&"
3935 .cindex "delivery" "manually started &-- not forced"
3936 This option requests Exim to run a delivery attempt on each message, in turn,
3937 but unlike the &%-M%& option, it does check for retry hints, and respects any
3938 that are found. This option is not very useful to external callers. It is
3939 provided mainly for internal use by Exim when it needs to re-invoke itself in
3940 order to regain root privilege for a delivery (see chapter &<<CHAPsecurity>>&).
3941 However, &%-Mc%& can be useful when testing, in order to run a delivery that
3942 respects retry times and other options such as &%hold_domains%& that are
3943 overridden when &%-M%& is used. Such a delivery does not count as a queue run.
3944 If you want to run a specific delivery as if in a queue run, you should use
3945 &%-q%& with a message id argument. A distinction between queue run deliveries
3946 and other deliveries is made in one or two places.
3947
3948 .vitem &%-Mes%&&~<&'message&~id'&>&~<&'address'&>
3949 .oindex "&%-Mes%&"
3950 .cindex "message" "changing sender"
3951 .cindex "sender" "changing"
3952 This option requests Exim to change the sender address in the message to the
3953 given address, which must be a fully qualified address or &"<>"& (&"es"& for
3954 &"edit sender"&). There must be exactly two arguments. The first argument must
3955 be a message id, and the second one an email address. However, if the message
3956 is active (in the middle of a delivery attempt), its status is not altered.
3957 This option can be used only by an admin user.
3958
3959 .vitem &%-Mf%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3960 .oindex "&%-Mf%&"
3961 .cindex "freezing messages"
3962 .cindex "message" "manually freezing"
3963 This option requests Exim to mark each listed message as &"frozen"&. This
3964 prevents any delivery attempts taking place until the message is &"thawed"&,
3965 either manually or as a result of the &%auto_thaw%& configuration option.
3966 However, if any of the messages are active (in the middle of a delivery
3967 attempt), their status is not altered. This option can be used only by an admin
3968 user.
3969
3970 .vitem &%-Mg%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3971 .oindex "&%-Mg%&"
3972 .cindex "giving up on messages"
3973 .cindex "message" "abandoning delivery attempts"
3974 .cindex "delivery" "abandoning further attempts"
3975 This option requests Exim to give up trying to deliver the listed messages,
3976 including any that are frozen. However, if any of the messages are active,
3977 their status is not altered. For non-bounce messages, a delivery error message
3978 is sent to the sender, containing the text &"cancelled by administrator"&.
3979 Bounce messages are just discarded. This option can be used only by an admin
3980 user.
3981
3982 .vitem &%-MG%&&~<&'queue&~name'&>&~<&'message&~id'&>&~<&'message&~id'&>&~...
3983 .oindex "&%-MG%&"
3984 .cindex queue named
3985 .cindex "named queues" "moving messages"
3986 .cindex "queue" "moving messages"
3987 This option requests that each listed message be moved from its current
3988 queue to the given named queue.
3989 The destination queue name argument is required, but can be an empty
3990 string to define the default queue.
3991 If the messages are not currently located in the default queue,
3992 a &%-qG<name>%& option will be required to define the source queue.
3993
3994 .vitem &%-Mmad%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3995 .oindex "&%-Mmad%&"
3996 .cindex "delivery" "cancelling all"
3997 This option requests Exim to mark all the recipient addresses in the messages
3998 as already delivered (&"mad"& for &"mark all delivered"&). However, if any
3999 message is active (in the middle of a delivery attempt), its status is not
4000 altered. This option can be used only by an admin user.
4001
4002 .vitem &%-Mmd%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
4003 .oindex "&%-Mmd%&"
4004 .cindex "delivery" "cancelling by address"
4005 .cindex "recipient" "removing"
4006 .cindex "removing recipients"
4007 This option requests Exim to mark the given addresses as already delivered
4008 (&"md"& for &"mark delivered"&). The first argument must be a message id, and
4009 the remaining ones must be email addresses. These are matched to recipient
4010 addresses in the message in a case-sensitive manner. If the message is active
4011 (in the middle of a delivery attempt), its status is not altered. This option
4012 can be used only by an admin user.
4013
4014 .vitem &%-Mrm%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
4015 .oindex "&%-Mrm%&"
4016 .cindex "removing messages"
4017 .cindex "abandoning mail"
4018 .cindex "message" "manually discarding"
4019 This option requests Exim to remove the given messages from the queue. No
4020 bounce messages are sent; each message is simply forgotten. However, if any of
4021 the messages are active, their status is not altered. This option can be used
4022 only by an admin user or by the user who originally caused the message to be
4023 placed in the queue.
4024
4025 . .new
4026 . .vitem &%-MS%&
4027 . .oindex "&%-MS%&"
4028 . .cindex REQUIRETLS
4029 . This option is used to request REQUIRETLS processing on the message.
4030 . It is used internally by Exim in conjunction with -E when generating
4031 . a bounce message.
4032 . .wen
4033
4034 .vitem &%-Mset%&&~<&'message&~id'&>
4035 .oindex "&%-Mset%&"
4036 .cindex "testing" "string expansion"
4037 .cindex "expansion" "testing"
4038 This option is useful only in conjunction with &%-be%& (that is, when testing
4039 string expansions). Exim loads the given message from its spool before doing
4040 the test expansions, thus setting message-specific variables such as
4041 &$message_size$& and the header variables. The &$recipients$& variable is made
4042 available. This feature is provided to make it easier to test expansions that
4043 make use of these variables. However, this option can be used only by an admin
4044 user. See also &%-bem%&.
4045
4046 .vitem &%-Mt%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
4047 .oindex "&%-Mt%&"
4048 .cindex "thawing messages"
4049 .cindex "unfreezing messages"
4050 .cindex "frozen messages" "thawing"
4051 .cindex "message" "thawing frozen"
4052 This option requests Exim to &"thaw"& any of the listed messages that are
4053 &"frozen"&, so that delivery attempts can resume. However, if any of the
4054 messages are active, their status is not altered. This option can be used only
4055 by an admin user.
4056
4057 .vitem &%-Mvb%&&~<&'message&~id'&>
4058 .oindex "&%-Mvb%&"
4059 .cindex "listing" "message body"
4060 .cindex "message" "listing body of"
4061 This option causes the contents of the message body (-D) spool file to be
4062 written to the standard output. This option can be used only by an admin user.
4063
4064 .vitem &%-Mvc%&&~<&'message&~id'&>
4065 .oindex "&%-Mvc%&"
4066 .cindex "message" "listing in RFC 2822 format"
4067 .cindex "listing" "message in RFC 2822 format"
4068 This option causes a copy of the complete message (header lines plus body) to
4069 be written to the standard output in RFC 2822 format. This option can be used
4070 only by an admin user.
4071
4072 .vitem &%-Mvh%&&~<&'message&~id'&>
4073 .oindex "&%-Mvh%&"
4074 .cindex "listing" "message headers"
4075 .cindex "header lines" "listing"
4076 .cindex "message" "listing header lines"
4077 This option causes the contents of the message headers (-H) spool file to be
4078 written to the standard output. This option can be used only by an admin user.
4079
4080 .vitem &%-Mvl%&&~<&'message&~id'&>
4081 .oindex "&%-Mvl%&"
4082 .cindex "listing" "message log"
4083 .cindex "message" "listing message log"
4084 This option causes the contents of the message log spool file to be written to
4085 the standard output. This option can be used only by an admin user.
4086
4087 .vitem &%-m%&
4088 .oindex "&%-m%&"
4089 This is apparently a synonym for &%-om%& that is accepted by Sendmail, so Exim
4090 treats it that way too.
4091
4092 .vitem &%-N%&
4093 .oindex "&%-N%&"
4094 .cindex "debugging" "&%-N%& option"
4095 .cindex "debugging" "suppressing delivery"
4096 This is a debugging option that inhibits delivery of a message at the transport
4097 level. It implies &%-v%&. Exim goes through many of the motions of delivery &--
4098 it just doesn't actually transport the message, but instead behaves as if it
4099 had successfully done so. However, it does not make any updates to the retry
4100 database, and the log entries for deliveries are flagged with &"*>"& rather
4101 than &"=>"&.
4102
4103 Because &%-N%& discards any message to which it applies, only root or the Exim
4104 user are allowed to use it with &%-bd%&, &%-q%&, &%-R%& or &%-M%&. In other
4105 words, an ordinary user can use it only when supplying an incoming message to
4106 which it will apply. Although transportation never fails when &%-N%& is set, an
4107 address may be deferred because of a configuration problem on a transport, or a
4108 routing problem. Once &%-N%& has been used for a delivery attempt, it sticks to
4109 the message, and applies to any subsequent delivery attempts that may happen
4110 for that message.
4111
4112 .vitem &%-n%&
4113 .oindex "&%-n%&"
4114 This option is interpreted by Sendmail to mean &"no aliasing"&.
4115 For normal modes of operation, it is ignored by Exim.
4116 When combined with &%-bP%& it makes the output more terse (suppresses
4117 option names, environment values and config pretty printing).
4118
4119 .vitem &%-O%&&~<&'data'&>
4120 .oindex "&%-O%&"
4121 This option is interpreted by Sendmail to mean &`set option`&. It is ignored by
4122 Exim.
4123
4124 .vitem &%-oA%&&~<&'file&~name'&>
4125 .oindex "&%-oA%&"
4126 .cindex "Sendmail compatibility" "&%-oA%& option"
4127 This option is used by Sendmail in conjunction with &%-bi%& to specify an
4128 alternative alias filename. Exim handles &%-bi%& differently; see the
4129 description above.
4130
4131 .vitem &%-oB%&&~<&'n'&>
4132 .oindex "&%-oB%&"
4133 .cindex "SMTP" "passed connection"
4134 .cindex "SMTP" "multiple deliveries"
4135 .cindex "multiple SMTP deliveries"
4136 This is a debugging option which limits the maximum number of messages that can
4137 be delivered down one SMTP connection, overriding the value set in any &(smtp)&
4138 transport. If <&'n'&> is omitted, the limit is set to 1.
4139
4140 .vitem &%-odb%&
4141 .oindex "&%-odb%&"
4142 .cindex "background delivery"
4143 .cindex "delivery" "in the background"
4144 This option applies to all modes in which Exim accepts incoming messages,
4145 including the listening daemon. It requests &"background"& delivery of such
4146 messages, which means that the accepting process automatically starts a
4147 delivery process for each message received, but does not wait for the delivery
4148 processes to finish.
4149
4150 When all the messages have been received, the reception process exits,
4151 leaving the delivery processes to finish in their own time. The standard output
4152 and error streams are closed at the start of each delivery process.
4153 This is the default action if none of the &%-od%& options are present.
4154
4155 If one of the queueing options in the configuration file
4156 (&%queue_only%& or &%queue_only_file%&, for example) is in effect, &%-odb%&
4157 overrides it if &%queue_only_override%& is set true, which is the default
4158 setting. If &%queue_only_override%& is set false, &%-odb%& has no effect.
4159
4160 .vitem &%-odf%&
4161 .oindex "&%-odf%&"
4162 .cindex "foreground delivery"
4163 .cindex "delivery" "in the foreground"
4164 This option requests &"foreground"& (synchronous) delivery when Exim has
4165 accepted a locally-generated message. (For the daemon it is exactly the same as
4166 &%-odb%&.) A delivery process is automatically started to deliver the message,
4167 and Exim waits for it to complete before proceeding.
4168
4169 The original Exim reception process does not finish until the delivery
4170 process for the final message has ended. The standard error stream is left open
4171 during deliveries.
4172
4173 However, like &%-odb%&, this option has no effect if &%queue_only_override%& is
4174 false and one of the queueing options in the configuration file is in effect.
4175
4176 If there is a temporary delivery error during foreground delivery, the
4177 message is left in the queue for later delivery, and the original reception
4178 process exits. See chapter &<<CHAPnonqueueing>>& for a way of setting up a
4179 restricted configuration that never queues messages.
4180
4181
4182 .vitem &%-odi%&
4183 .oindex "&%-odi%&"
4184 This option is synonymous with &%-odf%&. It is provided for compatibility with
4185 Sendmail.
4186
4187 .vitem &%-odq%&
4188 .oindex "&%-odq%&"
4189 .cindex "non-immediate delivery"
4190 .cindex "delivery" "suppressing immediate"
4191 .cindex "queueing incoming messages"
4192 This option applies to all modes in which Exim accepts incoming messages,
4193 including the listening daemon. It specifies that the accepting process should
4194 not automatically start a delivery process for each message received. Messages
4195 are placed in the queue, and remain there until a subsequent queue runner
4196 process encounters them. There are several configuration options (such as
4197 &%queue_only%&) that can be used to queue incoming messages under certain
4198 conditions. This option overrides all of them and also &%-odqs%&. It always
4199 forces queueing.
4200
4201 .vitem &%-odqs%&
4202 .oindex "&%-odqs%&"
4203 .cindex "SMTP" "delaying delivery"
4204 .cindex "first pass routing"
4205 This option is a hybrid between &%-odb%&/&%-odi%& and &%-odq%&.
4206 However, like &%-odb%& and &%-odi%&, this option has no effect if
4207 &%queue_only_override%& is false and one of the queueing options in the
4208 configuration file is in effect.
4209
4210 When &%-odqs%& does operate, a delivery process is started for each incoming
4211 message, in the background by default, but in the foreground if &%-odi%& is
4212 also present. The recipient addresses are routed, and local deliveries are done
4213 in the normal way. However, if any SMTP deliveries are required, they are not
4214 done at this time, so the message remains in the queue until a subsequent queue
4215 runner process encounters it. Because routing was done, Exim knows which
4216 messages are waiting for which hosts, and so a number of messages for the same
4217 host can be sent in a single SMTP connection. The &%queue_smtp_domains%&
4218 configuration option has the same effect for specific domains. See also the
4219 &%-qq%& option.
4220
4221 .vitem &%-oee%&
4222 .oindex "&%-oee%&"
4223 .cindex "error" "reporting"
4224 If an error is detected while a non-SMTP message is being received (for
4225 example, a malformed address), the error is reported to the sender in a mail
4226 message.
4227
4228 .cindex "return code" "for &%-oee%&"
4229 Provided
4230 this error message is successfully sent, the Exim receiving process
4231 exits with a return code of zero. If not, the return code is 2 if the problem
4232 is that the original message has no recipients, or 1 for any other error.
4233 This is the default &%-oe%&&'x'& option if Exim is called as &'rmail'&.
4234
4235 .vitem &%-oem%&
4236 .oindex "&%-oem%&"
4237 .cindex "error" "reporting"
4238 .cindex "return code" "for &%-oem%&"
4239 This is the same as &%-oee%&, except that Exim always exits with a non-zero
4240 return code, whether or not the error message was successfully sent.
4241 This is the default &%-oe%&&'x'& option, unless Exim is called as &'rmail'&.
4242
4243 .vitem &%-oep%&
4244 .oindex "&%-oep%&"
4245 .cindex "error" "reporting"
4246 If an error is detected while a non-SMTP message is being received, the
4247 error is reported by writing a message to the standard error file (stderr).
4248 .cindex "return code" "for &%-oep%&"
4249 The return code is 1 for all errors.
4250
4251 .vitem &%-oeq%&
4252 .oindex "&%-oeq%&"
4253 .cindex "error" "reporting"
4254 This option is supported for compatibility with Sendmail, but has the same
4255 effect as &%-oep%&.
4256
4257 .vitem &%-oew%&
4258 .oindex "&%-oew%&"
4259 .cindex "error" "reporting"
4260 This option is supported for compatibility with Sendmail, but has the same
4261 effect as &%-oem%&.
4262
4263 .vitem &%-oi%&
4264 .oindex "&%-oi%&"
4265 .cindex "dot" "in incoming non-SMTP message"
4266 This option, which has the same effect as &%-i%&, specifies that a dot on a
4267 line by itself should not terminate an incoming, non-SMTP message. Otherwise, a
4268 single dot does terminate, though Exim does no special processing for other
4269 lines that start with a dot. This option is set by default if Exim is called as
4270 &'rmail'&. See also &%-ti%&.
4271
4272 .vitem &%-oitrue%&
4273 .oindex "&%-oitrue%&"
4274 This option is treated as synonymous with &%-oi%&.
4275
4276 .vitem &%-oMa%&&~<&'host&~address'&>
4277 .oindex "&%-oMa%&"
4278 .cindex "sender" "host address, specifying for local message"
4279 A number of options starting with &%-oM%& can be used to set values associated
4280 with remote hosts on locally-submitted messages (that is, messages not received
4281 over TCP/IP). These options can be used by any caller in conjunction with the
4282 &%-bh%&, &%-be%&, &%-bf%&, &%-bF%&, &%-bt%&, or &%-bv%& testing options. In
4283 other circumstances, they are ignored unless the caller is trusted.
4284
4285 The &%-oMa%& option sets the sender host address. This may include a port
4286 number at the end, after a full stop (period). For example:
4287 .code
4288 exim -bs -oMa 10.9.8.7.1234
4289 .endd
4290 An alternative syntax is to enclose the IP address in square brackets,
4291 followed by a colon and the port number:
4292 .code
4293 exim -bs -oMa [10.9.8.7]:1234
4294 .endd
4295 The IP address is placed in the &$sender_host_address$& variable, and the
4296 port, if present, in &$sender_host_port$&. If both &%-oMa%& and &%-bh%&
4297 are present on the command line, the sender host IP address is taken from
4298 whichever one is last.
4299
4300 .vitem &%-oMaa%&&~<&'name'&>
4301 .oindex "&%-oMaa%&"
4302 .cindex "authentication" "name, specifying for local message"
4303 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMaa%&
4304 option sets the value of &$sender_host_authenticated$& (the authenticator
4305 name). See chapter &<<CHAPSMTPAUTH>>& for a discussion of SMTP authentication.
4306 This option can be used with &%-bh%& and &%-bs%& to set up an
4307 authenticated SMTP session without actually using the SMTP AUTH command.
4308
4309 .vitem &%-oMai%&&~<&'string'&>
4310 .oindex "&%-oMai%&"
4311 .cindex "authentication" "id, specifying for local message"
4312 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMai%&
4313 option sets the value of &$authenticated_id$& (the id that was authenticated).
4314 This overrides the default value (the caller's login id, except with &%-bh%&,
4315 where there is no default) for messages from local sources. See chapter
4316 &<<CHAPSMTPAUTH>>& for a discussion of authenticated ids.
4317
4318 .vitem &%-oMas%&&~<&'address'&>
4319 .oindex "&%-oMas%&"
4320 .cindex "authentication" "sender, specifying for local message"
4321 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMas%&
4322 option sets the authenticated sender value in &$authenticated_sender$&. It
4323 overrides the sender address that is created from the caller's login id for
4324 messages from local sources, except when &%-bh%& is used, when there is no
4325 default. For both &%-bh%& and &%-bs%&, an authenticated sender that is
4326 specified on a MAIL command overrides this value. See chapter
4327 &<<CHAPSMTPAUTH>>& for a discussion of authenticated senders.
4328
4329 .vitem &%-oMi%&&~<&'interface&~address'&>
4330 .oindex "&%-oMi%&"
4331 .cindex "interface" "address, specifying for local message"
4332 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMi%&
4333 option sets the IP interface address value. A port number may be included,
4334 using the same syntax as for &%-oMa%&. The interface address is placed in
4335 &$received_ip_address$& and the port number, if present, in &$received_port$&.
4336
4337 .vitem &%-oMm%&&~<&'message&~reference'&>
4338 .oindex "&%-oMm%&"
4339 .cindex "message reference" "message reference, specifying for local message"
4340 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMm%&
4341 option sets the message reference, e.g. message-id, and is logged during
4342 delivery. This is useful when some kind of audit trail is required to tie
4343 messages together. The format of the message reference is checked and will
4344 abort if the format is invalid. The option will only be accepted if exim is
4345 running in trusted mode, not as any regular user.
4346
4347 The best example of a message reference is when Exim sends a bounce message.
4348 The message reference is the message-id of the original message for which Exim
4349 is sending the bounce.
4350
4351 .vitem &%-oMr%&&~<&'protocol&~name'&>
4352 .oindex "&%-oMr%&"
4353 .cindex "protocol, specifying for local message"
4354 .vindex "&$received_protocol$&"
4355 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMr%&
4356 option sets the received protocol value that is stored in
4357 &$received_protocol$&. However, it does not apply (and is ignored) when &%-bh%&
4358 or &%-bs%& is used. For &%-bh%&, the protocol is forced to one of the standard
4359 SMTP protocol names (see the description of &$received_protocol$& in section
4360 &<<SECTexpvar>>&). For &%-bs%&, the protocol is always &"local-"& followed by
4361 one of those same names. For &%-bS%& (batched SMTP) however, the protocol can
4362 be set by &%-oMr%&. Repeated use of this option is not supported.
4363
4364 .vitem &%-oMs%&&~<&'host&~name'&>
4365 .oindex "&%-oMs%&"
4366 .cindex "sender" "host name, specifying for local message"
4367 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMs%&
4368 option sets the sender host name in &$sender_host_name$&. When this option is
4369 present, Exim does not attempt to look up a host name from an IP address; it
4370 uses the name it is given.
4371
4372 .vitem &%-oMt%&&~<&'ident&~string'&>
4373 .oindex "&%-oMt%&"
4374 .cindex "sender" "ident string, specifying for local message"
4375 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMt%&
4376 option sets the sender ident value in &$sender_ident$&. The default setting for
4377 local callers is the login id of the calling process, except when &%-bh%& is
4378 used, when there is no default.
4379
4380 .vitem &%-om%&
4381 .oindex "&%-om%&"
4382 .cindex "Sendmail compatibility" "&%-om%& option ignored"
4383 In Sendmail, this option means &"me too"&, indicating that the sender of a
4384 message should receive a copy of the message if the sender appears in an alias
4385 expansion. Exim always does this, so the option does nothing.
4386
4387 .vitem &%-oo%&
4388 .oindex "&%-oo%&"
4389 .cindex "Sendmail compatibility" "&%-oo%& option ignored"
4390 This option is ignored. In Sendmail it specifies &"old style headers"&,
4391 whatever that means.
4392
4393 .vitem &%-oP%&&~<&'path'&>
4394 .oindex "&%-oP%&"
4395 .cindex "pid (process id)" "of daemon"
4396 .cindex "daemon" "process id (pid)"
4397 This option is useful only in conjunction with &%-bd%& or &%-q%& with a time
4398 value. The option specifies the file to which the process id of the daemon is
4399 written. When &%-oX%& is used with &%-bd%&, or when &%-q%& with a time is used
4400 without &%-bd%&, this is the only way of causing Exim to write a pid file,
4401 because in those cases, the normal pid file is not used.
4402
4403 .vitem &%-oPX%&
4404 .oindex "&%-oPX%&"
4405 .cindex "pid (process id)" "of daemon"
4406 .cindex "daemon" "process id (pid)"
4407 This option is not intended for general use.
4408 The daemon uses it when terminating due to a SIGTEM, possibly in
4409 combination with &%-oP%&&~<&'path'&>.
4410 It causes the pid file to be removed.
4411
4412 .vitem &%-or%&&~<&'time'&>
4413 .oindex "&%-or%&"
4414 .cindex "timeout" "for non-SMTP input"
4415 This option sets a timeout value for incoming non-SMTP messages. If it is not
4416 set, Exim will wait forever for the standard input. The value can also be set
4417 by the &%receive_timeout%& option. The format used for specifying times is
4418 described in section &<<SECTtimeformat>>&.
4419
4420 .vitem &%-os%&&~<&'time'&>
4421 .oindex "&%-os%&"
4422 .cindex "timeout" "for SMTP input"
4423 .cindex "SMTP" "input timeout"
4424 This option sets a timeout value for incoming SMTP messages. The timeout
4425 applies to each SMTP command and block of data. The value can also be set by
4426 the &%smtp_receive_timeout%& option; it defaults to 5 minutes. The format used
4427 for specifying times is described in section &<<SECTtimeformat>>&.
4428
4429 .vitem &%-ov%&
4430 .oindex "&%-ov%&"
4431 This option has exactly the same effect as &%-v%&.
4432
4433 .vitem &%-oX%&&~<&'number&~or&~string'&>
4434 .oindex "&%-oX%&"
4435 .cindex "TCP/IP" "setting listening ports"
4436 .cindex "TCP/IP" "setting listening interfaces"
4437 .cindex "port" "receiving TCP/IP"
4438 This option is relevant only when the &%-bd%& (start listening daemon) option
4439 is also given. It controls which ports and interfaces the daemon uses. Details
4440 of the syntax, and how it interacts with configuration file options, are given
4441 in chapter &<<CHAPinterfaces>>&. When &%-oX%& is used to start a daemon, no pid
4442 file is written unless &%-oP%& is also present to specify a pid filename.
4443
4444 .vitem &%-pd%&
4445 .oindex "&%-pd%&"
4446 .cindex "Perl" "starting the interpreter"
4447 This option applies when an embedded Perl interpreter is linked with Exim (see
4448 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4449 option, forcing the starting of the interpreter to be delayed until it is
4450 needed.
4451
4452 .vitem &%-ps%&
4453 .oindex "&%-ps%&"
4454 .cindex "Perl" "starting the interpreter"
4455 This option applies when an embedded Perl interpreter is linked with Exim (see
4456 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4457 option, forcing the starting of the interpreter to occur as soon as Exim is
4458 started.
4459
4460 .vitem &%-p%&<&'rval'&>:<&'sval'&>
4461 .oindex "&%-p%&"
4462 For compatibility with Sendmail, this option is equivalent to
4463 .display
4464 &`-oMr`& <&'rval'&> &`-oMs`& <&'sval'&>
4465 .endd
4466 It sets the incoming protocol and host name (for trusted callers). The
4467 host name and its colon can be omitted when only the protocol is to be set.
4468 Note the Exim already has two private options, &%-pd%& and &%-ps%&, that refer
4469 to embedded Perl. It is therefore impossible to set a protocol value of &`d`&
4470 or &`s`& using this option (but that does not seem a real limitation).
4471 Repeated use of this option is not supported.
4472
4473 .vitem &%-q%&
4474 .oindex "&%-q%&"
4475 .cindex "queue runner" "starting manually"
4476 This option is normally restricted to admin users. However, there is a
4477 configuration option called &%prod_requires_admin%& which can be set false to
4478 relax this restriction (and also the same requirement for the &%-M%&, &%-R%&,
4479 and &%-S%& options).
4480
4481 .cindex "queue runner" "description of operation"
4482 If other commandline options do not specify an action,
4483 the &%-q%& option starts one queue runner process. This scans the queue of
4484 waiting messages, and runs a delivery process for each one in turn. It waits
4485 for each delivery process to finish before starting the next one. A delivery
4486 process may not actually do any deliveries if the retry times for the addresses
4487 have not been reached. Use &%-qf%& (see below) if you want to override this.
4488
4489 If
4490 .cindex "SMTP" "passed connection"
4491 .cindex "SMTP" "multiple deliveries"
4492 .cindex "multiple SMTP deliveries"
4493 the delivery process spawns other processes to deliver other messages down
4494 passed SMTP connections, the queue runner waits for these to finish before
4495 proceeding.
4496
4497 When all the queued messages have been considered, the original queue runner
4498 process terminates. In other words, a single pass is made over the waiting
4499 mail, one message at a time. Use &%-q%& with a time (see below) if you want
4500 this to be repeated periodically.
4501
4502 Exim processes the waiting messages in an unpredictable order. It isn't very
4503 random, but it is likely to be different each time, which is all that matters.
4504 If one particular message screws up a remote MTA, other messages to the same
4505 MTA have a chance of getting through if they get tried first.
4506
4507 It is possible to cause the messages to be processed in lexical message id
4508 order, which is essentially the order in which they arrived, by setting the
4509 &%queue_run_in_order%& option, but this is not recommended for normal use.
4510
4511 .vitem &%-q%&<&'qflags'&>
4512 The &%-q%& option may be followed by one or more flag letters that change its
4513 behaviour. They are all optional, but if more than one is present, they must
4514 appear in the correct order. Each flag is described in a separate item below.
4515
4516 .vitem &%-qq...%&
4517 .oindex "&%-qq%&"
4518 .cindex "queue" "double scanning"
4519 .cindex "queue" "routing"
4520 .cindex "routing" "whole queue before delivery"
4521 .cindex "first pass routing"
4522 .cindex "queue runner" "two phase"
4523 An option starting with &%-qq%& requests a two-stage queue run. In the first
4524 stage, the queue is scanned as if the &%queue_smtp_domains%& option matched
4525 every domain. Addresses are routed, local deliveries happen, but no remote
4526 transports are run.
4527
4528 Performance will be best if the &%queue_run_in_order%& option is false.
4529 If that is so and the &%queue_fast_ramp%& option is true then
4530 in the first phase of the run,
4531 once a threshold number of messages are routed for a given host,
4532 a delivery process is forked in parallel with the rest of the scan.
4533
4534 .cindex "hints database" "remembering routing"
4535 The hints database that remembers which messages are waiting for specific hosts
4536 is updated, as if delivery to those hosts had been deferred. After this is
4537 complete, a second, normal queue scan happens, with routing and delivery taking
4538 place as normal. Messages that are routed to the same host should mostly be
4539 delivered down a single SMTP
4540 .cindex "SMTP" "passed connection"
4541 .cindex "SMTP" "multiple deliveries"
4542 .cindex "multiple SMTP deliveries"
4543 connection because of the hints that were set up during the first queue scan.
4544 This option may be useful for hosts that are connected to the Internet
4545 intermittently.
4546
4547 .vitem &%-q[q]i...%&
4548 .oindex "&%-qi%&"
4549 .cindex "queue" "initial delivery"
4550 If the &'i'& flag is present, the queue runner runs delivery processes only for
4551 those messages that haven't previously been tried. (&'i'& stands for &"initial
4552 delivery"&.) This can be helpful if you are putting messages in the queue using
4553 &%-odq%& and want a queue runner just to process the new messages.
4554
4555 .vitem &%-q[q][i]f...%&
4556 .oindex "&%-qf%&"
4557 .cindex "queue" "forcing delivery"
4558 .cindex "delivery" "forcing in queue run"
4559 If one &'f'& flag is present, a delivery attempt is forced for each non-frozen
4560 message, whereas without &'f'& only those non-frozen addresses that have passed
4561 their retry times are tried.
4562
4563 .vitem &%-q[q][i]ff...%&
4564 .oindex "&%-qff%&"
4565 .cindex "frozen messages" "forcing delivery"
4566 If &'ff'& is present, a delivery attempt is forced for every message, whether
4567 frozen or not.
4568
4569 .vitem &%-q[q][i][f[f]]l%&
4570 .oindex "&%-ql%&"
4571 .cindex "queue" "local deliveries only"
4572 The &'l'& (the letter &"ell"&) flag specifies that only local deliveries are to
4573 be done. If a message requires any remote deliveries, it remains in the queue
4574 for later delivery.
4575
4576 .vitem &%-q[q][i][f[f]][l][G<name>[/<time>]]]%&
4577 .oindex "&%-qG%&"
4578 .cindex queue named
4579 .cindex "named queues"  "deliver from"
4580 .cindex "queue" "delivering specific messages"
4581 If the &'G'& flag and a name is present, the queue runner operates on the
4582 queue with the given name rather than the default queue.
4583 The name should not contain a &'/'& character.
4584 For a periodic queue run (see below)
4585 append to the name a slash and a time value.
4586
4587 If other commandline options specify an action, a &'-qG<name>'& option
4588 will specify a queue to operate on.
4589 For example:
4590 .code
4591 exim -bp -qGquarantine
4592 mailq -qGquarantine
4593 exim -qGoffpeak -Rf @special.domain.example
4594 .endd
4595
4596 .vitem &%-q%&<&'qflags'&>&~<&'start&~id'&>&~<&'end&~id'&>
4597 When scanning the queue, Exim can be made to skip over messages whose ids are
4598 lexically less than a given value by following the &%-q%& option with a
4599 starting message id. For example:
4600 .code
4601 exim -q 0t5C6f-0000c8-00
4602 .endd
4603 Messages that arrived earlier than &`0t5C6f-0000c8-00`& are not inspected. If a
4604 second message id is given, messages whose ids are lexically greater than it
4605 are also skipped. If the same id is given twice, for example,
4606 .code
4607 exim -q 0t5C6f-0000c8-00 0t5C6f-0000c8-00
4608 .endd
4609 just one delivery process is started, for that message. This differs from
4610 &%-M%& in that retry data is respected, and it also differs from &%-Mc%& in
4611 that it counts as a delivery from a queue run. Note that the selection
4612 mechanism does not affect the order in which the messages are scanned. There
4613 are also other ways of selecting specific sets of messages for delivery in a
4614 queue run &-- see &%-R%& and &%-S%&.
4615
4616 .vitem &%-q%&<&'qflags'&><&'time'&>
4617 .cindex "queue runner" "starting periodically"
4618 .cindex "periodic queue running"
4619 When a time value is present, the &%-q%& option causes Exim to run as a daemon,
4620 starting a queue runner process at intervals specified by the given time value
4621 (whose format is described in section &<<SECTtimeformat>>&). This form of the
4622 &%-q%& option is commonly combined with the &%-bd%& option, in which case a
4623 single daemon process handles both functions. A common way of starting up a
4624 combined daemon at system boot time is to use a command such as
4625 .code
4626 /usr/exim/bin/exim -bd -q30m
4627 .endd
4628 Such a daemon listens for incoming SMTP calls, and also starts a queue runner
4629 process every 30 minutes.
4630
4631 When a daemon is started by &%-q%& with a time value, but without &%-bd%&, no
4632 pid file is written unless one is explicitly requested by the &%-oP%& option.
4633
4634 .vitem &%-qR%&<&'rsflags'&>&~<&'string'&>
4635 .oindex "&%-qR%&"
4636 This option is synonymous with &%-R%&. It is provided for Sendmail
4637 compatibility.
4638
4639 .vitem &%-qS%&<&'rsflags'&>&~<&'string'&>
4640 .oindex "&%-qS%&"
4641 This option is synonymous with &%-S%&.
4642
4643 .vitem &%-R%&<&'rsflags'&>&~<&'string'&>
4644 .oindex "&%-R%&"
4645 .cindex "queue runner" "for specific recipients"
4646 .cindex "delivery" "to given domain"
4647 .cindex "domain" "delivery to"
4648 The <&'rsflags'&> may be empty, in which case the white space before the string
4649 is optional, unless the string is &'f'&, &'ff'&, &'r'&, &'rf'&, or &'rff'&,
4650 which are the possible values for <&'rsflags'&>. White space is required if
4651 <&'rsflags'&> is not empty.
4652
4653 This option is similar to &%-q%& with no time value, that is, it causes Exim to
4654 perform a single queue run, except that, when scanning the messages on the
4655 queue, Exim processes only those that have at least one undelivered recipient
4656 address containing the given string, which is checked in a case-independent
4657 way. If the <&'rsflags'&> start with &'r'&, <&'string'&> is interpreted as a
4658 regular expression; otherwise it is a literal string.
4659
4660 If you want to do periodic queue runs for messages with specific recipients,
4661 you can combine &%-R%& with &%-q%& and a time value. For example:
4662 .code
4663 exim -q25m -R @special.domain.example
4664 .endd
4665 This example does a queue run for messages with recipients in the given domain
4666 every 25 minutes. Any additional flags that are specified with &%-q%& are
4667 applied to each queue run.
4668
4669 Once a message is selected for delivery by this mechanism, all its addresses
4670 are processed. For the first selected message, Exim overrides any retry
4671 information and forces a delivery attempt for each undelivered address. This
4672 means that if delivery of any address in the first message is successful, any
4673 existing retry information is deleted, and so delivery attempts for that
4674 address in subsequently selected messages (which are processed without forcing)
4675 will run. However, if delivery of any address does not succeed, the retry
4676 information is updated, and in subsequently selected messages, the failing
4677 address will be skipped.
4678
4679 .cindex "frozen messages" "forcing delivery"
4680 If the <&'rsflags'&> contain &'f'& or &'ff'&, the delivery forcing applies to
4681 all selected messages, not just the first; frozen messages are included when
4682 &'ff'& is present.
4683
4684 The &%-R%& option makes it straightforward to initiate delivery of all messages
4685 to a given domain after a host has been down for some time. When the SMTP
4686 command ETRN is accepted by its ACL (see chapter &<<CHAPACL>>&), its default
4687 effect is to run Exim with the &%-R%& option, but it can be configured to run
4688 an arbitrary command instead.
4689
4690 .vitem &%-r%&
4691 .oindex "&%-r%&"
4692 This is a documented (for Sendmail) obsolete alternative name for &%-f%&.
4693
4694 .vitem &%-S%&<&'rsflags'&>&~<&'string'&>
4695 .oindex "&%-S%&"
4696 .cindex "delivery" "from given sender"
4697 .cindex "queue runner" "for specific senders"
4698 This option acts like &%-R%& except that it checks the string against each
4699 message's sender instead of against the recipients. If &%-R%& is also set, both
4700 conditions must be met for a message to be selected. If either of the options
4701 has &'f'& or &'ff'& in its flags, the associated action is taken.
4702
4703 .vitem &%-Tqt%&&~<&'times'&>
4704 .oindex "&%-Tqt%&"
4705 This is an option that is exclusively for use by the Exim testing suite. It is not
4706 recognized when Exim is run normally. It allows for the setting up of explicit
4707 &"queue times"& so that various warning/retry features can be tested.
4708
4709 .vitem &%-t%&
4710 .oindex "&%-t%&"
4711 .cindex "recipient" "extracting from header lines"
4712 .cindex "&'Bcc:'& header line"
4713 .cindex "&'Cc:'& header line"
4714 .cindex "&'To:'& header line"
4715 When Exim is receiving a locally-generated, non-SMTP message on its standard
4716 input, the &%-t%& option causes the recipients of the message to be obtained
4717 from the &'To:'&, &'Cc:'&, and &'Bcc:'& header lines in the message instead of
4718 from the command arguments. The addresses are extracted before any rewriting
4719 takes place and the &'Bcc:'& header line, if present, is then removed.
4720
4721 .cindex "Sendmail compatibility" "&%-t%& option"
4722 If the command has any arguments, they specify addresses to which the message
4723 is &'not'& to be delivered. That is, the argument addresses are removed from
4724 the recipients list obtained from the headers. This is compatible with Smail 3
4725 and in accordance with the documented behaviour of several versions of
4726 Sendmail, as described in man pages on a number of operating systems (e.g.
4727 Solaris 8, IRIX 6.5, HP-UX 11). However, some versions of Sendmail &'add'&
4728 argument addresses to those obtained from the headers, and the O'Reilly
4729 Sendmail book documents it that way. Exim can be made to add argument addresses
4730 instead of subtracting them by setting the option
4731 &%extract_addresses_remove_arguments%& false.
4732
4733 .cindex "&%Resent-%& header lines" "with &%-t%&"
4734 If there are any &%Resent-%& header lines in the message, Exim extracts
4735 recipients from all &'Resent-To:'&, &'Resent-Cc:'&, and &'Resent-Bcc:'& header
4736 lines instead of from &'To:'&, &'Cc:'&, and &'Bcc:'&. This is for compatibility
4737 with Sendmail and other MTAs. (Prior to release 4.20, Exim gave an error if
4738 &%-t%& was used in conjunction with &%Resent-%& header lines.)
4739
4740 RFC 2822 talks about different sets of &%Resent-%& header lines (for when a
4741 message is resent several times). The RFC also specifies that they should be
4742 added at the front of the message, and separated by &'Received:'& lines. It is
4743 not at all clear how &%-t%& should operate in the present of multiple sets,
4744 nor indeed exactly what constitutes a &"set"&.
4745 In practice, it seems that MUAs do not follow the RFC. The &%Resent-%& lines
4746 are often added at the end of the header, and if a message is resent more than
4747 once, it is common for the original set of &%Resent-%& headers to be renamed as
4748 &%X-Resent-%& when a new set is added. This removes any possible ambiguity.
4749
4750 .vitem &%-ti%&
4751 .oindex "&%-ti%&"
4752 This option is exactly equivalent to &%-t%& &%-i%&. It is provided for
4753 compatibility with Sendmail.
4754
4755 .vitem &%-tls-on-connect%&
4756 .oindex "&%-tls-on-connect%&"
4757 .cindex "TLS" "use without STARTTLS"
4758 .cindex "TLS" "automatic start"
4759 This option is available when Exim is compiled with TLS support. It forces all
4760 incoming SMTP connections to behave as if the incoming port is listed in the
4761 &%tls_on_connect_ports%& option. See section &<<SECTsupobssmt>>& and chapter
4762 &<<CHAPTLS>>& for further details.
4763
4764
4765 .vitem &%-U%&
4766 .oindex "&%-U%&"
4767 .cindex "Sendmail compatibility" "&%-U%& option ignored"
4768 Sendmail uses this option for &"initial message submission"&, and its
4769 documentation states that in future releases, it may complain about
4770 syntactically invalid messages rather than fixing them when this flag is not
4771 set. Exim ignores this option.
4772
4773 .vitem &%-v%&
4774 .oindex "&%-v%&"
4775 This option causes Exim to write information to the standard error stream,
4776 describing what it is doing. In particular, it shows the log lines for
4777 receiving and delivering a message, and if an SMTP connection is made, the SMTP
4778 dialogue is shown. Some of the log lines shown may not actually be written to
4779 the log if the setting of &%log_selector%& discards them. Any relevant
4780 selectors are shown with each log line. If none are shown, the logging is
4781 unconditional.
4782
4783 .vitem &%-x%&
4784 .oindex "&%-x%&"
4785 AIX uses &%-x%& for a private purpose (&"mail from a local mail program has
4786 National Language Support extended characters in the body of the mail item"&).
4787 It sets &%-x%& when calling the MTA from its &%mail%& command. Exim ignores
4788 this option.
4789
4790 .vitem &%-X%&&~<&'logfile'&>
4791 .oindex "&%-X%&"
4792 This option is interpreted by Sendmail to cause debug information to be sent
4793 to the named file.  It is ignored by Exim.
4794
4795 .vitem &%-z%&&~<&'log-line'&>
4796 .oindex "&%-z%&"
4797 This option writes its argument to Exim's logfile.
4798 Use is restricted to administrators; the intent is for operational notes.
4799 Quotes should be used to maintain a multi-word item as a single argument,
4800 under most shells.
4801 .endlist
4802
4803 .ecindex IIDclo1
4804 .ecindex IIDclo2
4805
4806
4807 . ////////////////////////////////////////////////////////////////////////////
4808 . Insert a stylized DocBook comment here, to identify the end of the command
4809 . line options. This is for the benefit of the Perl script that automatically
4810 . creates a man page for the options.
4811 . ////////////////////////////////////////////////////////////////////////////
4812
4813 .literal xml
4814 <!-- === End of command line options === -->
4815 .literal off
4816
4817
4818
4819
4820
4821 . ////////////////////////////////////////////////////////////////////////////
4822 . ////////////////////////////////////////////////////////////////////////////
4823
4824
4825 .chapter "The Exim runtime configuration file" "CHAPconf" &&&
4826          "The runtime configuration file"
4827
4828 .cindex "runtime configuration"
4829 .cindex "configuration file" "general description"
4830 .cindex "CONFIGURE_FILE"
4831 .cindex "configuration file" "errors in"
4832 .cindex "error" "in configuration file"
4833 .cindex "return code" "for bad configuration"
4834 Exim uses a single runtime configuration file that is read whenever an Exim
4835 binary is executed. Note that in normal operation, this happens frequently,
4836 because Exim is designed to operate in a distributed manner, without central
4837 control.
4838
4839 If a syntax error is detected while reading the configuration file, Exim
4840 writes a message on the standard error, and exits with a non-zero return code.
4841 The message is also written to the panic log. &*Note*&: Only simple syntax
4842 errors can be detected at this time. The values of any expanded options are
4843 not checked until the expansion happens, even when the expansion does not
4844 actually alter the string.
4845
4846 The name of the configuration file is compiled into the binary for security
4847 reasons, and is specified by the CONFIGURE_FILE compilation option. In
4848 most configurations, this specifies a single file. However, it is permitted to
4849 give a colon-separated list of filenames, in which case Exim uses the first
4850 existing file in the list.
4851
4852 .cindex "EXIM_USER"
4853 .cindex "EXIM_GROUP"
4854 .cindex "CONFIGURE_OWNER"
4855 .cindex "CONFIGURE_GROUP"
4856 .cindex "configuration file" "ownership"
4857 .cindex "ownership" "configuration file"
4858 The runtime configuration file must be owned by root or by the user that is
4859 specified at compile time by the CONFIGURE_OWNER option (if set). The
4860 configuration file must not be world-writeable, or group-writeable unless its
4861 group is the root group or the one specified at compile time by the
4862 CONFIGURE_GROUP option.
4863
4864 &*Warning*&: In a conventional configuration, where the Exim binary is setuid
4865 to root, anybody who is able to edit the runtime configuration file has an
4866 easy way to run commands as root. If you specify a user or group in the
4867 CONFIGURE_OWNER or CONFIGURE_GROUP options, then that user and/or any users
4868 who are members of that group will trivially be able to obtain root privileges.
4869
4870 Up to Exim version 4.72, the runtime configuration file was also permitted to
4871 be writeable by the Exim user and/or group. That has been changed in Exim 4.73
4872 since it offered a simple privilege escalation for any attacker who managed to
4873 compromise the Exim user account.
4874
4875 A default configuration file, which will work correctly in simple situations,
4876 is provided in the file &_src/configure.default_&. If CONFIGURE_FILE
4877 defines just one filename, the installation process copies the default
4878 configuration to a new file of that name if it did not previously exist. If
4879 CONFIGURE_FILE is a list, no default is automatically installed. Chapter
4880 &<<CHAPdefconfil>>& is a &"walk-through"& discussion of the default
4881 configuration.
4882
4883
4884
4885 .section "Using a different configuration file" "SECID40"
4886 .cindex "configuration file" "alternate"
4887 A one-off alternate configuration can be specified by the &%-C%& command line
4888 option, which may specify a single file or a list of files. However, when
4889 &%-C%& is used, Exim gives up its root privilege, unless called by root (or
4890 unless the argument for &%-C%& is identical to the built-in value from
4891 CONFIGURE_FILE), or is listed in the TRUSTED_CONFIG_LIST file and the caller
4892 is the Exim user or the user specified in the CONFIGURE_OWNER setting. &%-C%&
4893 is useful mainly for checking the syntax of configuration files before
4894 installing them. No owner or group checks are done on a configuration file
4895 specified by &%-C%&, if root privilege has been dropped.
4896
4897 Even the Exim user is not trusted to specify an arbitrary configuration file
4898 with the &%-C%& option to be used with root privileges, unless that file is
4899 listed in the TRUSTED_CONFIG_LIST file. This locks out the possibility of
4900 testing a configuration using &%-C%& right through message reception and
4901 delivery, even if the caller is root. The reception works, but by that time,
4902 Exim is running as the Exim user, so when it re-execs to regain privilege for
4903 the delivery, the use of &%-C%& causes privilege to be lost. However, root
4904 can test reception and delivery using two separate commands (one to put a
4905 message in the queue, using &%-odq%&, and another to do the delivery, using
4906 &%-M%&).
4907
4908 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
4909 prefix string with which any file named in a &%-C%& command line option must
4910 start. In addition, the filename must not contain the sequence &"&`/../`&"&.
4911 There is no default setting for ALT_CONFIG_PREFIX; when it is unset, any
4912 filename can be used with &%-C%&.
4913
4914 One-off changes to a configuration can be specified by the &%-D%& command line
4915 option, which defines and overrides values for macros used inside the
4916 configuration file. However, like &%-C%&, the use of this option by a
4917 non-privileged user causes Exim to discard its root privilege.
4918 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
4919 completely disabled, and its use causes an immediate error exit.
4920
4921 The WHITELIST_D_MACROS option in &_Local/Makefile_& permits the binary builder
4922 to declare certain macro names trusted, such that root privilege will not
4923 necessarily be discarded.
4924 WHITELIST_D_MACROS defines a colon-separated list of macros which are
4925 considered safe and, if &%-D%& only supplies macros from this list, and the
4926 values are acceptable, then Exim will not give up root privilege if the caller
4927 is root, the Exim run-time user, or the CONFIGURE_OWNER, if set.  This is a
4928 transition mechanism and is expected to be removed in the future.  Acceptable
4929 values for the macros satisfy the regexp: &`^[A-Za-z0-9_/.-]*$`&
4930
4931 Some sites may wish to use the same Exim binary on different machines that
4932 share a file system, but to use different configuration files on each machine.
4933 If CONFIGURE_FILE_USE_NODE is defined in &_Local/Makefile_&, Exim first
4934 looks for a file whose name is the configuration filename followed by a dot
4935 and the machine's node name, as obtained from the &[uname()]& function. If this
4936 file does not exist, the standard name is tried. This processing occurs for
4937 each filename in the list given by CONFIGURE_FILE or &%-C%&.
4938
4939 In some esoteric situations different versions of Exim may be run under
4940 different effective uids and the CONFIGURE_FILE_USE_EUID is defined to
4941 help with this. See the comments in &_src/EDITME_& for details.
4942
4943
4944
4945 .section "Configuration file format" "SECTconffilfor"
4946 .cindex "configuration file" "format of"
4947 .cindex "format" "configuration file"
4948 Exim's configuration file is divided into a number of different parts. General
4949 option settings must always appear at the start of the file. The other parts
4950 are all optional, and may appear in any order. Each part other than the first
4951 is introduced by the word &"begin"& followed by at least one literal
4952 space, and the name of the part. The optional parts are:
4953
4954 .ilist
4955 &'ACL'&: Access control lists for controlling incoming SMTP mail (see chapter
4956 &<<CHAPACL>>&).
4957 .next
4958 .cindex "AUTH" "configuration"
4959 &'authenticators'&: Configuration settings for the authenticator drivers. These
4960 are concerned with the SMTP AUTH command (see chapter &<<CHAPSMTPAUTH>>&).
4961 .next
4962 &'routers'&: Configuration settings for the router drivers. Routers process
4963 addresses and determine how the message is to be delivered (see chapters
4964 &<<CHAProutergeneric>>&&--&<<CHAPredirect>>&).
4965 .next
4966 &'transports'&: Configuration settings for the transport drivers. Transports
4967 define mechanisms for copying messages to destinations (see chapters
4968 &<<CHAPtransportgeneric>>&&--&<<CHAPsmtptrans>>&).
4969 .next
4970 &'retry'&: Retry rules, for use when a message cannot be delivered immediately.
4971 If there is no retry section, or if it is empty (that is, no retry rules are
4972 defined), Exim will not retry deliveries. In this situation, temporary errors
4973 are treated the same as permanent errors. Retry rules are discussed in chapter
4974 &<<CHAPretry>>&.
4975 .next
4976 &'rewrite'&: Global address rewriting rules, for use when a message arrives and
4977 when new addresses are generated during delivery. Rewriting is discussed in
4978 chapter &<<CHAPrewrite>>&.
4979 .next
4980 &'local_scan'&: Private options for the &[local_scan()]& function. If you
4981 want to use this feature, you must set
4982 .code
4983 LOCAL_SCAN_HAS_OPTIONS=yes
4984 .endd
4985 in &_Local/Makefile_& before building Exim. Details of the &[local_scan()]&
4986 facility are given in chapter &<<CHAPlocalscan>>&.
4987 .endlist
4988
4989 .cindex "configuration file" "leading white space in"
4990 .cindex "configuration file" "trailing white space in"
4991 .cindex "white space" "in configuration file"
4992 Leading and trailing white space in configuration lines is always ignored.
4993
4994 Blank lines in the file, and lines starting with a # character (ignoring
4995 leading white space) are treated as comments and are ignored. &*Note*&: A
4996 # character other than at the beginning of a line is not treated specially,
4997 and does not introduce a comment.
4998
4999 Any non-comment line can be continued by ending it with a backslash. Note that
5000 the general rule for white space means that trailing white space after the
5001 backslash and leading white space at the start of continuation
5002 lines is ignored. Comment lines beginning with # (but not empty lines) may
5003 appear in the middle of a sequence of continuation lines.
5004
5005 A convenient way to create a configuration file is to start from the
5006 default, which is supplied in &_src/configure.default_&, and add, delete, or
5007 change settings as required.
5008
5009 The ACLs, retry rules, and rewriting rules have their own syntax which is
5010 described in chapters &<<CHAPACL>>&, &<<CHAPretry>>&, and &<<CHAPrewrite>>&,
5011 respectively. The other parts of the configuration file have some syntactic
5012 items in common, and these are described below, from section &<<SECTcos>>&
5013 onwards. Before that, the inclusion, macro, and conditional facilities are
5014 described.
5015
5016
5017
5018 .section "File inclusions in the configuration file" "SECID41"
5019 .cindex "inclusions in configuration file"
5020 .cindex "configuration file" "including other files"
5021 .cindex "&`.include`& in configuration file"
5022 .cindex "&`.include_if_exists`& in configuration file"
5023 You can include other files inside Exim's runtime configuration file by
5024 using this syntax:
5025 .display
5026 &`.include`& <&'filename'&>
5027 &`.include_if_exists`& <&'filename'&>
5028 .endd
5029 on a line by itself. Double quotes round the filename are optional. If you use
5030 the first form, a configuration error occurs if the file does not exist; the
5031 second form does nothing for non-existent files.
5032 The first form allows a relative name. It is resolved relative to
5033 the directory of the including file. For the second form an absolute filename
5034 is required.
5035
5036 Includes may be nested to any depth, but remember that Exim reads its
5037 configuration file often, so it is a good idea to keep them to a minimum.
5038 If you change the contents of an included file, you must HUP the daemon,
5039 because an included file is read only when the configuration itself is read.
5040
5041 The processing of inclusions happens early, at a physical line level, so, like
5042 comment lines, an inclusion can be used in the middle of an option setting,
5043 for example:
5044 .code
5045 hosts_lookup = a.b.c \
5046                .include /some/file
5047 .endd
5048 Include processing happens after macro processing (see below). Its effect is to
5049 process the lines of the included file as if they occurred inline where the
5050 inclusion appears.
5051
5052
5053
5054 .section "Macros in the configuration file" "SECTmacrodefs"
5055 .cindex "macro" "description of"
5056 .cindex "configuration file" "macros"
5057 If a line in the main part of the configuration (that is, before the first
5058 &"begin"& line) begins with an upper case letter, it is taken as a macro
5059 definition, and must be of the form
5060 .display
5061 <&'name'&> = <&'rest of line'&>
5062 .endd
5063 The name must consist of letters, digits, and underscores, and need not all be
5064 in upper case, though that is recommended. The rest of the line, including any
5065 continuations, is the replacement text, and has leading and trailing white
5066 space removed. Quotes are not removed. The replacement text can never end with
5067 a backslash character, but this doesn't seem to be a serious limitation.
5068
5069 Macros may also be defined between router, transport, authenticator, or ACL
5070 definitions. They may not, however, be defined within an individual driver or
5071 ACL, or in the &%local_scan%&, retry, or rewrite sections of the configuration.
5072
5073 .section "Macro substitution" "SECID42"
5074 Once a macro is defined, all subsequent lines in the file (and any included
5075 files) are scanned for the macro name; if there are several macros, the line is
5076 scanned for each, in turn, in the order in which the macros are defined. The
5077 replacement text is not re-scanned for the current macro, though it is scanned
5078 for subsequently defined macros. For this reason, a macro name may not contain
5079 the name of a previously defined macro as a substring. You could, for example,
5080 define
5081 .display
5082 &`ABCD_XYZ = `&<&'something'&>
5083 &`ABCD = `&<&'something else'&>
5084 .endd
5085 but putting the definitions in the opposite order would provoke a configuration
5086 error. Macro expansion is applied to individual physical lines from the file,
5087 before checking for line continuation or file inclusion (see above). If a line
5088 consists solely of a macro name, and the expansion of the macro is empty, the
5089 line is ignored. A macro at the start of a line may turn the line into a
5090 comment line or a &`.include`& line.
5091
5092
5093 .section "Redefining macros" "SECID43"
5094 Once defined, the value of a macro can be redefined later in the configuration
5095 (or in an included file). Redefinition is specified by using &'=='& instead of
5096 &'='&. For example:
5097 .code
5098 MAC =  initial value
5099 ...
5100 MAC == updated value
5101 .endd
5102 Redefinition does not alter the order in which the macros are applied to the
5103 subsequent lines of the configuration file. It is still the same order in which
5104 the macros were originally defined. All that changes is the macro's value.
5105 Redefinition makes it possible to accumulate values. For example:
5106 .code
5107 MAC =  initial value
5108 ...
5109 MAC == MAC and something added
5110 .endd
5111 This can be helpful in situations where the configuration file is built
5112 from a number of other files.
5113
5114 .section "Overriding macro values" "SECID44"
5115 The values set for macros in the configuration file can be overridden by the
5116 &%-D%& command line option, but Exim gives up its root privilege when &%-D%& is
5117 used, unless called by root or the Exim user. A definition on the command line
5118 using the &%-D%& option causes all definitions and redefinitions within the
5119 file to be ignored.
5120
5121
5122
5123 .section "Example of macro usage" "SECID45"
5124 As an example of macro usage, consider a configuration where aliases are looked
5125 up in a MySQL database. It helps to keep the file less cluttered if long
5126 strings such as SQL statements are defined separately as macros, for example:
5127 .code
5128 ALIAS_QUERY = select mailbox from user where \
5129               login='${quote_mysql:$local_part}';
5130 .endd
5131 This can then be used in a &(redirect)& router setting like this:
5132 .code
5133 data = ${lookup mysql{ALIAS_QUERY}}
5134 .endd
5135 In earlier versions of Exim macros were sometimes used for domain, host, or
5136 address lists. In Exim 4 these are handled better by named lists &-- see
5137 section &<<SECTnamedlists>>&.
5138
5139
5140 .section "Builtin macros" "SECTbuiltinmacros"
5141 Exim defines some macros depending on facilities available, which may
5142 differ due to build-time definitions and from one release to another.
5143 All of these macros start with an underscore.
5144 They can be used to conditionally include parts of a configuration
5145 (see below).
5146
5147 The following classes of macros are defined:
5148 .display
5149 &` _HAVE_*                    `&  build-time defines
5150 &` _DRIVER_ROUTER_*           `&  router drivers
5151 &` _DRIVER_TRANSPORT_*        `&  transport drivers
5152 &` _DRIVER_AUTHENTICATOR_*    `&  authenticator drivers
5153 &` _LOG_*                     `&  log_selector values
5154 &` _OPT_MAIN_*                `&  main config options
5155 &` _OPT_ROUTERS_*             `&  generic router options
5156 &` _OPT_TRANSPORTS_*          `&  generic transport options
5157 &` _OPT_AUTHENTICATORS_*      `&  generic authenticator options
5158 &` _OPT_ROUTER_*_*            `&  private router options
5159 &` _OPT_TRANSPORT_*_*         `&  private transport options
5160 &` _OPT_AUTHENTICATOR_*_*     `&  private authenticator options
5161 .endd
5162
5163 Use an &"exim -bP macros"& command to get the list of macros.
5164
5165
5166 .section "Conditional skips in the configuration file" "SECID46"
5167 .cindex "configuration file" "conditional skips"
5168 .cindex "&`.ifdef`&"
5169 You can use the directives &`.ifdef`&, &`.ifndef`&, &`.elifdef`&,
5170 &`.elifndef`&, &`.else`&, and &`.endif`& to dynamically include or exclude
5171 portions of the configuration file. The processing happens whenever the file is
5172 read (that is, when an Exim binary starts to run).
5173
5174 The implementation is very simple. Instances of the first four directives must
5175 be followed by text that includes the names of one or macros. The condition
5176 that is tested is whether or not any macro substitution has taken place in the
5177 line. Thus:
5178 .code
5179 .ifdef AAA
5180 message_size_limit = 50M
5181 .else
5182 message_size_limit = 100M
5183 .endif
5184 .endd
5185 sets a message size limit of 50M if the macro &`AAA`& is defined
5186 (or &`A`& or &`AA`&), and 100M
5187 otherwise. If there is more than one macro named on the line, the condition
5188 is true if any of them are defined. That is, it is an &"or"& condition. To
5189 obtain an &"and"& condition, you need to use nested &`.ifdef`&s.
5190
5191 Although you can use a macro expansion to generate one of these directives,
5192 it is not very useful, because the condition &"there was a macro substitution
5193 in this line"& will always be true.
5194
5195 Text following &`.else`& and &`.endif`& is ignored, and can be used as comment
5196 to clarify complicated nestings.
5197
5198
5199
5200 .section "Common option syntax" "SECTcos"
5201 .cindex "common option syntax"
5202 .cindex "syntax of common options"
5203 .cindex "configuration file" "common option syntax"
5204 For the main set of options, driver options, and &[local_scan()]& options,
5205 each setting is on a line by itself, and starts with a name consisting of
5206 lower-case letters and underscores. Many options require a data value, and in
5207 these cases the name must be followed by an equals sign (with optional white
5208 space) and then the value. For example:
5209 .code
5210 qualify_domain = mydomain.example.com
5211 .endd
5212 .cindex "hiding configuration option values"
5213 .cindex "configuration options" "hiding value of"
5214 .cindex "options" "hiding value of"
5215 Some option settings may contain sensitive data, for example, passwords for
5216 accessing databases. To stop non-admin users from using the &%-bP%& command
5217 line option to read these values, you can precede the option settings with the
5218 word &"hide"&. For example:
5219 .code
5220 hide mysql_servers = localhost/users/admin/secret-password
5221 .endd
5222 For non-admin users, such options are displayed like this:
5223 .code
5224 mysql_servers = <value not displayable>
5225 .endd
5226 If &"hide"& is used on a driver option, it hides the value of that option on
5227 all instances of the same driver.
5228
5229 The following sections describe the syntax used for the different data types
5230 that are found in option settings.
5231
5232
5233 .section "Boolean options" "SECID47"
5234 .cindex "format" "boolean"
5235 .cindex "boolean configuration values"
5236 .oindex "&%no_%&&'xxx'&"
5237 .oindex "&%not_%&&'xxx'&"
5238 Options whose type is given as boolean are on/off switches. There are two
5239 different ways of specifying such options: with and without a data value. If
5240 the option name is specified on its own without data, the switch is turned on;
5241 if it is preceded by &"no_"& or &"not_"& the switch is turned off. However,
5242 boolean options may be followed by an equals sign and one of the words
5243 &"true"&, &"false"&, &"yes"&, or &"no"&, as an alternative syntax. For example,
5244 the following two settings have exactly the same effect:
5245 .code
5246 queue_only
5247 queue_only = true
5248 .endd
5249 The following two lines also have the same (opposite) effect:
5250 .code
5251 no_queue_only
5252 queue_only = false
5253 .endd
5254 You can use whichever syntax you prefer.
5255
5256
5257
5258
5259 .section "Integer values" "SECID48"
5260 .cindex "integer configuration values"
5261 .cindex "format" "integer"
5262 If an option's type is given as &"integer"&, the value can be given in decimal,
5263 hexadecimal, or octal. If it starts with a digit greater than zero, a decimal
5264 number is assumed. Otherwise, it is treated as an octal number unless it starts
5265 with the characters &"0x"&, in which case the remainder is interpreted as a
5266 hexadecimal number.
5267
5268 If an integer value is followed by the letter K, it is multiplied by 1024; if
5269 it is followed by the letter M, it is multiplied by 1024x1024;
5270 if by the letter G, 1024x1024x1024.
5271 When the values
5272 of integer option settings are output, values which are an exact multiple of
5273 1024 or 1024x1024 are sometimes, but not always, printed using the letters K
5274 and M. The printing style is independent of the actual input format that was
5275 used.
5276
5277
5278 .section "Octal integer values" "SECID49"
5279 .cindex "integer format"
5280 .cindex "format" "octal integer"
5281 If an option's type is given as &"octal integer"&, its value is always
5282 interpreted as an octal number, whether or not it starts with the digit zero.
5283 Such options are always output in octal.
5284
5285
5286 .section "Fixed point numbers" "SECID50"
5287 .cindex "fixed point configuration values"
5288 .cindex "format" "fixed point"
5289 If an option's type is given as &"fixed-point"&, its value must be a decimal
5290 integer, optionally followed by a decimal point and up to three further digits.
5291
5292
5293
5294 .section "Time intervals" "SECTtimeformat"
5295 .cindex "time interval" "specifying in configuration"
5296 .cindex "format" "time interval"
5297 A time interval is specified as a sequence of numbers, each followed by one of
5298 the following letters, with no intervening white space:
5299
5300 .table2 30pt
5301 .irow &%s%& seconds
5302 .irow &%m%& minutes
5303 .irow &%h%& hours
5304 .irow &%d%& days
5305 .irow &%w%& weeks
5306 .endtable
5307
5308 For example, &"3h50m"& specifies 3 hours and 50 minutes. The values of time
5309 intervals are output in the same format. Exim does not restrict the values; it
5310 is perfectly acceptable, for example, to specify &"90m"& instead of &"1h30m"&.
5311
5312
5313
5314 .section "String values" "SECTstrings"
5315 .cindex "string" "format of configuration values"
5316 .cindex "format" "string"
5317 If an option's type is specified as &"string"&, the value can be specified with
5318 or without double-quotes. If it does not start with a double-quote, the value
5319 consists of the remainder of the line plus any continuation lines, starting at
5320 the first character after any leading white space, with trailing white space
5321 removed, and with no interpretation of the characters in the string. Because
5322 Exim removes comment lines (those beginning with #) at an early stage, they can
5323 appear in the middle of a multi-line string. The following two settings are
5324 therefore equivalent:
5325 .code
5326 trusted_users = uucp:mail
5327 trusted_users = uucp:\
5328                 # This comment line is ignored
5329                 mail
5330 .endd
5331 .cindex "string" "quoted"
5332 .cindex "escape characters in quoted strings"
5333 If a string does start with a double-quote, it must end with a closing
5334 double-quote, and any backslash characters other than those used for line
5335 continuation are interpreted as escape characters, as follows:
5336
5337 .table2 100pt
5338 .irow &`\\`&                     "single backslash"
5339 .irow &`\n`&                     "newline"
5340 .irow &`\r`&                     "carriage return"
5341 .irow &`\t`&                     "tab"
5342 .irow "&`\`&<&'octal digits'&>"  "up to 3 octal digits specify one character"
5343 .irow "&`\x`&<&'hex digits'&>"   "up to 2 hexadecimal digits specify one &&&
5344                                    character"
5345 .endtable
5346
5347 If a backslash is followed by some other character, including a double-quote
5348 character, that character replaces the pair.
5349
5350 Quoting is necessary only if you want to make use of the backslash escapes to
5351 insert special characters, or if you need to specify a value with leading or
5352 trailing spaces. These cases are rare, so quoting is almost never needed in
5353 current versions of Exim. In versions of Exim before 3.14, quoting was required
5354 in order to continue lines, so you may come across older configuration files
5355 and examples that apparently quote unnecessarily.
5356
5357
5358 .section "Expanded strings" "SECID51"
5359 .cindex "expansion" "definition of"
5360 Some strings in the configuration file are subjected to &'string expansion'&,
5361 by which means various parts of the string may be changed according to the
5362 circumstances (see chapter &<<CHAPexpand>>&). The input syntax for such strings
5363 is as just described; in particular, the handling of backslashes in quoted
5364 strings is done as part of the input process, before expansion takes place.
5365 However, backslash is also an escape character for the expander, so any
5366 backslashes that are required for that reason must be doubled if they are
5367 within a quoted configuration string.
5368
5369
5370 .section "User and group names" "SECID52"
5371 .cindex "user name" "format of"
5372 .cindex "format" "user name"
5373 .cindex "groups" "name format"
5374 .cindex "format" "group name"
5375 User and group names are specified as strings, using the syntax described
5376 above, but the strings are interpreted specially. A user or group name must
5377 either consist entirely of digits, or be a name that can be looked up using the
5378 &[getpwnam()]& or &[getgrnam()]& function, as appropriate.
5379
5380
5381 .section "List construction" "SECTlistconstruct"
5382 .cindex "list" "syntax of in configuration"
5383 .cindex "format" "list item in configuration"
5384 .cindex "string" "list, definition of"
5385 The data for some configuration options is a list of items, with colon as the
5386 default separator. Many of these options are shown with type &"string list"& in
5387 the descriptions later in this document. Others are listed as &"domain list"&,
5388 &"host list"&, &"address list"&, or &"local part list"&. Syntactically, they
5389 are all the same; however, those other than &"string list"& are subject to
5390 particular kinds of interpretation, as described in chapter
5391 &<<CHAPdomhosaddlists>>&.
5392
5393 In all these cases, the entire list is treated as a single string as far as the
5394 input syntax is concerned. The &%trusted_users%& setting in section
5395 &<<SECTstrings>>& above is an example. If a colon is actually needed in an item
5396 in a list, it must be entered as two colons. Leading and trailing white space
5397 on each item in a list is ignored. This makes it possible to include items that
5398 start with a colon, and in particular, certain forms of IPv6 address. For
5399 example, the list
5400 .code
5401 local_interfaces = 127.0.0.1 : ::::1
5402 .endd
5403 contains two IP addresses, the IPv4 address 127.0.0.1 and the IPv6 address ::1.
5404
5405 &*Note*&: Although leading and trailing white space is ignored in individual
5406 list items, it is not ignored when parsing the list. The space after the first
5407 colon in the example above is necessary. If it were not there, the list would
5408 be interpreted as the two items 127.0.0.1:: and 1.
5409
5410 .section "Changing list separators" "SECTlistsepchange"
5411 .cindex "list separator" "changing"
5412 .cindex "IPv6" "addresses in lists"
5413 Doubling colons in IPv6 addresses is an unwelcome chore, so a mechanism was
5414 introduced to allow the separator character to be changed. If a list begins
5415 with a left angle bracket, followed by any punctuation character, that
5416 character is used instead of colon as the list separator. For example, the list
5417 above can be rewritten to use a semicolon separator like this:
5418 .code
5419 local_interfaces = <; 127.0.0.1 ; ::1
5420 .endd
5421 This facility applies to all lists, with the exception of the list in
5422 &%log_file_path%&. It is recommended that the use of non-colon separators be
5423 confined to circumstances where they really are needed.
5424
5425 .cindex "list separator" "newline as"
5426 .cindex "newline" "as list separator"
5427 It is also possible to use newline and other control characters (those with
5428 code values less than 32, plus DEL) as separators in lists. Such separators
5429 must be provided literally at the time the list is processed. For options that
5430 are string-expanded, you can write the separator using a normal escape
5431 sequence. This will be processed by the expander before the string is
5432 interpreted as a list. For example, if a newline-separated list of domains is
5433 generated by a lookup, you can process it directly by a line such as this:
5434 .code
5435 domains = <\n ${lookup mysql{.....}}
5436 .endd
5437 This avoids having to change the list separator in such data. You are unlikely
5438 to want to use a control character as a separator in an option that is not
5439 expanded, because the value is literal text. However, it can be done by giving
5440 the value in quotes. For example:
5441 .code
5442 local_interfaces = "<\n 127.0.0.1 \n ::1"
5443 .endd
5444 Unlike printing character separators, which can be included in list items by
5445 doubling, it is not possible to include a control character as data when it is
5446 set as the separator. Two such characters in succession are interpreted as
5447 enclosing an empty list item.
5448
5449
5450
5451 .section "Empty items in lists" "SECTempitelis"
5452 .cindex "list" "empty item in"
5453 An empty item at the end of a list is always ignored. In other words, trailing
5454 separator characters are ignored. Thus, the list in
5455 .code
5456 senders = user@domain :
5457 .endd
5458 contains only a single item. If you want to include an empty string as one item
5459 in a list, it must not be the last item. For example, this list contains three
5460 items, the second of which is empty:
5461 .code
5462 senders = user1@domain : : user2@domain
5463 .endd
5464 &*Note*&: There must be white space between the two colons, as otherwise they
5465 are interpreted as representing a single colon data character (and the list
5466 would then contain just one item). If you want to specify a list that contains
5467 just one, empty item, you can do it as in this example:
5468 .code
5469 senders = :
5470 .endd
5471 In this case, the first item is empty, and the second is discarded because it
5472 is at the end of the list.
5473
5474
5475
5476
5477 .section "Format of driver configurations" "SECTfordricon"
5478 .cindex "drivers" "configuration format"
5479 There are separate parts in the configuration for defining routers, transports,
5480 and authenticators. In each part, you are defining a number of driver
5481 instances, each with its own set of options. Each driver instance is defined by
5482 a sequence of lines like this:
5483 .display
5484 <&'instance name'&>:
5485   <&'option'&>
5486   ...
5487   <&'option'&>
5488 .endd
5489 In the following example, the instance name is &(localuser)&, and it is
5490 followed by three options settings:
5491 .code
5492 localuser:
5493   driver = accept
5494   check_local_user
5495   transport = local_delivery
5496 .endd
5497 For each driver instance, you specify which Exim code module it uses &-- by the
5498 setting of the &%driver%& option &-- and (optionally) some configuration
5499 settings. For example, in the case of transports, if you want a transport to
5500 deliver with SMTP you would use the &(smtp)& driver; if you want to deliver to
5501 a local file you would use the &(appendfile)& driver. Each of the drivers is
5502 described in detail in its own separate chapter later in this manual.
5503
5504 You can have several routers, transports, or authenticators that are based on
5505 the same underlying driver (each must have a different instance name).
5506
5507 The order in which routers are defined is important, because addresses are
5508 passed to individual routers one by one, in order. The order in which
5509 transports are defined does not matter at all. The order in which
5510 authenticators are defined is used only when Exim, as a client, is searching
5511 them to find one that matches an authentication mechanism offered by the
5512 server.
5513
5514 .cindex "generic options"
5515 .cindex "options" "generic &-- definition of"
5516 Within a driver instance definition, there are two kinds of option: &'generic'&
5517 and &'private'&. The generic options are those that apply to all drivers of the
5518 same type (that is, all routers, all transports or all authenticators). The
5519 &%driver%& option is a generic option that must appear in every definition.
5520 .cindex "private options"
5521 The private options are special for each driver, and none need appear, because
5522 they all have default values.
5523
5524 The options may appear in any order, except that the &%driver%& option must
5525 precede any private options, since these depend on the particular driver. For
5526 this reason, it is recommended that &%driver%& always be the first option.
5527
5528 Driver instance names, which are used for reference in log entries and
5529 elsewhere, can be any sequence of letters, digits, and underscores (starting
5530 with a letter) and must be unique among drivers of the same type. A router and
5531 a transport (for example) can each have the same name, but no two router
5532 instances can have the same name. The name of a driver instance should not be
5533 confused with the name of the underlying driver module. For example, the
5534 configuration lines:
5535 .code
5536 remote_smtp:
5537   driver = smtp
5538 .endd
5539 create an instance of the &(smtp)& transport driver whose name is
5540 &(remote_smtp)&. The same driver code can be used more than once, with
5541 different instance names and different option settings each time. A second
5542 instance of the &(smtp)& transport, with different options, might be defined
5543 thus:
5544 .code
5545 special_smtp:
5546   driver = smtp
5547   port = 1234
5548   command_timeout = 10s
5549 .endd
5550 The names &(remote_smtp)& and &(special_smtp)& would be used to reference
5551 these transport instances from routers, and these names would appear in log
5552 lines.
5553
5554 Comment lines may be present in the middle of driver specifications. The full
5555 list of option settings for any particular driver instance, including all the
5556 defaulted values, can be extracted by making use of the &%-bP%& command line
5557 option.
5558
5559
5560
5561
5562
5563
5564 . ////////////////////////////////////////////////////////////////////////////
5565 . ////////////////////////////////////////////////////////////////////////////
5566
5567 .chapter "The default configuration file" "CHAPdefconfil"
5568 .scindex IIDconfiwal "configuration file" "default &""walk through""&"
5569 .cindex "default" "configuration file &""walk through""&"
5570 The default configuration file supplied with Exim as &_src/configure.default_&
5571 is sufficient for a host with simple mail requirements. As an introduction to
5572 the way Exim is configured, this chapter &"walks through"& the default
5573 configuration, giving brief explanations of the settings. Detailed descriptions
5574 of the options are given in subsequent chapters. The default configuration file
5575 itself contains extensive comments about ways you might want to modify the
5576 initial settings. However, note that there are many options that are not
5577 mentioned at all in the default configuration.
5578
5579
5580
5581 .section "Macros" "SECTdefconfmacros"
5582 All macros should be defined before any options.
5583
5584 One macro is specified, but commented out, in the default configuration:
5585 .code
5586 # ROUTER_SMARTHOST=MAIL.HOSTNAME.FOR.CENTRAL.SERVER.EXAMPLE
5587 .endd
5588 If all off-site mail is expected to be delivered to a "smarthost", then set the
5589 hostname here and uncomment the macro.  This will affect which router is used
5590 later on.  If this is left commented out, then Exim will perform direct-to-MX
5591 deliveries using a &(dnslookup)& router.
5592
5593 In addition to macros defined here, Exim includes a number of built-in macros
5594 to enable configuration to be guarded by a binary built with support for a
5595 given feature.  See section &<<SECTbuiltinmacros>>& for more details.
5596
5597
5598 .section "Main configuration settings" "SECTdefconfmain"
5599 The main (global) configuration option settings section must always come first
5600 in the file, after the macros.
5601 The first thing you'll see in the file, after some initial comments, is the line
5602 .code
5603 # primary_hostname =
5604 .endd
5605 This is a commented-out setting of the &%primary_hostname%& option. Exim needs
5606 to know the official, fully qualified name of your host, and this is where you
5607 can specify it. However, in most cases you do not need to set this option. When
5608 it is unset, Exim uses the &[uname()]& system function to obtain the host name.
5609
5610 The first three non-comment configuration lines are as follows:
5611 .code
5612 domainlist local_domains    = @
5613 domainlist relay_to_domains =
5614 hostlist   relay_from_hosts = 127.0.0.1
5615 .endd
5616 These are not, in fact, option settings. They are definitions of two named
5617 domain lists and one named host list. Exim allows you to give names to lists of
5618 domains, hosts, and email addresses, in order to make it easier to manage the
5619 configuration file (see section &<<SECTnamedlists>>&).
5620
5621 The first line defines a domain list called &'local_domains'&; this is used
5622 later in the configuration to identify domains that are to be delivered
5623 on the local host.
5624
5625 .cindex "@ in a domain list"
5626 There is just one item in this list, the string &"@"&. This is a special form
5627 of entry which means &"the name of the local host"&. Thus, if the local host is
5628 called &'a.host.example'&, mail to &'any.user@a.host.example'& is expected to
5629 be delivered locally. Because the local host's name is referenced indirectly,
5630 the same configuration file can be used on different hosts.
5631
5632 The second line defines a domain list called &'relay_to_domains'&, but the
5633 list itself is empty. Later in the configuration we will come to the part that
5634 controls mail relaying through the local host; it allows relaying to any
5635 domains in this list. By default, therefore, no relaying on the basis of a mail
5636 domain is permitted.
5637
5638 The third line defines a host list called &'relay_from_hosts'&. This list is
5639 used later in the configuration to permit relaying from any host or IP address
5640 that matches the list. The default contains just the IP address of the IPv4
5641 loopback interface, which means that processes on the local host are able to
5642 submit mail for relaying by sending it over TCP/IP to that interface. No other
5643 hosts are permitted to submit messages for relaying.
5644
5645 Just to be sure there's no misunderstanding: at this point in the configuration
5646 we aren't actually setting up any controls. We are just defining some domains
5647 and hosts that will be used in the controls that are specified later.
5648
5649 The next two configuration lines are genuine option settings:
5650 .code
5651 acl_smtp_rcpt = acl_check_rcpt
5652 acl_smtp_data = acl_check_data
5653 .endd
5654 These options specify &'Access Control Lists'& (ACLs) that are to be used
5655 during an incoming SMTP session for every recipient of a message (every RCPT
5656 command), and after the contents of the message have been received,
5657 respectively. The names of the lists are &'acl_check_rcpt'& and
5658 &'acl_check_data'&, and we will come to their definitions below, in the ACL
5659 section of the configuration. The RCPT ACL controls which recipients are
5660 accepted for an incoming message &-- if a configuration does not provide an ACL
5661 to check recipients, no SMTP mail can be accepted. The DATA ACL allows the
5662 contents of a message to be checked.
5663
5664 Two commented-out option settings are next:
5665 .code
5666 # av_scanner = clamd:/tmp/clamd
5667 # spamd_address = 127.0.0.1 783
5668 .endd
5669 These are example settings that can be used when Exim is compiled with the
5670 content-scanning extension. The first specifies the interface to the virus
5671 scanner, and the second specifies the interface to SpamAssassin. Further
5672 details are given in chapter &<<CHAPexiscan>>&.
5673
5674 Three more commented-out option settings follow:
5675 .code
5676 # tls_advertise_hosts = *
5677 # tls_certificate = /etc/ssl/exim.crt
5678 # tls_privatekey = /etc/ssl/exim.pem
5679 .endd
5680 These are example settings that can be used when Exim is compiled with
5681 support for TLS (aka SSL) as described in section &<<SECTinctlsssl>>&. The
5682 first one specifies the list of clients that are allowed to use TLS when
5683 connecting to this server; in this case, the wildcard means all clients. The
5684 other options specify where Exim should find its TLS certificate and private
5685 key, which together prove the server's identity to any clients that connect.
5686 More details are given in chapter &<<CHAPTLS>>&.
5687
5688 Another two commented-out option settings follow:
5689 .code
5690 # daemon_smtp_ports = 25 : 465 : 587
5691 # tls_on_connect_ports = 465
5692 .endd
5693 .cindex "port" "465 and 587"
5694 .cindex "port" "for message submission"
5695 .cindex "message" "submission, ports for"
5696 .cindex "submissions protocol"
5697 .cindex "smtps protocol"
5698 .cindex "ssmtp protocol"
5699 .cindex "SMTP" "submissions protocol"
5700 .cindex "SMTP" "ssmtp protocol"
5701 .cindex "SMTP" "smtps protocol"
5702 These options provide better support for roaming users who wish to use this
5703 server for message submission. They are not much use unless you have turned on
5704 TLS (as described in the previous paragraph) and authentication (about which
5705 more in section &<<SECTdefconfauth>>&).
5706 Mail submission from mail clients (MUAs) should be separate from inbound mail
5707 to your domain (MX delivery) for various good reasons (eg, ability to impose
5708 much saner TLS protocol and ciphersuite requirements without unintended
5709 consequences).
5710 RFC 6409 (previously 4409) specifies use of port 587 for SMTP Submission,
5711 which uses STARTTLS, so this is the &"submission"& port.
5712 RFC 8314 specifies use of port 465 as the &"submissions"& protocol,
5713 which should be used in preference to 587.
5714 You should also consider deploying SRV records to help clients find
5715 these ports.
5716 Older names for &"submissions"& are &"smtps"& and &"ssmtp"&.
5717
5718 Two more commented-out options settings follow:
5719 .code
5720 # qualify_domain =
5721 # qualify_recipient =
5722 .endd
5723 The first of these specifies a domain that Exim uses when it constructs a
5724 complete email address from a local login name. This is often needed when Exim
5725 receives a message from a local process. If you do not set &%qualify_domain%&,
5726 the value of &%primary_hostname%& is used. If you set both of these options,
5727 you can have different qualification domains for sender and recipient
5728 addresses. If you set only the first one, its value is used in both cases.
5729
5730 .cindex "domain literal" "recognizing format"
5731 The following line must be uncommented if you want Exim to recognize
5732 addresses of the form &'user@[10.11.12.13]'& that is, with a &"domain literal"&
5733 (an IP address within square brackets) instead of a named domain.
5734 .code
5735 # allow_domain_literals
5736 .endd
5737 The RFCs still require this form, but many people think that in the modern
5738 Internet it makes little sense to permit mail to be sent to specific hosts by
5739 quoting their IP addresses. This ancient format has been used by people who
5740 try to abuse hosts by using them for unwanted relaying. However, some
5741 people believe there are circumstances (for example, messages addressed to
5742 &'postmaster'&) where domain literals are still useful.
5743
5744 The next configuration line is a kind of trigger guard:
5745 .code
5746 never_users = root
5747 .endd
5748 It specifies that no delivery must ever be run as the root user. The normal
5749 convention is to set up &'root'& as an alias for the system administrator. This
5750 setting is a guard against slips in the configuration.
5751 The list of users specified by &%never_users%& is not, however, the complete
5752 list; the build-time configuration in &_Local/Makefile_& has an option called
5753 FIXED_NEVER_USERS specifying a list that cannot be overridden. The
5754 contents of &%never_users%& are added to this list. By default
5755 FIXED_NEVER_USERS also specifies root.
5756
5757 When a remote host connects to Exim in order to send mail, the only information
5758 Exim has about the host's identity is its IP address. The next configuration
5759 line,
5760 .code
5761 host_lookup = *
5762 .endd
5763 specifies that Exim should do a reverse DNS lookup on all incoming connections,
5764 in order to get a host name. This improves the quality of the logging
5765 information, but if you feel it is too expensive, you can remove it entirely,
5766 or restrict the lookup to hosts on &"nearby"& networks.
5767 Note that it is not always possible to find a host name from an IP address,
5768 because not all DNS reverse zones are maintained, and sometimes DNS servers are
5769 unreachable.
5770
5771 The next two lines are concerned with &'ident'& callbacks, as defined by RFC
5772 1413 (hence their names):
5773 .code
5774 rfc1413_hosts = *
5775 rfc1413_query_timeout = 0s
5776 .endd
5777 These settings cause Exim to avoid ident callbacks for all incoming SMTP calls.
5778 Few hosts offer RFC1413 service these days; calls have to be
5779 terminated by a timeout and this needlessly delays the startup
5780 of an incoming SMTP connection.
5781 If you have hosts for which you trust RFC1413 and need this
5782 information, you can change this.
5783
5784 This line enables an efficiency SMTP option.  It is negotiated by clients
5785 and not expected to cause problems but can be disabled if needed.
5786 .code
5787 prdr_enable = true
5788 .endd
5789
5790 When Exim receives messages over SMTP connections, it expects all addresses to
5791 be fully qualified with a domain, as required by the SMTP definition. However,
5792 if you are running a server to which simple clients submit messages, you may
5793 find that they send unqualified addresses. The two commented-out options:
5794 .code
5795 # sender_unqualified_hosts =
5796 # recipient_unqualified_hosts =
5797 .endd
5798 show how you can specify hosts that are permitted to send unqualified sender
5799 and recipient addresses, respectively.
5800
5801 The &%log_selector%& option is used to increase the detail of logging
5802 over the default:
5803 .code
5804 log_selector = +smtp_protocol_error +smtp_syntax_error \
5805                +tls_certificate_verified
5806 .endd
5807
5808 The &%percent_hack_domains%& option is also commented out:
5809 .code
5810 # percent_hack_domains =
5811 .endd
5812 It provides a list of domains for which the &"percent hack"& is to operate.
5813 This is an almost obsolete form of explicit email routing. If you do not know
5814 anything about it, you can safely ignore this topic.
5815
5816 The next two settings in the main part of the default configuration are
5817 concerned with messages that have been &"frozen"& on Exim's queue. When a
5818 message is frozen, Exim no longer continues to try to deliver it. Freezing
5819 occurs when a bounce message encounters a permanent failure because the sender
5820 address of the original message that caused the bounce is invalid, so the
5821 bounce cannot be delivered. This is probably the most common case, but there
5822 are also other conditions that cause freezing, and frozen messages are not
5823 always bounce messages.
5824 .code
5825 ignore_bounce_errors_after = 2d
5826 timeout_frozen_after = 7d
5827 .endd
5828 The first of these options specifies that failing bounce messages are to be
5829 discarded after 2 days in the queue. The second specifies that any frozen
5830 message (whether a bounce message or not) is to be timed out (and discarded)
5831 after a week. In this configuration, the first setting ensures that no failing
5832 bounce message ever lasts a week.
5833
5834 Exim queues it's messages in a spool directory. If you expect to have
5835 large queues, you may consider using this option. It splits the spool
5836 directory into subdirectories to avoid file system degradation from
5837 many files in a single directory, resulting in better performance.
5838 Manual manipulation of queued messages becomes more complex (though fortunately
5839 not often needed).
5840 .code
5841 # split_spool_directory = true
5842 .endd
5843
5844 In an ideal world everybody follows the standards. For non-ASCII
5845 messages RFC 2047 is a standard, allowing a maximum line length of 76
5846 characters. Exim adheres that standard and won't process messages which
5847 violate this standard. (Even ${rfc2047:...} expansions will fail.)
5848 In particular, the Exim maintainers have had multiple reports of
5849 problems from Russian administrators of issues until they disable this
5850 check, because of some popular, yet buggy, mail composition software.
5851 .code
5852 # check_rfc2047_length = false
5853 .endd
5854
5855 If you need to be strictly RFC compliant you may wish to disable the
5856 8BITMIME advertisement. Use this, if you exchange mails with systems
5857 that are not 8-bit clean.
5858 .code
5859 # accept_8bitmime = false
5860 .endd
5861
5862 Libraries you use may depend on specific environment settings.  This
5863 imposes a security risk (e.g. PATH). There are two lists:
5864 &%keep_environment%& for the variables to import as they are, and
5865 &%add_environment%& for variables we want to set to a fixed value.
5866 Note that TZ is handled separately, by the $%timezone%$ runtime
5867 option and by the TIMEZONE_DEFAULT buildtime option.
5868 .code
5869 # keep_environment = ^LDAP
5870 # add_environment = PATH=/usr/bin::/bin
5871 .endd
5872
5873
5874 .section "ACL configuration" "SECID54"
5875 .cindex "default" "ACLs"
5876 .cindex "&ACL;" "default configuration"
5877 In the default configuration, the ACL section follows the main configuration.
5878 It starts with the line
5879 .code
5880 begin acl
5881 .endd
5882 and it contains the definitions of two ACLs, called &'acl_check_rcpt'& and
5883 &'acl_check_data'&, that were referenced in the settings of &%acl_smtp_rcpt%&
5884 and &%acl_smtp_data%& above.
5885
5886 .cindex "RCPT" "ACL for"
5887 The first ACL is used for every RCPT command in an incoming SMTP message. Each
5888 RCPT command specifies one of the message's recipients. The ACL statements
5889 are considered in order, until the recipient address is either accepted or
5890 rejected. The RCPT command is then accepted or rejected, according to the
5891 result of the ACL processing.
5892 .code
5893 acl_check_rcpt:
5894 .endd
5895 This line, consisting of a name terminated by a colon, marks the start of the
5896 ACL, and names it.
5897 .code
5898 accept  hosts = :
5899 .endd
5900 This ACL statement accepts the recipient if the sending host matches the list.
5901 But what does that strange list mean? It doesn't actually contain any host
5902 names or IP addresses. The presence of the colon puts an empty item in the
5903 list; Exim matches this only if the incoming message did not come from a remote
5904 host, because in that case, the remote hostname is empty. The colon is
5905 important. Without it, the list itself is empty, and can never match anything.
5906
5907 What this statement is doing is to accept unconditionally all recipients in
5908 messages that are submitted by SMTP from local processes using the standard
5909 input and output (that is, not using TCP/IP). A number of MUAs operate in this
5910 manner.
5911 .code
5912 deny    domains       = +local_domains
5913         local_parts   = ^[.] : ^.*[@%!/|]
5914         message       = Restricted characters in address
5915
5916 deny    domains       = !+local_domains
5917         local_parts   = ^[./|] : ^.*[@%!] : ^.*/\\.\\./
5918         message       = Restricted characters in address
5919 .endd
5920 These statements are concerned with local parts that contain any of the
5921 characters &"@"&, &"%"&, &"!"&, &"/"&, &"|"&, or dots in unusual places.
5922 Although these characters are entirely legal in local parts (in the case of
5923 &"@"& and leading dots, only if correctly quoted), they do not commonly occur
5924 in Internet mail addresses.
5925
5926 The first three have in the past been associated with explicitly routed
5927 addresses (percent is still sometimes used &-- see the &%percent_hack_domains%&
5928 option). Addresses containing these characters are regularly tried by spammers
5929 in an attempt to bypass relaying restrictions, and also by open relay testing
5930 programs. Unless you really need them it is safest to reject these characters
5931 at this early stage. This configuration is heavy-handed in rejecting these
5932 characters for all messages it accepts from remote hosts. This is a deliberate
5933 policy of being as safe as possible.
5934
5935 The first rule above is stricter, and is applied to messages that are addressed
5936 to one of the local domains handled by this host. This is implemented by the
5937 first condition, which restricts it to domains that are listed in the
5938 &'local_domains'& domain list. The &"+"& character is used to indicate a
5939 reference to a named list. In this configuration, there is just one domain in
5940 &'local_domains'&, but in general there may be many.
5941
5942 The second condition on the first statement uses two regular expressions to
5943 block local parts that begin with a dot or contain &"@"&, &"%"&, &"!"&, &"/"&,
5944 or &"|"&. If you have local accounts that include these characters, you will
5945 have to modify this rule.
5946
5947 Empty components (two dots in a row) are not valid in RFC 2822, but Exim
5948 allows them because they have been encountered in practice. (Consider the
5949 common convention of local parts constructed as
5950 &"&'first-initial.second-initial.family-name'&"& when applied to someone like
5951 the author of Exim, who has no second initial.) However, a local part starting
5952 with a dot or containing &"/../"& can cause trouble if it is used as part of a
5953 filename (for example, for a mailing list). This is also true for local parts
5954 that contain slashes. A pipe symbol can also be troublesome if the local part
5955 is incorporated unthinkingly into a shell command line.
5956
5957 The second rule above applies to all other domains, and is less strict. This
5958 allows your own users to send outgoing messages to sites that use slashes
5959 and vertical bars in their local parts. It blocks local parts that begin
5960 with a dot, slash, or vertical bar, but allows these characters within the
5961 local part. However, the sequence &"/../"& is barred. The use of &"@"&, &"%"&,
5962 and &"!"& is blocked, as before. The motivation here is to prevent your users
5963 (or your users' viruses) from mounting certain kinds of attack on remote sites.
5964 .code
5965 accept  local_parts   = postmaster
5966         domains       = +local_domains
5967 .endd
5968 This statement, which has two conditions, accepts an incoming address if the
5969 local part is &'postmaster'& and the domain is one of those listed in the
5970 &'local_domains'& domain list. The &"+"& character is used to indicate a
5971 reference to a named list. In this configuration, there is just one domain in
5972 &'local_domains'&, but in general there may be many.
5973
5974 The presence of this statement means that mail to postmaster is never blocked
5975 by any of the subsequent tests. This can be helpful while sorting out problems
5976 in cases where the subsequent tests are incorrectly denying access.
5977 .code
5978 require verify        = sender
5979 .endd
5980 This statement requires the sender address to be verified before any subsequent
5981 ACL statement can be used. If verification fails, the incoming recipient
5982 address is refused. Verification consists of trying to route the address, to
5983 see if a bounce message could be delivered to it. In the case of remote
5984 addresses, basic verification checks only the domain, but &'callouts'& can be
5985 used for more verification if required. Section &<<SECTaddressverification>>&
5986 discusses the details of address verification.
5987 .code
5988 accept  hosts         = +relay_from_hosts
5989         control       = submission
5990 .endd
5991 This statement accepts the address if the message is coming from one of the
5992 hosts that are defined as being allowed to relay through this host. Recipient
5993 verification is omitted here, because in many cases the clients are dumb MUAs
5994 that do not cope well with SMTP error responses. For the same reason, the
5995 second line specifies &"submission mode"& for messages that are accepted. This
5996 is described in detail in section &<<SECTsubmodnon>>&; it causes Exim to fix
5997 messages that are deficient in some way, for example, because they lack a
5998 &'Date:'& header line. If you are actually relaying out from MTAs, you should
5999 probably add recipient verification here, and disable submission mode.
6000 .code
6001 accept  authenticated = *
6002         control       = submission
6003 .endd
6004 This statement accepts the address if the client host has authenticated itself.
6005 Submission mode is again specified, on the grounds that such messages are most
6006 likely to come from MUAs. The default configuration does not define any
6007 authenticators, though it does include some nearly complete commented-out
6008 examples described in &<<SECTdefconfauth>>&. This means that no client can in
6009 fact authenticate until you complete the authenticator definitions.
6010 .code
6011 require message = relay not permitted
6012         domains = +local_domains : +relay_to_domains
6013 .endd
6014 This statement rejects the address if its domain is neither a local domain nor
6015 one of the domains for which this host is a relay.
6016 .code
6017 require verify = recipient
6018 .endd
6019 This statement requires the recipient address to be verified; if verification
6020 fails, the address is rejected.
6021 .code
6022 # deny    dnslists    = black.list.example
6023 #         message     = rejected because $sender_host_address \
6024 #                       is in a black list at $dnslist_domain\n\
6025 #                       $dnslist_text
6026 #
6027 # warn    dnslists    = black.list.example
6028 #         add_header  = X-Warning: $sender_host_address is in \
6029 #                       a black list at $dnslist_domain
6030 #         log_message = found in $dnslist_domain
6031 .endd
6032 These commented-out lines are examples of how you could configure Exim to check
6033 sending hosts against a DNS black list. The first statement rejects messages
6034 from blacklisted hosts, whereas the second just inserts a warning header
6035 line.
6036 .code
6037 # require verify = csa
6038 .endd
6039 This commented-out line is an example of how you could turn on client SMTP
6040 authorization (CSA) checking. Such checks do DNS lookups for special SRV
6041 records.
6042 .code
6043 accept
6044 .endd
6045 The final statement in the first ACL unconditionally accepts any recipient
6046 address that has successfully passed all the previous tests.
6047 .code
6048 acl_check_data:
6049 .endd
6050 This line marks the start of the second ACL, and names it. Most of the contents
6051 of this ACL are commented out:
6052 .code
6053 # deny    malware   = *
6054 #         message   = This message contains a virus \
6055 #                     ($malware_name).
6056 .endd
6057 These lines are examples of how to arrange for messages to be scanned for
6058 viruses when Exim has been compiled with the content-scanning extension, and a
6059 suitable virus scanner is installed. If the message is found to contain a
6060 virus, it is rejected with the given custom error message.
6061 .code
6062 # warn    spam      = nobody
6063 #         message   = X-Spam_score: $spam_score\n\
6064 #                     X-Spam_score_int: $spam_score_int\n\
6065 #                     X-Spam_bar: $spam_bar\n\
6066 #                     X-Spam_report: $spam_report
6067 .endd
6068 These lines are an example of how to arrange for messages to be scanned by
6069 SpamAssassin when Exim has been compiled with the content-scanning extension,
6070 and SpamAssassin has been installed. The SpamAssassin check is run with
6071 &`nobody`& as its user parameter, and the results are added to the message as a
6072 series of extra header line. In this case, the message is not rejected,
6073 whatever the spam score.
6074 .code
6075 accept
6076 .endd
6077 This final line in the DATA ACL accepts the message unconditionally.
6078
6079
6080 .section "Router configuration" "SECID55"
6081 .cindex "default" "routers"
6082 .cindex "routers" "default"
6083 The router configuration comes next in the default configuration, introduced
6084 by the line
6085 .code
6086 begin routers
6087 .endd
6088 Routers are the modules in Exim that make decisions about where to send
6089 messages. An address is passed to each router, in turn, until it is either
6090 accepted, or failed. This means that the order in which you define the routers
6091 matters. Each router is fully described in its own chapter later in this
6092 manual. Here we give only brief overviews.
6093 .code
6094 # domain_literal:
6095 #   driver = ipliteral
6096 #   domains = !+local_domains
6097 #   transport = remote_smtp
6098 .endd
6099 .cindex "domain literal" "default router"
6100 This router is commented out because the majority of sites do not want to
6101 support domain literal addresses (those of the form &'user@[10.9.8.7]'&). If
6102 you uncomment this router, you also need to uncomment the setting of
6103 &%allow_domain_literals%& in the main part of the configuration.
6104
6105 Which router is used next depends upon whether or not the ROUTER_SMARTHOST
6106 macro has been defined, per
6107 .code
6108 .ifdef ROUTER_SMARTHOST
6109 smarthost:
6110 #...
6111 .else
6112 dnslookup:
6113 #...
6114 .endif
6115 .endd
6116
6117 If ROUTER_SMARTHOST has been defined, either at the top of the file or on the
6118 command-line, then we route all non-local mail to that smarthost; otherwise, we'll
6119 perform DNS lookups for direct-to-MX lookup.  Any mail which is to a local domain will
6120 skip these routers because of the &%domains%& option.
6121
6122 .code
6123 smarthost:
6124   driver = manualroute
6125   domains = ! +local_domains
6126   transport = smarthost_smtp
6127   route_data = ROUTER_SMARTHOST
6128   ignore_target_hosts = <; 0.0.0.0 ; 127.0.0.0/8 ; ::1
6129   no_more
6130 .endd
6131 This router only handles mail which is not to any local domains; this is
6132 specified by the line
6133 .code
6134 domains = ! +local_domains
6135 .endd
6136 The &%domains%& option lists the domains to which this router applies, but the
6137 exclamation mark is a negation sign, so the router is used only for domains
6138 that are not in the domain list called &'local_domains'& (which was defined at
6139 the start of the configuration). The plus sign before &'local_domains'&
6140 indicates that it is referring to a named list. Addresses in other domains are
6141 passed on to the following routers.
6142
6143 The name of the router driver is &(manualroute)& because we are manually
6144 specifying how mail should be routed onwards, instead of using DNS MX.
6145 While the name of this router instance is arbitrary, the &%driver%& option must
6146 be one of the driver modules that is in the Exim binary.
6147
6148 With no pre-conditions other than &%domains%&, all mail for non-local domains
6149 will be handled by this router, and the &%no_more%& setting will ensure that no
6150 other routers will be used for messages matching the pre-conditions.  See
6151 &<<SECTrouprecon>>& for more on how the pre-conditions apply.  For messages which
6152 are handled by this router, we provide a hostname to deliver to in &%route_data%&
6153 and the macro supplies the value; the address is then queued for the
6154 &(smarthost_smtp)& transport.
6155
6156 .code
6157 dnslookup:
6158   driver = dnslookup
6159   domains = ! +local_domains
6160   transport = remote_smtp
6161   ignore_target_hosts = 0.0.0.0 : 127.0.0.0/8
6162   no_more
6163 .endd
6164 The &%domains%& option behaves as per smarthost, above.
6165
6166 The name of the router driver is &(dnslookup)&,
6167 and is specified by the &%driver%& option. Do not be confused by the fact that
6168 the name of this router instance is the same as the name of the driver. The
6169 instance name is arbitrary, but the name set in the &%driver%& option must be
6170 one of the driver modules that is in the Exim binary.
6171
6172 The &(dnslookup)& router routes addresses by looking up their domains in the
6173 DNS in order to obtain a list of hosts to which the address is routed. If the
6174 router succeeds, the address is queued for the &(remote_smtp)& transport, as
6175 specified by the &%transport%& option. If the router does not find the domain
6176 in the DNS, no further routers are tried because of the &%no_more%& setting, so
6177 the address fails and is bounced.
6178
6179 The &%ignore_target_hosts%& option specifies a list of IP addresses that are to
6180 be entirely ignored. This option is present because a number of cases have been
6181 encountered where MX records in the DNS point to host names
6182 whose IP addresses are 0.0.0.0 or are in the 127 subnet (typically 127.0.0.1).
6183 Completely ignoring these IP addresses causes Exim to fail to route the
6184 email address, so it bounces. Otherwise, Exim would log a routing problem, and
6185 continue to try to deliver the message periodically until the address timed
6186 out.
6187 .code
6188 system_aliases:
6189   driver = redirect
6190   allow_fail
6191   allow_defer
6192   data = ${lookup{$local_part}lsearch{/etc/aliases}}
6193 # user = exim
6194   file_transport = address_file
6195   pipe_transport = address_pipe
6196 .endd
6197 Control reaches this and subsequent routers only for addresses in the local
6198 domains. This router checks to see whether the local part is defined as an
6199 alias in the &_/etc/aliases_& file, and if so, redirects it according to the
6200 data that it looks up from that file. If no data is found for the local part,
6201 the value of the &%data%& option is empty, causing the address to be passed to
6202 the next router.
6203
6204 &_/etc/aliases_& is a conventional name for the system aliases file that is
6205 often used. That is why it is referenced by from the default configuration
6206 file. However, you can change this by setting SYSTEM_ALIASES_FILE in
6207 &_Local/Makefile_& before building Exim.
6208 .code
6209 userforward:
6210   driver = redirect
6211   check_local_user
6212 # local_part_suffix = +* : -*
6213 # local_part_suffix_optional
6214   file = $home/.forward
6215 # allow_filter
6216   no_verify
6217   no_expn
6218   check_ancestor
6219   file_transport = address_file
6220   pipe_transport = address_pipe
6221   reply_transport = address_reply
6222 .endd
6223 This is the most complicated router in the default configuration. It is another
6224 redirection router, but this time it is looking for forwarding data set up by
6225 individual users. The &%check_local_user%& setting specifies a check that the
6226 local part of the address is the login name of a local user. If it is not, the
6227 router is skipped. The two commented options that follow &%check_local_user%&,
6228 namely:
6229 .code
6230 # local_part_suffix = +* : -*
6231 # local_part_suffix_optional
6232 .endd
6233 .vindex "&$local_part_suffix$&"
6234 show how you can specify the recognition of local part suffixes. If the first
6235 is uncommented, a suffix beginning with either a plus or a minus sign, followed
6236 by any sequence of characters, is removed from the local part and placed in the
6237 variable &$local_part_suffix$&. The second suffix option specifies that the
6238 presence of a suffix in the local part is optional. When a suffix is present,
6239 the check for a local login uses the local part with the suffix removed.
6240
6241 When a local user account is found, the file called &_.forward_& in the user's
6242 home directory is consulted. If it does not exist, or is empty, the router
6243 declines. Otherwise, the contents of &_.forward_& are interpreted as
6244 redirection data (see chapter &<<CHAPredirect>>& for more details).
6245
6246 .cindex "Sieve filter" "enabling in default router"
6247 Traditional &_.forward_& files contain just a list of addresses, pipes, or
6248 files. Exim supports this by default. However, if &%allow_filter%& is set (it
6249 is commented out by default), the contents of the file are interpreted as a set
6250 of Exim or Sieve filtering instructions, provided the file begins with &"#Exim
6251 filter"& or &"#Sieve filter"&, respectively. User filtering is discussed in the
6252 separate document entitled &'Exim's interfaces to mail filtering'&.
6253
6254 The &%no_verify%& and &%no_expn%& options mean that this router is skipped when
6255 verifying addresses, or when running as a consequence of an SMTP EXPN command.
6256 There are two reasons for doing this:
6257
6258 .olist
6259 Whether or not a local user has a &_.forward_& file is not really relevant when
6260 checking an address for validity; it makes sense not to waste resources doing
6261 unnecessary work.
6262 .next
6263 More importantly, when Exim is verifying addresses or handling an EXPN
6264 command during an SMTP session, it is running as the Exim user, not as root.
6265 The group is the Exim group, and no additional groups are set up.
6266 It may therefore not be possible for Exim to read users' &_.forward_& files at
6267 this time.
6268 .endlist
6269
6270 The setting of &%check_ancestor%& prevents the router from generating a new
6271 address that is the same as any previous address that was redirected. (This
6272 works round a problem concerning a bad interaction between aliasing and
6273 forwarding &-- see section &<<SECTredlocmai>>&).
6274
6275 The final three option settings specify the transports that are to be used when
6276 forwarding generates a direct delivery to a file, or to a pipe, or sets up an
6277 auto-reply, respectively. For example, if a &_.forward_& file contains
6278 .code
6279 a.nother@elsewhere.example, /home/spqr/archive
6280 .endd
6281 the delivery to &_/home/spqr/archive_& is done by running the &%address_file%&
6282 transport.
6283 .code
6284 localuser:
6285   driver = accept
6286   check_local_user
6287 # local_part_suffix = +* : -*
6288 # local_part_suffix_optional
6289   transport = local_delivery
6290 .endd
6291 The final router sets up delivery into local mailboxes, provided that the local
6292 part is the name of a local login, by accepting the address and assigning it to
6293 the &(local_delivery)& transport. Otherwise, we have reached the end of the
6294 routers, so the address is bounced. The commented suffix settings fulfil the
6295 same purpose as they do for the &(userforward)& router.
6296
6297
6298 .section "Transport configuration" "SECID56"
6299 .cindex "default" "transports"
6300 .cindex "transports" "default"
6301 Transports define mechanisms for actually delivering messages. They operate
6302 only when referenced from routers, so the order in which they are defined does
6303 not matter. The transports section of the configuration starts with
6304 .code
6305 begin transports
6306 .endd
6307 Two remote transports and four local transports are defined.
6308 .code
6309 remote_smtp:
6310   driver = smtp
6311   message_size_limit = ${if > {$max_received_linelength}{998} {1}{0}}
6312 .ifdef _HAVE_PRDR
6313   hosts_try_prdr = *
6314 .endif
6315 .endd
6316 This transport is used for delivering messages over SMTP connections.
6317 The list of remote hosts comes from the router.
6318 The &%message_size_limit%& usage is a hack to avoid sending on messages
6319 with over-long lines.
6320
6321 The &%hosts_try_prdr%& option enables an efficiency SMTP option.  It is
6322 negotiated between client and server and not expected to cause problems
6323 but can be disabled if needed.  The built-in macro _HAVE_PRDR guards the
6324 use of the &%hosts_try_prdr%& configuration option.
6325
6326 The other remote transport is used when delivering to a specific smarthost
6327 with whom there must be some kind of existing relationship, instead of the
6328 usual federated system.
6329
6330 .code
6331 smarthost_smtp:
6332   driver = smtp
6333   message_size_limit = ${if > {$max_received_linelength}{998} {1}{0}}
6334   multi_domain
6335   #
6336 .ifdef _HAVE_TLS
6337   # Comment out any of these which you have to, then file a Support
6338   # request with your smarthost provider to get things fixed:
6339   hosts_require_tls = *
6340   tls_verify_hosts = *
6341   # As long as tls_verify_hosts is enabled, this won't matter, but if you
6342   # have to comment it out then this will at least log whether you succeed
6343   # or not:
6344   tls_try_verify_hosts = *
6345   #
6346   # The SNI name should match the name which we'll expect to verify;
6347   # many mail systems don't use SNI and this doesn't matter, but if it does,
6348   # we need to send a name which the remote site will recognize.
6349   # This _should_ be the name which the smarthost operators specified as
6350   # the hostname for sending your mail to.
6351   tls_sni = ROUTER_SMARTHOST
6352   #
6353 .ifdef _HAVE_OPENSSL
6354   tls_require_ciphers = HIGH:!aNULL:@STRENGTH
6355 .endif
6356 .ifdef _HAVE_GNUTLS
6357   tls_require_ciphers = SECURE192:-VERS-SSL3.0:-VERS-TLS1.0:-VERS-TLS1.1
6358 .endif
6359 .endif
6360 .ifdef _HAVE_PRDR
6361   hosts_try_prdr = *
6362 .endif
6363 .endd
6364 After the same &%message_size_limit%& hack, we then specify that this Transport
6365 can handle messages to multiple domains in one run.  The assumption here is
6366 that you're routing all non-local mail to the same place and that place is
6367 happy to take all messages from you as quickly as possible.
6368 All other options depend upon built-in macros; if Exim was built without TLS support
6369 then no other options are defined.
6370 If TLS is available, then we configure "stronger than default" TLS ciphersuites
6371 and versions using the &%tls_require_ciphers%& option, where the value to be
6372 used depends upon the library providing TLS.
6373 Beyond that, the options adopt the stance that you should have TLS support available
6374 from your smarthost on today's Internet, so we turn on requiring TLS for the
6375 mail to be delivered, and requiring that the certificate be valid, and match
6376 the expected hostname.  The &%tls_sni%& option can be used by service providers
6377 to select an appropriate certificate to present to you and here we re-use the
6378 ROUTER_SMARTHOST macro, because that is unaffected by CNAMEs present in DNS.
6379 You want to specify the hostname which you'll expect to validate for, and that
6380 should not be subject to insecure tampering via DNS results.
6381
6382 For the &%hosts_try_prdr%& option see the previous transport.
6383
6384 All other options are defaulted.
6385 .code
6386 local_delivery:
6387   driver = appendfile
6388   file = /var/mail/$local_part_data
6389   delivery_date_add
6390   envelope_to_add
6391   return_path_add
6392 # group = mail
6393 # mode = 0660
6394 .endd
6395 This &(appendfile)& transport is used for local delivery to user mailboxes in
6396 traditional BSD mailbox format.
6397
6398 We prefer to avoid using &$local_part$& directly to define the mailbox filename,
6399 as it is provided by a potential bad actor.
6400 Instead we use &$local_part_data$&,
6401 the result of looking up &$local_part$& in the user database
6402 (done by using &%check_local_user%& in the the router).
6403
6404 By default &(appendfile)& runs under the uid and gid of the
6405 local user, which requires the sticky bit to be set on the &_/var/mail_&
6406 directory. Some systems use the alternative approach of running mail deliveries
6407 under a particular group instead of using the sticky bit. The commented options
6408 show how this can be done.
6409
6410 Exim adds three headers to the message as it delivers it: &'Delivery-date:'&,
6411 &'Envelope-to:'& and &'Return-path:'&. This action is requested by the three
6412 similarly-named options above.
6413 .code
6414 address_pipe:
6415   driver = pipe
6416   return_output
6417 .endd
6418 This transport is used for handling deliveries to pipes that are generated by
6419 redirection (aliasing or users' &_.forward_& files). The &%return_output%&
6420 option specifies that any output on stdout or stderr generated by the pipe is to
6421 be returned to the sender.
6422 .code
6423 address_file:
6424   driver = appendfile
6425   delivery_date_add
6426   envelope_to_add
6427   return_path_add
6428 .endd
6429 This transport is used for handling deliveries to files that are generated by
6430 redirection. The name of the file is not specified in this instance of
6431 &(appendfile)&, because it comes from the &(redirect)& router.
6432 .code
6433 address_reply:
6434   driver = autoreply
6435 .endd
6436 This transport is used for handling automatic replies generated by users'
6437 filter files.
6438
6439
6440
6441 .section "Default retry rule" "SECID57"
6442 .cindex "retry" "default rule"
6443 .cindex "default" "retry rule"
6444 The retry section of the configuration file contains rules which affect the way
6445 Exim retries deliveries that cannot be completed at the first attempt. It is
6446 introduced by the line
6447 .code
6448 begin retry
6449 .endd
6450 In the default configuration, there is just one rule, which applies to all
6451 errors:
6452 .code
6453 *   *   F,2h,15m; G,16h,1h,1.5; F,4d,6h
6454 .endd
6455 This causes any temporarily failing address to be retried every 15 minutes for
6456 2 hours, then at intervals starting at one hour and increasing by a factor of
6457 1.5 until 16 hours have passed, then every 6 hours up to 4 days. If an address
6458 is not delivered after 4 days of temporary failure, it is bounced. The time is
6459 measured from first failure, not from the time the message was received.
6460
6461 If the retry section is removed from the configuration, or is empty (that is,
6462 if no retry rules are defined), Exim will not retry deliveries. This turns
6463 temporary errors into permanent errors.
6464
6465
6466 .section "Rewriting configuration" "SECID58"
6467 The rewriting section of the configuration, introduced by
6468 .code
6469 begin rewrite
6470 .endd
6471 contains rules for rewriting addresses in messages as they arrive. There are no
6472 rewriting rules in the default configuration file.
6473
6474
6475
6476 .section "Authenticators configuration" "SECTdefconfauth"
6477 .cindex "AUTH" "configuration"
6478 The authenticators section of the configuration, introduced by
6479 .code
6480 begin authenticators
6481 .endd
6482 defines mechanisms for the use of the SMTP AUTH command. The default
6483 configuration file contains two commented-out example authenticators
6484 which support plaintext username/password authentication using the
6485 standard PLAIN mechanism and the traditional but non-standard LOGIN
6486 mechanism, with Exim acting as the server. PLAIN and LOGIN are enough
6487 to support most MUA software.
6488
6489 The example PLAIN authenticator looks like this:
6490 .code
6491 #PLAIN:
6492 #  driver                  = plaintext
6493 #  server_set_id           = $auth2
6494 #  server_prompts          = :
6495 #  server_condition        = Authentication is not yet configured
6496 #  server_advertise_condition = ${if def:tls_in_cipher }
6497 .endd
6498 And the example LOGIN authenticator looks like this:
6499 .code
6500 #LOGIN:
6501 #  driver                  = plaintext
6502 #  server_set_id           = $auth1
6503 #  server_prompts          = <| Username: | Password:
6504 #  server_condition        = Authentication is not yet configured
6505 #  server_advertise_condition = ${if def:tls_in_cipher }
6506 .endd
6507
6508 The &%server_set_id%& option makes Exim remember the authenticated username
6509 in &$authenticated_id$&, which can be used later in ACLs or routers. The
6510 &%server_prompts%& option configures the &(plaintext)& authenticator so
6511 that it implements the details of the specific authentication mechanism,
6512 i.e. PLAIN or LOGIN. The &%server_advertise_condition%& setting controls
6513 when Exim offers authentication to clients; in the examples, this is only
6514 when TLS or SSL has been started, so to enable the authenticators you also
6515 need to add support for TLS as described in section &<<SECTdefconfmain>>&.
6516
6517 The &%server_condition%& setting defines how to verify that the username and
6518 password are correct. In the examples it just produces an error message.
6519 To make the authenticators work, you can use a string expansion
6520 expression like one of the examples in chapter &<<CHAPplaintext>>&.
6521
6522 Beware that the sequence of the parameters to PLAIN and LOGIN differ; the
6523 usercode and password are in different positions.
6524 Chapter &<<CHAPplaintext>>& covers both.
6525
6526 .ecindex IIDconfiwal
6527
6528
6529
6530 . ////////////////////////////////////////////////////////////////////////////
6531 . ////////////////////////////////////////////////////////////////////////////
6532
6533 .chapter "Regular expressions" "CHAPregexp"
6534
6535 .cindex "regular expressions" "library"
6536 .cindex "PCRE"
6537 Exim supports the use of regular expressions in many of its options. It
6538 uses the PCRE regular expression library; this provides regular expression
6539 matching that is compatible with Perl 5. The syntax and semantics of
6540 regular expressions is discussed in
6541 online Perl manpages, in
6542 many Perl reference books, and also in
6543 Jeffrey Friedl's &'Mastering Regular Expressions'&, which is published by
6544 O'Reilly (see &url(http://www.oreilly.com/catalog/regex2/)).
6545 . --- the http: URL here redirects to another page with the ISBN in the URL
6546 . --- where trying to use https: just redirects back to http:, so sticking
6547 . --- to the old URL for now.  2018-09-07.
6548
6549 The documentation for the syntax and semantics of the regular expressions that
6550 are supported by PCRE is included in the PCRE distribution, and no further
6551 description is included here. The PCRE functions are called from Exim using
6552 the default option settings (that is, with no PCRE options set), except that
6553 the PCRE_CASELESS option is set when the matching is required to be
6554 case-insensitive.
6555
6556 In most cases, when a regular expression is required in an Exim configuration,
6557 it has to start with a circumflex, in order to distinguish it from plain text
6558 or an &"ends with"& wildcard. In this example of a configuration setting, the
6559 second item in the colon-separated list is a regular expression.
6560 .code
6561 domains = a.b.c : ^\\d{3} : *.y.z : ...
6562 .endd
6563 The doubling of the backslash is required because of string expansion that
6564 precedes interpretation &-- see section &<<SECTlittext>>& for more discussion
6565 of this issue, and a way of avoiding the need for doubling backslashes. The
6566 regular expression that is eventually used in this example contains just one
6567 backslash. The circumflex is included in the regular expression, and has the
6568 normal effect of &"anchoring"& it to the start of the string that is being
6569 matched.
6570
6571 There are, however, two cases where a circumflex is not required for the
6572 recognition of a regular expression: these are the &%match%& condition in a
6573 string expansion, and the &%matches%& condition in an Exim filter file. In
6574 these cases, the relevant string is always treated as a regular expression; if
6575 it does not start with a circumflex, the expression is not anchored, and can
6576 match anywhere in the subject string.
6577
6578 In all cases, if you want a regular expression to match at the end of a string,
6579 you must code the $ metacharacter to indicate this. For example:
6580 .code
6581 domains = ^\\d{3}\\.example
6582 .endd
6583 matches the domain &'123.example'&, but it also matches &'123.example.com'&.
6584 You need to use:
6585 .code
6586 domains = ^\\d{3}\\.example\$
6587 .endd
6588 if you want &'example'& to be the top-level domain. The backslash before the
6589 $ is needed because string expansion also interprets dollar characters.
6590
6591
6592
6593 . ////////////////////////////////////////////////////////////////////////////
6594 . ////////////////////////////////////////////////////////////////////////////
6595
6596 .chapter "File and database lookups" "CHAPfdlookup"
6597 .scindex IIDfidalo1 "file" "lookups"
6598 .scindex IIDfidalo2 "database" "lookups"
6599 .cindex "lookup" "description of"
6600 Exim can be configured to look up data in files or databases as it processes
6601 messages. Two different kinds of syntax are used:
6602
6603 .olist
6604 A string that is to be expanded may contain explicit lookup requests. These
6605 cause parts of the string to be replaced by data that is obtained from the
6606 lookup. Lookups of this type are conditional expansion items. Different results
6607 can be defined for the cases of lookup success and failure. See chapter
6608 &<<CHAPexpand>>&, where string expansions are described in detail.
6609 The key for the lookup is &*specified*& as part of the string expansion.
6610 .next
6611 Lists of domains, hosts, and email addresses can contain lookup requests as a
6612 way of avoiding excessively long linear lists. In this case, the data that is
6613 returned by the lookup is often (but not always) discarded; whether the lookup
6614 succeeds or fails is what really counts. These kinds of list are described in
6615 chapter &<<CHAPdomhosaddlists>>&.
6616 The key for the lookup is &*implicit*&,
6617 given by the context in which the list is expanded.
6618 .endlist
6619
6620 String expansions, lists, and lookups interact with each other in such a way
6621 that there is no order in which to describe any one of them that does not
6622 involve references to the others. Each of these three chapters makes more sense
6623 if you have read the other two first. If you are reading this for the first
6624 time, be aware that some of it will make a lot more sense after you have read
6625 chapters &<<CHAPdomhosaddlists>>& and &<<CHAPexpand>>&.
6626
6627 .section "Examples of different lookup syntax" "SECID60"
6628 It is easy to confuse the two different kinds of lookup, especially as the
6629 lists that may contain the second kind are always expanded before being
6630 processed as lists. Therefore, they may also contain lookups of the first kind.
6631 Be careful to distinguish between the following two examples:
6632 .code
6633 domains = ${lookup{$sender_host_address}lsearch{/some/file}}
6634 domains = lsearch;/some/file
6635 .endd
6636 The first uses a string expansion, the result of which must be a domain list.
6637 No strings have been specified for a successful or a failing lookup; the
6638 defaults in this case are the looked-up data and an empty string, respectively.
6639 The expansion takes place before the string is processed as a list, and the
6640 file that is searched could contain lines like this:
6641 .code
6642 192.168.3.4: domain1:domain2:...
6643 192.168.1.9: domain3:domain4:...
6644 .endd
6645 When the lookup succeeds, the result of the expansion is a list of domains (and
6646 possibly other types of item that are allowed in domain lists).
6647 .cindex "tainted data" "de-tainting"
6648 The result of the expansion is not tainted.
6649
6650 In the second example, the lookup is a single item in a domain list. It causes
6651 Exim to use a lookup to see if the domain that is being processed can be found
6652 in the file.
6653 The file could contains lines like this:
6654 .code
6655 domain1:
6656 domain2:
6657 .endd
6658 Any data that follows the keys is not relevant when checking that the domain
6659 matches the list item.
6660
6661 It is possible, though no doubt confusing, to use both kinds of lookup at once.
6662 Consider a file containing lines like this:
6663 .code
6664 192.168.5.6: lsearch;/another/file
6665 .endd
6666 If the value of &$sender_host_address$& is 192.168.5.6, expansion of the
6667 first &%domains%& setting above generates the second setting, which therefore
6668 causes a second lookup to occur.
6669
6670 .new
6671 The lookup type may optionally be followed by a comma
6672 and a comma-separated list of options.
6673 Each option is a &"name=value"& pair.
6674 Whether an option is meaningful depands on the lookup type.
6675
6676 All lookups support the option &"cache=no_rd"&.
6677 If this is given then the cache that Exim manages for lookup results
6678 is not checked before diong the lookup.
6679 The result of the lookup is still written to the cache.
6680 .wen
6681
6682 The rest of this chapter describes the different lookup types that are
6683 available. Any of them can be used in any part of the configuration where a
6684 lookup is permitted.
6685
6686
6687 .section "Lookup types" "SECID61"
6688 .cindex "lookup" "types of"
6689 .cindex "single-key lookup" "definition of"
6690 Two different types of data lookup are implemented:
6691
6692 .ilist
6693 The &'single-key'& type requires the specification of a file in which to look,
6694 and a single key to search for. The key must be a non-empty string for the
6695 lookup to succeed. The lookup type determines how the file is searched.
6696 .cindex "tainted data" "single-key lookups"
6697 The file string may not be tainted
6698
6699 .cindex "tainted data" "de-tainting"
6700 All single-key lookups support the option &"ret=key"&.
6701 If this is given and the lookup
6702 (either underlying implementation or cached value)
6703 returns data, the result is replaced with a non-tainted
6704 version of the lookup key.
6705 .cindex "tainted data" "de-tainting"
6706 .next
6707 .cindex "query-style lookup" "definition of"
6708 The &'query-style'& type accepts a generalized database query. No particular
6709 key value is assumed by Exim for query-style lookups. You can use whichever
6710 Exim variables you need to construct the database query.
6711 .endlist
6712
6713 The code for each lookup type is in a separate source file that is included in
6714 the binary of Exim only if the corresponding compile-time option is set. The
6715 default settings in &_src/EDITME_& are:
6716 .code
6717 LOOKUP_DBM=yes
6718 LOOKUP_LSEARCH=yes
6719 .endd
6720 which means that only linear searching and DBM lookups are included by default.
6721 For some types of lookup (e.g. SQL databases), you need to install appropriate
6722 libraries and header files before building Exim.
6723
6724
6725
6726
6727 .section "Single-key lookup types" "SECTsinglekeylookups"
6728 .cindex "lookup" "single-key types"
6729 .cindex "single-key lookup" "list of types"
6730 The following single-key lookup types are implemented:
6731
6732 .ilist
6733 .cindex "cdb" "description of"
6734 .cindex "lookup" "cdb"
6735 .cindex "binary zero" "in lookup key"
6736 &(cdb)&: The given file is searched as a Constant DataBase file, using the key
6737 string without a terminating binary zero. The cdb format is designed for
6738 indexed files that are read frequently and never updated, except by total
6739 re-creation. As such, it is particularly suitable for large files containing
6740 aliases or other indexed data referenced by an MTA. Information about cdb and
6741 tools for building the files can be found in several places:
6742 .display
6743 &url(https://cr.yp.to/cdb.html)
6744 &url(https://www.corpit.ru/mjt/tinycdb.html)
6745 &url(https://packages.debian.org/stable/utils/freecdb)
6746 &url(https://github.com/philpennock/cdbtools) (in Go)
6747 .endd
6748 A cdb distribution is not needed in order to build Exim with cdb support,
6749 because the code for reading cdb files is included directly in Exim itself.
6750 However, no means of building or testing cdb files is provided with Exim, so
6751 you need to obtain a cdb distribution in order to do this.
6752 .next
6753 .cindex "DBM" "lookup type"
6754 .cindex "lookup" "dbm"
6755 .cindex "binary zero" "in lookup key"
6756 &(dbm)&: Calls to DBM library functions are used to extract data from the given
6757 DBM file by looking up the record with the given key. A terminating binary
6758 zero is included in the key that is passed to the DBM library. See section
6759 &<<SECTdb>>& for a discussion of DBM libraries.
6760
6761 .cindex "Berkeley DB library" "file format"
6762 For all versions of Berkeley DB, Exim uses the DB_HASH style of database
6763 when building DBM files using the &%exim_dbmbuild%& utility. However, when
6764 using Berkeley DB versions 3 or 4, it opens existing databases for reading with
6765 the DB_UNKNOWN option. This enables it to handle any of the types of database
6766 that the library supports, and can be useful for accessing DBM files created by
6767 other applications. (For earlier DB versions, DB_HASH is always used.)
6768 .next
6769 .cindex "lookup" "dbmjz"
6770 .cindex "lookup" "dbm &-- embedded NULs"
6771 .cindex "sasldb2"
6772 .cindex "dbmjz lookup type"
6773 &(dbmjz)&: This is the same as &(dbm)&, except that the lookup key is
6774 interpreted as an Exim list; the elements of the list are joined together with
6775 ASCII NUL characters to form the lookup key.  An example usage would be to
6776 authenticate incoming SMTP calls using the passwords from Cyrus SASL's
6777 &_/etc/sasldb2_& file with the &(gsasl)& authenticator or Exim's own
6778 &(cram_md5)& authenticator.
6779 .next
6780 .cindex "lookup" "dbmnz"
6781 .cindex "lookup" "dbm &-- terminating zero"
6782 .cindex "binary zero" "in lookup key"
6783 .cindex "Courier"
6784 .cindex "&_/etc/userdbshadow.dat_&"
6785 .cindex "dbmnz lookup type"
6786 &(dbmnz)&: This is the same as &(dbm)&, except that a terminating binary zero
6787 is not included in the key that is passed to the DBM library. You may need this
6788 if you want to look up data in files that are created by or shared with some
6789 other application that does not use terminating zeros. For example, you need to
6790 use &(dbmnz)& rather than &(dbm)& if you want to authenticate incoming SMTP
6791 calls using the passwords from Courier's &_/etc/userdbshadow.dat_& file. Exim's
6792 utility program for creating DBM files (&'exim_dbmbuild'&) includes the zeros
6793 by default, but has an option to omit them (see section &<<SECTdbmbuild>>&).
6794 .next
6795 .cindex "lookup" "dsearch"
6796 .cindex "dsearch lookup type"
6797 &(dsearch)&: The given file must be an
6798 absolute
6799 directory path; this is searched for an entry
6800 whose name is the key by calling the &[lstat()]& function.
6801 The key may not
6802 contain any forward slash characters.
6803 If &[lstat()]& succeeds then so does the lookup.
6804 .cindex "tainted data" "dsearch result"
6805 The result is regarded as untainted.
6806
6807 Options for the lookup can be given by appending them after the word "dsearch",
6808 separated by a comma.  Options, if present, are a comma-separated list having
6809 each element starting with a tag name and an equals.
6810
6811 Two options are supported, for the return value and for filtering match
6812 candidates.
6813 The "ret" option requests an alternate result value of
6814 the entire path for the entry. Example:
6815 .code
6816 ${lookup {passwd} dsearch,ret=full {/etc}}
6817 .endd
6818 The default result is just the requested entry.
6819 The "filter" option requests that only directory entries of a given type
6820 are matched. The match value is one of "file", "dir" or "subdir" (the latter
6821 not matching "." or ".."). Example:
6822 .code
6823 ${lookup {passwd} dsearch,filter=file {/etc}}
6824 .endd
6825 The default matching is for any entry type, including directories
6826 and symlinks.
6827
6828 An example of how this
6829 lookup can be used to support virtual domains is given in section
6830 &<<SECTvirtualdomains>>&.
6831 .next
6832 .cindex "lookup" "iplsearch"
6833 .cindex "iplsearch lookup type"
6834 &(iplsearch)&: The given file is a text file containing keys and data. A key is
6835 terminated by a colon or white space or the end of the line. The keys in the
6836 file must be IP addresses, or IP addresses with CIDR masks. Keys that involve
6837 IPv6 addresses must be enclosed in quotes to prevent the first internal colon
6838 being interpreted as a key terminator. For example:
6839 .code
6840 1.2.3.4:           data for 1.2.3.4
6841 192.168.0.0/16:    data for 192.168.0.0/16
6842 "abcd::cdab":      data for abcd::cdab
6843 "abcd:abcd::/32"   data for abcd:abcd::/32
6844 .endd
6845 The key for an &(iplsearch)& lookup must be an IP address (without a mask). The
6846 file is searched linearly, using the CIDR masks where present, until a matching
6847 key is found. The first key that matches is used; there is no attempt to find a
6848 &"best"& match. Apart from the way the keys are matched, the processing for
6849 &(iplsearch)& is the same as for &(lsearch)&.
6850
6851 &*Warning 1*&: Unlike most other single-key lookup types, a file of data for
6852 &(iplsearch)& can &'not'& be turned into a DBM or cdb file, because those
6853 lookup types support only literal keys.
6854
6855 &*Warning 2*&: In a host list, you must always use &(net-iplsearch)& so that
6856 the implicit key is the host's IP address rather than its name (see section
6857 &<<SECThoslispatsikey>>&).
6858
6859 &*Warning 3*&: Do not use an IPv4-mapped IPv6 address for a key; use the
6860 IPv4, in dotted-quad form. (Exim converts IPv4-mapped IPv6 addresses to this
6861 notation before executing the lookup.)
6862
6863 .new
6864 One option is supported, "ret=full", to request the return of the entire line
6865 rather than omitting the key porttion.
6866 Note however that the key portion will have been de-quoted.
6867 .wen
6868
6869 .next
6870 .cindex lookup json
6871 .cindex json "lookup type"
6872 .cindex JSON expansions
6873 &(json)&: The given file is a text file with a JSON structure.
6874 An element of the structure is extracted, defined by the search key.
6875 The key is a list of subelement selectors
6876 (colon-separated by default but changeable in the usual way)
6877 which are applied in turn to select smaller and smaller portions
6878 of the JSON structure.
6879 If a selector is numeric, it must apply to a JSON array; the (zero-based)
6880 nunbered array element is selected.
6881 Otherwise it must apply to a JSON object; the named element is selected.
6882 The final resulting element can be a simple JSON type or a JSON object
6883 or array; for the latter two a string-representation of the JSON
6884 is returned.
6885 For elements of type string, the returned value is de-quoted.
6886
6887
6888 .new
6889 .next
6890 .cindex LMDB
6891 .cindex lookup lmdb
6892 .cindex database lmdb
6893 &(lmdb)&: The given file is an LMDB database.
6894 LMDB is a memory-mapped key-value store,
6895 with API modeled loosely on that of BerkeleyDB.
6896 See &url(https://symas.com/products/lightning-memory-mapped-database/)
6897 for the feature set and operation modes.
6898
6899 Exim provides read-only access via the LMDB C library.
6900 The library can be obtained from &url(https://github.com/LMDB/lmdb)
6901 or your operating system package repository.
6902 To enable LMDB support in Exim set LOOKUP_LMDB=yes in &_Local/Makefile_&.
6903
6904 You will need to separately create the LMDB database file,
6905 possibly using the &"mdb_load"& utility.
6906 .wen
6907
6908
6909 .next
6910 .cindex "linear search"
6911 .cindex "lookup" "lsearch"
6912 .cindex "lsearch lookup type"
6913 .cindex "case sensitivity" "in lsearch lookup"
6914 &(lsearch)&: The given file is a text file that is searched linearly for a
6915 line beginning with the search key, terminated by a colon or white space or the
6916 end of the line. The search is case-insensitive; that is, upper and lower case
6917 letters are treated as the same. The first occurrence of the key that is found
6918 in the file is used.
6919
6920 White space between the key and the colon is permitted. The remainder of the
6921 line, with leading and trailing white space removed, is the data. This can be
6922 continued onto subsequent lines by starting them with any amount of white
6923 space, but only a single space character is included in the data at such a
6924 junction. If the data begins with a colon, the key must be terminated by a
6925 colon, for example:
6926 .code
6927 baduser:  :fail:
6928 .endd
6929 Empty lines and lines beginning with # are ignored, even if they occur in the
6930 middle of an item. This is the traditional textual format of alias files. Note
6931 that the keys in an &(lsearch)& file are literal strings. There is no
6932 wildcarding of any kind.
6933
6934 .cindex "lookup" "lsearch &-- colons in keys"
6935 .cindex "white space" "in lsearch key"
6936 In most &(lsearch)& files, keys are not required to contain colons or #
6937 characters, or white space. However, if you need this feature, it is available.
6938 If a key begins with a doublequote character, it is terminated only by a
6939 matching quote (or end of line), and the normal escaping rules apply to its
6940 contents (see section &<<SECTstrings>>&). An optional colon is permitted after
6941 quoted keys (exactly as for unquoted keys). There is no special handling of
6942 quotes for the data part of an &(lsearch)& line.
6943
6944 .next
6945 .cindex "NIS lookup type"
6946 .cindex "lookup" "NIS"
6947 .cindex "binary zero" "in lookup key"
6948 &(nis)&: The given file is the name of a NIS map, and a NIS lookup is done with
6949 the given key, without a terminating binary zero. There is a variant called
6950 &(nis0)& which does include the terminating binary zero in the key. This is
6951 reportedly needed for Sun-style alias files. Exim does not recognize NIS
6952 aliases; the full map names must be used.
6953
6954 .next
6955 .cindex "wildlsearch lookup type"
6956 .cindex "lookup" "wildlsearch"
6957 .cindex "nwildlsearch lookup type"
6958 .cindex "lookup" "nwildlsearch"
6959 &(wildlsearch)& or &(nwildlsearch)&: These search a file linearly, like
6960 &(lsearch)&, but instead of being interpreted as a literal string, each key in
6961 the file may be wildcarded. The difference between these two lookup types is
6962 that for &(wildlsearch)&, each key in the file is string-expanded before being
6963 used, whereas for &(nwildlsearch)&, no expansion takes place.
6964
6965 .cindex "case sensitivity" "in (n)wildlsearch lookup"
6966 Like &(lsearch)&, the testing is done case-insensitively. However, keys in the
6967 file that are regular expressions can be made case-sensitive by the use of
6968 &`(-i)`& within the pattern. The following forms of wildcard are recognized:
6969
6970 . ==== As this is a nested list, any displays it contains must be indented
6971 . ==== as otherwise they are too far to the left.
6972
6973 .olist
6974 The string may begin with an asterisk to mean &"ends with"&. For example:
6975 .code
6976     *.a.b.c       data for anything.a.b.c
6977     *fish         data for anythingfish
6978 .endd
6979 .next
6980 The string may begin with a circumflex to indicate a regular expression. For
6981 example, for &(wildlsearch)&:
6982 .code
6983     ^\N\d+\.a\.b\N    data for <digits>.a.b
6984 .endd
6985 Note the use of &`\N`& to disable expansion of the contents of the regular
6986 expression. If you are using &(nwildlsearch)&, where the keys are not
6987 string-expanded, the equivalent entry is:
6988 .code
6989     ^\d+\.a\.b        data for <digits>.a.b
6990 .endd
6991 The case-insensitive flag is set at the start of compiling the regular
6992 expression, but it can be turned off by using &`(-i)`& at an appropriate point.
6993 For example, to make the entire pattern case-sensitive:
6994 .code
6995     ^(?-i)\d+\.a\.b        data for <digits>.a.b
6996 .endd
6997
6998 If the regular expression contains white space or colon characters, you must
6999 either quote it (see &(lsearch)& above), or represent these characters in other
7000 ways. For example, &`\s`& can be used for white space and &`\x3A`& for a
7001 colon. This may be easier than quoting, because if you quote, you have to
7002 escape all the backslashes inside the quotes.
7003
7004 &*Note*&: It is not possible to capture substrings in a regular expression
7005 match for later use, because the results of all lookups are cached. If a lookup
7006 is repeated, the result is taken from the cache, and no actual pattern matching
7007 takes place. The values of all the numeric variables are unset after a
7008 &((n)wildlsearch)& match.
7009
7010 .next
7011 Although I cannot see it being of much use, the general matching function that
7012 is used to implement &((n)wildlsearch)& means that the string may begin with a
7013 lookup name terminated by a semicolon, and followed by lookup data. For
7014 example:
7015 .code
7016     cdb;/some/file  data for keys that match the file
7017 .endd
7018 The data that is obtained from the nested lookup is discarded.
7019 .endlist olist
7020
7021 Keys that do not match any of these patterns are interpreted literally. The
7022 continuation rules for the data are the same as for &(lsearch)&, and keys may
7023 be followed by optional colons.
7024
7025 &*Warning*&: Unlike most other single-key lookup types, a file of data for
7026 &((n)wildlsearch)& can &'not'& be turned into a DBM or cdb file, because those
7027 lookup types support only literal keys.
7028
7029 .next
7030 .cindex "spf lookup type"
7031 .cindex "lookup" "spf"
7032 &(spf)&: If Exim is built with SPF support, manual lookups can be done
7033 (as opposed to the standard ACL condition method).
7034 For details see section &<<SECSPF>>&.
7035 .endlist ilist
7036
7037
7038 .section "Query-style lookup types" "SECTquerystylelookups"
7039 .cindex "lookup" "query-style types"
7040 .cindex "query-style lookup" "list of types"
7041 The supported query-style lookup types are listed below. Further details about
7042 many of them are given in later sections.
7043
7044 .ilist
7045 .cindex "DNS" "as a lookup type"
7046 .cindex "lookup" "DNS"
7047 &(dnsdb)&: This does a DNS search for one or more records whose domain names
7048 are given in the supplied query. The resulting data is the contents of the
7049 records. See section &<<SECTdnsdb>>&.
7050 .next
7051 .cindex "InterBase lookup type"
7052 .cindex "lookup" "InterBase"
7053 &(ibase)&: This does a lookup in an InterBase database.
7054 .next
7055 .cindex "LDAP" "lookup type"
7056 .cindex "lookup" "LDAP"
7057 &(ldap)&: This does an LDAP lookup using a query in the form of a URL, and
7058 returns attributes from a single entry. There is a variant called &(ldapm)&
7059 that permits values from multiple entries to be returned. A third variant
7060 called &(ldapdn)& returns the Distinguished Name of a single entry instead of
7061 any attribute values. See section &<<SECTldap>>&.
7062 .next
7063 .cindex "MySQL" "lookup type"
7064 .cindex "lookup" "MySQL"
7065 &(mysql)&: The format of the query is an SQL statement that is passed to a
7066 MySQL database. See section &<<SECTsql>>&.
7067 .next
7068 .cindex "NIS+ lookup type"
7069 .cindex "lookup" "NIS+"
7070 &(nisplus)&: This does a NIS+ lookup using a query that can specify the name of
7071 the field to be returned. See section &<<SECTnisplus>>&.
7072 .next
7073 .cindex "Oracle" "lookup type"
7074 .cindex "lookup" "Oracle"
7075 &(oracle)&: The format of the query is an SQL statement that is passed to an
7076 Oracle database. See section &<<SECTsql>>&.
7077 .next
7078 .cindex "lookup" "passwd"
7079 .cindex "passwd lookup type"
7080 .cindex "&_/etc/passwd_&"
7081 &(passwd)& is a query-style lookup with queries that are just user names. The
7082 lookup calls &[getpwnam()]& to interrogate the system password data, and on
7083 success, the result string is the same as you would get from an &(lsearch)&
7084 lookup on a traditional &_/etc/passwd file_&, though with &`*`& for the
7085 password value. For example:
7086 .code
7087 *:42:42:King Rat:/home/kr:/bin/bash
7088 .endd
7089 .next
7090 .cindex "PostgreSQL lookup type"
7091 .cindex "lookup" "PostgreSQL"
7092 &(pgsql)&: The format of the query is an SQL statement that is passed to a
7093 PostgreSQL database. See section &<<SECTsql>>&.
7094
7095 .next
7096 .cindex "Redis lookup type"
7097 .cindex lookup Redis
7098 &(redis)&: The format of the query is either a simple get or simple set,
7099 passed to a Redis database. See section &<<SECTsql>>&.
7100
7101 .next
7102 .cindex "sqlite lookup type"
7103 .cindex "lookup" "sqlite"
7104 &(sqlite)&: The format of the query is
7105 an SQL statement that is passed to an SQLite database. See section &<<SECTsqlite>>&.
7106
7107 .next
7108 &(testdb)&: This is a lookup type that is used for testing Exim. It is
7109 not likely to be useful in normal operation.
7110 .next
7111 .cindex "whoson lookup type"
7112 .cindex "lookup" "whoson"
7113 . --- still http:-only, 2018-09-07
7114 &(whoson)&: &'Whoson'& (&url(http://whoson.sourceforge.net)) is a protocol that
7115 allows a server to check whether a particular (dynamically allocated) IP
7116 address is currently allocated to a known (trusted) user and, optionally, to
7117 obtain the identity of the said user. For SMTP servers, &'Whoson'& was popular
7118 at one time for &"POP before SMTP"& authentication, but that approach has been
7119 superseded by SMTP authentication. In Exim, &'Whoson'& can be used to implement
7120 &"POP before SMTP"& checking using ACL statements such as
7121 .code
7122 require condition = \
7123   ${lookup whoson {$sender_host_address}{yes}{no}}
7124 .endd
7125 The query consists of a single IP address. The value returned is the name of
7126 the authenticated user, which is stored in the variable &$value$&. However, in
7127 this example, the data in &$value$& is not used; the result of the lookup is
7128 one of the fixed strings &"yes"& or &"no"&.
7129 .endlist
7130
7131
7132
7133 .section "Temporary errors in lookups" "SECID63"
7134 .cindex "lookup" "temporary error in"
7135 Lookup functions can return temporary error codes if the lookup cannot be
7136 completed. For example, an SQL or LDAP database might be unavailable. For this
7137 reason, it is not advisable to use a lookup that might do this for critical
7138 options such as a list of local domains.
7139
7140 When a lookup cannot be completed in a router or transport, delivery
7141 of the message (to the relevant address) is deferred, as for any other
7142 temporary error. In other circumstances Exim may assume the lookup has failed,
7143 or may give up altogether.
7144
7145
7146
7147 .section "Default values in single-key lookups" "SECTdefaultvaluelookups"
7148 .cindex "wildcard lookups"
7149 .cindex "lookup" "default values"
7150 .cindex "lookup" "wildcard"
7151 .cindex "lookup" "* added to type"
7152 .cindex "default" "in single-key lookups"
7153 In this context, a &"default value"& is a value specified by the administrator
7154 that is to be used if a lookup fails.
7155
7156 &*Note:*& This section applies only to single-key lookups. For query-style
7157 lookups, the facilities of the query language must be used. An attempt to
7158 specify a default for a query-style lookup provokes an error.
7159
7160 If &"*"& is added to a single-key lookup type (for example, &%lsearch*%&)
7161 and the initial lookup fails, the key &"*"& is looked up in the file to
7162 provide a default value. See also the section on partial matching below.
7163
7164 .cindex "*@ with single-key lookup"
7165 .cindex "lookup" "*@ added to type"
7166 .cindex "alias file" "per-domain default"
7167 Alternatively, if &"*@"& is added to a single-key lookup type (for example
7168 &%dbm*@%&) then, if the initial lookup fails and the key contains an @
7169 character, a second lookup is done with everything before the last @ replaced
7170 by *. This makes it possible to provide per-domain defaults in alias files
7171 that include the domains in the keys. If the second lookup fails (or doesn't
7172 take place because there is no @ in the key), &"*"& is looked up.
7173 For example, a &(redirect)& router might contain:
7174 .code
7175 data = ${lookup{$local_part@$domain}lsearch*@{/etc/mix-aliases}}
7176 .endd
7177 Suppose the address that is being processed is &'jane@eyre.example'&. Exim
7178 looks up these keys, in this order:
7179 .code
7180 jane@eyre.example
7181 *@eyre.example
7182 *
7183 .endd
7184 The data is taken from whichever key it finds first. &*Note*&: In an
7185 &(lsearch)& file, this does not mean the first of these keys in the file. A
7186 complete scan is done for each key, and only if it is not found at all does
7187 Exim move on to try the next key.
7188
7189
7190
7191 .section "Partial matching in single-key lookups" "SECTpartiallookup"
7192 .cindex "partial matching"
7193 .cindex "wildcard lookups"
7194 .cindex "lookup" "partial matching"
7195 .cindex "lookup" "wildcard"
7196 .cindex "asterisk" "in search type"
7197 The normal operation of a single-key lookup is to search the file for an exact
7198 match with the given key. However, in a number of situations where domains are
7199 being looked up, it is useful to be able to do partial matching. In this case,
7200 information in the file that has a key starting with &"*."& is matched by any
7201 domain that ends with the components that follow the full stop. For example, if
7202 a key in a DBM file is
7203 .code
7204 *.dates.fict.example
7205 .endd
7206 then when partial matching is enabled this is matched by (amongst others)
7207 &'2001.dates.fict.example'& and &'1984.dates.fict.example'&. It is also matched
7208 by &'dates.fict.example'&, if that does not appear as a separate key in the
7209 file.
7210
7211 &*Note*&: Partial matching is not available for query-style lookups. It is
7212 also not available for any lookup items in address lists (see section
7213 &<<SECTaddresslist>>&).
7214
7215 Partial matching is implemented by doing a series of separate lookups using
7216 keys constructed by modifying the original subject key. This means that it can
7217 be used with any of the single-key lookup types, provided that
7218 partial matching keys
7219 beginning with a special prefix (default &"*."&) are included in the data file.
7220 Keys in the file that do not begin with the prefix are matched only by
7221 unmodified subject keys when partial matching is in use.
7222
7223 Partial matching is requested by adding the string &"partial-"& to the front of
7224 the name of a single-key lookup type, for example, &%partial-dbm%&. When this
7225 is done, the subject key is first looked up unmodified; if that fails, &"*."&
7226 is added at the start of the subject key, and it is looked up again. If that
7227 fails, further lookups are tried with dot-separated components removed from the
7228 start of the subject key, one-by-one, and &"*."& added on the front of what
7229 remains.
7230
7231 A minimum number of two non-* components are required. This can be adjusted
7232 by including a number before the hyphen in the search type. For example,
7233 &%partial3-lsearch%& specifies a minimum of three non-* components in the
7234 modified keys. Omitting the number is equivalent to &"partial2-"&. If the
7235 subject key is &'2250.dates.fict.example'& then the following keys are looked
7236 up when the minimum number of non-* components is two:
7237 .code
7238 2250.dates.fict.example
7239 *.2250.dates.fict.example
7240 *.dates.fict.example
7241 *.fict.example
7242 .endd
7243 As soon as one key in the sequence is successfully looked up, the lookup
7244 finishes.
7245
7246 .cindex "lookup" "partial matching &-- changing prefix"
7247 .cindex "prefix" "for partial matching"
7248 The use of &"*."& as the partial matching prefix is a default that can be
7249 changed. The motivation for this feature is to allow Exim to operate with file
7250 formats that are used by other MTAs. A different prefix can be supplied in
7251 parentheses instead of the hyphen after &"partial"&. For example:
7252 .code
7253 domains = partial(.)lsearch;/some/file
7254 .endd
7255 In this example, if the domain is &'a.b.c'&, the sequence of lookups is
7256 &`a.b.c`&, &`.a.b.c`&, and &`.b.c`& (the default minimum of 2 non-wild
7257 components is unchanged). The prefix may consist of any punctuation characters
7258 other than a closing parenthesis. It may be empty, for example:
7259 .code
7260 domains = partial1()cdb;/some/file
7261 .endd
7262 For this example, if the domain is &'a.b.c'&, the sequence of lookups is
7263 &`a.b.c`&, &`b.c`&, and &`c`&.
7264
7265 If &"partial0"& is specified, what happens at the end (when the lookup with
7266 just one non-wild component has failed, and the original key is shortened right
7267 down to the null string) depends on the prefix:
7268
7269 .ilist
7270 If the prefix has zero length, the whole lookup fails.
7271 .next
7272 If the prefix has length 1, a lookup for just the prefix is done. For
7273 example, the final lookup for &"partial0(.)"& is for &`.`& alone.
7274 .next
7275 Otherwise, if the prefix ends in a dot, the dot is removed, and the
7276 remainder is looked up. With the default prefix, therefore, the final lookup is
7277 for &"*"& on its own.
7278 .next
7279 Otherwise, the whole prefix is looked up.
7280 .endlist
7281
7282
7283 If the search type ends in &"*"& or &"*@"& (see section
7284 &<<SECTdefaultvaluelookups>>& above), the search for an ultimate default that
7285 this implies happens after all partial lookups have failed. If &"partial0"& is
7286 specified, adding &"*"& to the search type has no effect with the default
7287 prefix, because the &"*"& key is already included in the sequence of partial
7288 lookups. However, there might be a use for lookup types such as
7289 &"partial0(.)lsearch*"&.
7290
7291 The use of &"*"& in lookup partial matching differs from its use as a wildcard
7292 in domain lists and the like. Partial matching works only in terms of
7293 dot-separated components; a key such as &`*fict.example`&
7294 in a database file is useless, because the asterisk in a partial matching
7295 subject key is always followed by a dot.
7296
7297
7298
7299
7300 .section "Lookup caching" "SECID64"
7301 .cindex "lookup" "caching"
7302 .cindex "caching" "lookup data"
7303 Exim caches all lookup results in order to avoid needless repetition of
7304 lookups. However, because (apart from the daemon) Exim operates as a collection
7305 of independent, short-lived processes, this caching applies only within a
7306 single Exim process. There is no inter-process lookup caching facility.
7307
7308 For single-key lookups, Exim keeps the relevant files open in case there is
7309 another lookup that needs them. In some types of configuration this can lead to
7310 many files being kept open for messages with many recipients. To avoid hitting
7311 the operating system limit on the number of simultaneously open files, Exim
7312 closes the least recently used file when it needs to open more files than its
7313 own internal limit, which can be changed via the &%lookup_open_max%& option.
7314
7315 The single-key lookup files are closed and the lookup caches are flushed at
7316 strategic points during delivery &-- for example, after all routing is
7317 complete.
7318
7319
7320
7321
7322 .section "Quoting lookup data" "SECID65"
7323 .cindex "lookup" "quoting"
7324 .cindex "quoting" "in lookups"
7325 When data from an incoming message is included in a query-style lookup, there
7326 is the possibility of special characters in the data messing up the syntax of
7327 the query. For example, a NIS+ query that contains
7328 .code
7329 [name=$local_part]
7330 .endd
7331 will be broken if the local part happens to contain a closing square bracket.
7332 For NIS+, data can be enclosed in double quotes like this:
7333 .code
7334 [name="$local_part"]
7335 .endd
7336 but this still leaves the problem of a double quote in the data. The rule for
7337 NIS+ is that double quotes must be doubled. Other lookup types have different
7338 rules, and to cope with the differing requirements, an expansion operator
7339 of the following form is provided:
7340 .code
7341 ${quote_<lookup-type>:<string>}
7342 .endd
7343 For example, the safest way to write the NIS+ query is
7344 .code
7345 [name="${quote_nisplus:$local_part}"]
7346 .endd
7347 See chapter &<<CHAPexpand>>& for full coverage of string expansions. The quote
7348 operator can be used for all lookup types, but has no effect for single-key
7349 lookups, since no quoting is ever needed in their key strings.
7350
7351
7352
7353
7354 .section "More about dnsdb" "SECTdnsdb"
7355 .cindex "dnsdb lookup"
7356 .cindex "lookup" "dnsdb"
7357 .cindex "DNS" "as a lookup type"
7358 The &(dnsdb)& lookup type uses the DNS as its database. A simple query consists
7359 of a record type and a domain name, separated by an equals sign. For example,
7360 an expansion string could contain:
7361 .code
7362 ${lookup dnsdb{mx=a.b.example}{$value}fail}
7363 .endd
7364 If the lookup succeeds, the result is placed in &$value$&, which in this case
7365 is used on its own as the result. If the lookup does not succeed, the
7366 &`fail`& keyword causes a &'forced expansion failure'& &-- see section
7367 &<<SECTforexpfai>>& for an explanation of what this means.
7368
7369 The supported DNS record types are A, CNAME, MX, NS, PTR, SOA, SPF, SRV, TLSA
7370 and TXT, and, when Exim is compiled with IPv6 support, AAAA.
7371 If no type is given, TXT is assumed.
7372
7373 For any record type, if multiple records are found, the data is returned as a
7374 concatenation, with newline as the default separator. The order, of course,
7375 depends on the DNS resolver. You can specify a different separator character
7376 between multiple records by putting a right angle-bracket followed immediately
7377 by the new separator at the start of the query. For example:
7378 .code
7379 ${lookup dnsdb{>: a=host1.example}}
7380 .endd
7381 It is permitted to specify a space as the separator character. Further
7382 white space is ignored.
7383 For lookup types that return multiple fields per record,
7384 an alternate field separator can be specified using a comma after the main
7385 separator character, followed immediately by the field separator.
7386
7387 .cindex "PTR record" "in &(dnsdb)& lookup"
7388 When the type is PTR,
7389 the data can be an IP address, written as normal; inversion and the addition of
7390 &%in-addr.arpa%& or &%ip6.arpa%& happens automatically. For example:
7391 .code
7392 ${lookup dnsdb{ptr=192.168.4.5}{$value}fail}
7393 .endd
7394 If the data for a PTR record is not a syntactically valid IP address, it is not
7395 altered and nothing is added.
7396
7397 .cindex "MX record" "in &(dnsdb)& lookup"
7398 .cindex "SRV record" "in &(dnsdb)& lookup"
7399 For an MX lookup, both the preference value and the host name are returned for
7400 each record, separated by a space. For an SRV lookup, the priority, weight,
7401 port, and host name are returned for each record, separated by spaces.
7402 The field separator can be modified as above.
7403
7404 .cindex "TXT record" "in &(dnsdb)& lookup"
7405 .cindex "SPF record" "in &(dnsdb)& lookup"
7406 For TXT records with multiple items of data, only the first item is returned,
7407 unless a field separator is specified.
7408 To concatenate items without a separator, use a semicolon instead.
7409 For SPF records the
7410 default behaviour is to concatenate multiple items without using a separator.
7411 .code
7412 ${lookup dnsdb{>\n,: txt=a.b.example}}
7413 ${lookup dnsdb{>\n; txt=a.b.example}}
7414 ${lookup dnsdb{spf=example.org}}
7415 .endd
7416 It is permitted to specify a space as the separator character. Further
7417 white space is ignored.
7418
7419 .cindex "SOA record" "in &(dnsdb)& lookup"
7420 For an SOA lookup, while no result is obtained the lookup is redone with
7421 successively more leading components dropped from the given domain.
7422 Only the primary-nameserver field is returned unless a field separator is
7423 specified.
7424 .code
7425 ${lookup dnsdb{>:,; soa=a.b.example.com}}
7426 .endd
7427
7428 .section "Dnsdb lookup modifiers" "SECTdnsdb_mod"
7429 .cindex "dnsdb modifiers"
7430 .cindex "modifiers" "dnsdb"
7431 .cindex "options" "dnsdb"
7432 Modifiers for &(dnsdb)& lookups are given by optional keywords,
7433 each followed by a comma,
7434 that may appear before the record type.
7435
7436 The &(dnsdb)& lookup fails only if all the DNS lookups fail. If there is a
7437 temporary DNS error for any of them, the behaviour is controlled by
7438 a defer-option modifier.
7439 The possible keywords are
7440 &"defer_strict"&, &"defer_never"&, and &"defer_lax"&.
7441 With &"strict"& behaviour, any temporary DNS error causes the
7442 whole lookup to defer. With &"never"& behaviour, a temporary DNS error is
7443 ignored, and the behaviour is as if the DNS lookup failed to find anything.
7444 With &"lax"& behaviour, all the queries are attempted, but a temporary DNS
7445 error causes the whole lookup to defer only if none of the other lookups
7446 succeed. The default is &"lax"&, so the following lookups are equivalent:
7447 .code
7448 ${lookup dnsdb{defer_lax,a=one.host.com:two.host.com}}
7449 ${lookup dnsdb{a=one.host.com:two.host.com}}
7450 .endd
7451 Thus, in the default case, as long as at least one of the DNS lookups
7452 yields some data, the lookup succeeds.
7453
7454 .cindex "DNSSEC" "dns lookup"
7455 Use of &(DNSSEC)& is controlled by a dnssec modifier.
7456 The possible keywords are
7457 &"dnssec_strict"&, &"dnssec_lax"&, and &"dnssec_never"&.
7458 With &"strict"& or &"lax"& DNSSEC information is requested
7459 with the lookup.
7460 With &"strict"& a response from the DNS resolver that
7461 is not labelled as authenticated data
7462 is treated as equivalent to a temporary DNS error.
7463 The default is &"lax"&.
7464
7465 See also the &$lookup_dnssec_authenticated$& variable.
7466
7467 .cindex timeout "dns lookup"
7468 .cindex "DNS" timeout
7469 Timeout for the dnsdb lookup can be controlled by a retrans modifier.
7470 The form is &"retrans_VAL"& where VAL is an Exim time specification
7471 (e.g. &"5s"&).
7472 The default value is set by the main configuration option &%dns_retrans%&.
7473
7474 Retries for the dnsdb lookup can be controlled by a retry modifier.
7475 The form if &"retry_VAL"& where VAL is an integer.
7476 The default count is set by the main configuration option &%dns_retry%&.
7477
7478 .cindex caching "of dns lookup"
7479 .cindex TTL "of dns lookup"
7480 .cindex DNS TTL
7481 Dnsdb lookup results are cached within a single process (and its children).
7482 The cache entry lifetime is limited to the smallest time-to-live (TTL)
7483 value of the set of returned DNS records.
7484
7485
7486 .section "Pseudo dnsdb record types" "SECID66"
7487 .cindex "MX record" "in &(dnsdb)& lookup"
7488 By default, both the preference value and the host name are returned for
7489 each MX record, separated by a space. If you want only host names, you can use
7490 the pseudo-type MXH:
7491 .code
7492 ${lookup dnsdb{mxh=a.b.example}}
7493 .endd
7494 In this case, the preference values are omitted, and just the host names are
7495 returned.
7496
7497 .cindex "name server for enclosing domain"
7498 Another pseudo-type is ZNS (for &"zone NS"&). It performs a lookup for NS
7499 records on the given domain, but if none are found, it removes the first
7500 component of the domain name, and tries again. This process continues until NS
7501 records are found or there are no more components left (or there is a DNS
7502 error). In other words, it may return the name servers for a top-level domain,
7503 but it never returns the root name servers. If there are no NS records for the
7504 top-level domain, the lookup fails. Consider these examples:
7505 .code
7506 ${lookup dnsdb{zns=xxx.quercite.com}}
7507 ${lookup dnsdb{zns=xxx.edu}}
7508 .endd
7509 Assuming that in each case there are no NS records for the full domain name,
7510 the first returns the name servers for &%quercite.com%&, and the second returns
7511 the name servers for &%edu%&.
7512
7513 You should be careful about how you use this lookup because, unless the
7514 top-level domain does not exist, the lookup always returns some host names. The
7515 sort of use to which this might be put is for seeing if the name servers for a
7516 given domain are on a blacklist. You can probably assume that the name servers
7517 for the high-level domains such as &%com%& or &%co.uk%& are not going to be on
7518 such a list.
7519
7520 .cindex "CSA" "in &(dnsdb)& lookup"
7521 A third pseudo-type is CSA (Client SMTP Authorization). This looks up SRV
7522 records according to the CSA rules, which are described in section
7523 &<<SECTverifyCSA>>&. Although &(dnsdb)& supports SRV lookups directly, this is
7524 not sufficient because of the extra parent domain search behaviour of CSA. The
7525 result of a successful lookup such as:
7526 .code
7527 ${lookup dnsdb {csa=$sender_helo_name}}
7528 .endd
7529 has two space-separated fields: an authorization code and a target host name.
7530 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
7531 authorization required but absent, or &"?"& for unknown.
7532
7533 .cindex "A+" "in &(dnsdb)& lookup"
7534 The pseudo-type A+ performs an AAAA
7535 and then an A lookup.  All results are returned; defer processing
7536 (see below) is handled separately for each lookup.  Example:
7537 .code
7538 ${lookup dnsdb {>; a+=$sender_helo_name}}
7539 .endd
7540
7541
7542 .section "Multiple dnsdb lookups" "SECID67"
7543 In the previous sections, &(dnsdb)& lookups for a single domain are described.
7544 However, you can specify a list of domains or IP addresses in a single
7545 &(dnsdb)& lookup. The list is specified in the normal Exim way, with colon as
7546 the default separator, but with the ability to change this. For example:
7547 .code
7548 ${lookup dnsdb{one.domain.com:two.domain.com}}
7549 ${lookup dnsdb{a=one.host.com:two.host.com}}
7550 ${lookup dnsdb{ptr = <; 1.2.3.4 ; 4.5.6.8}}
7551 .endd
7552 In order to retain backwards compatibility, there is one special case: if
7553 the lookup type is PTR and no change of separator is specified, Exim looks
7554 to see if the rest of the string is precisely one IPv6 address. In this
7555 case, it does not treat it as a list.
7556
7557 The data from each lookup is concatenated, with newline separators by default,
7558 in the same way that multiple DNS records for a single item are handled. A
7559 different separator can be specified, as described above.
7560
7561
7562
7563
7564 .section "More about LDAP" "SECTldap"
7565 .cindex "LDAP" "lookup, more about"
7566 .cindex "lookup" "LDAP"
7567 .cindex "Solaris" "LDAP"
7568 The original LDAP implementation came from the University of Michigan; this has
7569 become &"Open LDAP"&, and there are now two different releases. Another
7570 implementation comes from Netscape, and Solaris 7 and subsequent releases
7571 contain inbuilt LDAP support. Unfortunately, though these are all compatible at
7572 the lookup function level, their error handling is different. For this reason
7573 it is necessary to set a compile-time variable when building Exim with LDAP, to
7574 indicate which LDAP library is in use. One of the following should appear in
7575 your &_Local/Makefile_&:
7576 .code
7577 LDAP_LIB_TYPE=UMICHIGAN
7578 LDAP_LIB_TYPE=OPENLDAP1
7579 LDAP_LIB_TYPE=OPENLDAP2
7580 LDAP_LIB_TYPE=NETSCAPE
7581 LDAP_LIB_TYPE=SOLARIS
7582 .endd
7583 If LDAP_LIB_TYPE is not set, Exim assumes &`OPENLDAP1`&, which has the
7584 same interface as the University of Michigan version.
7585
7586 There are three LDAP lookup types in Exim. These behave slightly differently in
7587 the way they handle the results of a query:
7588
7589 .ilist
7590 &(ldap)& requires the result to contain just one entry; if there are more, it
7591 gives an error.
7592 .next
7593 &(ldapdn)& also requires the result to contain just one entry, but it is the
7594 Distinguished Name that is returned rather than any attribute values.
7595 .next
7596 &(ldapm)& permits the result to contain more than one entry; the attributes
7597 from all of them are returned.
7598 .endlist
7599
7600
7601 For &(ldap)& and &(ldapm)&, if a query finds only entries with no attributes,
7602 Exim behaves as if the entry did not exist, and the lookup fails. The format of
7603 the data returned by a successful lookup is described in the next section.
7604 First we explain how LDAP queries are coded.
7605
7606
7607 .section "Format of LDAP queries" "SECTforldaque"
7608 .cindex "LDAP" "query format"
7609 An LDAP query takes the form of a URL as defined in RFC 2255. For example, in
7610 the configuration of a &(redirect)& router one might have this setting:
7611 .code
7612 data = ${lookup ldap \
7613   {ldap:///cn=$local_part,o=University%20of%20Cambridge,\
7614   c=UK?mailbox?base?}}
7615 .endd
7616 .cindex "LDAP" "with TLS"
7617 The URL may begin with &`ldap`& or &`ldaps`& if your LDAP library supports
7618 secure (encrypted) LDAP connections. The second of these ensures that an
7619 encrypted TLS connection is used.
7620
7621 With sufficiently modern LDAP libraries, Exim supports forcing TLS over regular
7622 LDAP connections, rather than the SSL-on-connect &`ldaps`&.
7623 See the &%ldap_start_tls%& option.
7624
7625 Starting with Exim 4.83, the initialization of LDAP with TLS is more tightly
7626 controlled. Every part of the TLS configuration can be configured by settings in
7627 &_exim.conf_&. Depending on the version of the client libraries installed on
7628 your system, some of the initialization may have required setting options in
7629 &_/etc/ldap.conf_& or &_~/.ldaprc_& to get TLS working with self-signed
7630 certificates. This revealed a nuance where the current UID that exim was
7631 running as could affect which config files it read. With Exim 4.83, these
7632 methods become optional, only taking effect if not specifically set in
7633 &_exim.conf_&.
7634
7635
7636 .section "LDAP quoting" "SECID68"
7637 .cindex "LDAP" "quoting"
7638 Two levels of quoting are required in LDAP queries, the first for LDAP itself
7639 and the second because the LDAP query is represented as a URL. Furthermore,
7640 within an LDAP query, two different kinds of quoting are required. For this
7641 reason, there are two different LDAP-specific quoting operators.
7642
7643 The &%quote_ldap%& operator is designed for use on strings that are part of
7644 filter specifications. Conceptually, it first does the following conversions on
7645 the string:
7646 .code
7647 *   =>   \2A
7648 (   =>   \28
7649 )   =>   \29
7650 \   =>   \5C
7651 .endd
7652 in accordance with RFC 2254. The resulting string is then quoted according
7653 to the rules for URLs, that is, all non-alphanumeric characters except
7654 .code
7655 ! $ ' - . _ ( ) * +
7656 .endd
7657 are converted to their hex values, preceded by a percent sign. For example:
7658 .code
7659 ${quote_ldap: a(bc)*, a<yz>; }
7660 .endd
7661 yields
7662 .code
7663 %20a%5C28bc%5C29%5C2A%2C%20a%3Cyz%3E%3B%20
7664 .endd
7665 Removing the URL quoting, this is (with a leading and a trailing space):
7666 .code
7667 a\28bc\29\2A, a<yz>;
7668 .endd
7669 The &%quote_ldap_dn%& operator is designed for use on strings that are part of
7670 base DN specifications in queries. Conceptually, it first converts the string
7671 by inserting a backslash in front of any of the following characters:
7672 .code
7673 , + " \ < > ;
7674 .endd
7675 It also inserts a backslash before any leading spaces or # characters, and
7676 before any trailing spaces. (These rules are in RFC 2253.) The resulting string
7677 is then quoted according to the rules for URLs. For example:
7678 .code
7679 ${quote_ldap_dn: a(bc)*, a<yz>; }
7680 .endd
7681 yields
7682 .code
7683 %5C%20a(bc)*%5C%2C%20a%5C%3Cyz%5C%3E%5C%3B%5C%20
7684 .endd
7685 Removing the URL quoting, this is (with a trailing space):
7686 .code
7687 \ a(bc)*\, a\<yz\>\;\
7688 .endd
7689 There are some further comments about quoting in the section on LDAP
7690 authentication below.
7691
7692
7693 .section "LDAP connections" "SECID69"
7694 .cindex "LDAP" "connections"
7695 The connection to an LDAP server may either be over TCP/IP, or, when OpenLDAP
7696 is in use, via a Unix domain socket. The example given above does not specify
7697 an LDAP server. A server that is reached by TCP/IP can be specified in a query
7698 by starting it with
7699 .code
7700 ldap://<hostname>:<port>/...
7701 .endd
7702 If the port (and preceding colon) are omitted, the standard LDAP port (389) is
7703 used. When no server is specified in a query, a list of default servers is
7704 taken from the &%ldap_default_servers%& configuration option. This supplies a
7705 colon-separated list of servers which are tried in turn until one successfully
7706 handles a query, or there is a serious error. Successful handling either
7707 returns the requested data, or indicates that it does not exist. Serious errors
7708 are syntactical, or multiple values when only a single value is expected.
7709 Errors which cause the next server to be tried are connection failures, bind
7710 failures, and timeouts.
7711
7712 For each server name in the list, a port number can be given. The standard way
7713 of specifying a host and port is to use a colon separator (RFC 1738). Because
7714 &%ldap_default_servers%& is a colon-separated list, such colons have to be
7715 doubled. For example
7716 .code
7717 ldap_default_servers = ldap1.example.com::145:ldap2.example.com
7718 .endd
7719 If &%ldap_default_servers%& is unset, a URL with no server name is passed
7720 to the LDAP library with no server name, and the library's default (normally
7721 the local host) is used.
7722
7723 If you are using the OpenLDAP library, you can connect to an LDAP server using
7724 a Unix domain socket instead of a TCP/IP connection. This is specified by using
7725 &`ldapi`& instead of &`ldap`& in LDAP queries. What follows here applies only
7726 to OpenLDAP. If Exim is compiled with a different LDAP library, this feature is
7727 not available.
7728
7729 For this type of connection, instead of a host name for the server, a pathname
7730 for the socket is required, and the port number is not relevant. The pathname
7731 can be specified either as an item in &%ldap_default_servers%&, or inline in
7732 the query. In the former case, you can have settings such as
7733 .code
7734 ldap_default_servers = /tmp/ldap.sock : backup.ldap.your.domain
7735 .endd
7736 When the pathname is given in the query, you have to escape the slashes as
7737 &`%2F`& to fit in with the LDAP URL syntax. For example:
7738 .code
7739 ${lookup ldap {ldapi://%2Ftmp%2Fldap.sock/o=...
7740 .endd
7741 When Exim processes an LDAP lookup and finds that the &"hostname"& is really
7742 a pathname, it uses the Unix domain socket code, even if the query actually
7743 specifies &`ldap`& or &`ldaps`&. In particular, no encryption is used for a
7744 socket connection. This behaviour means that you can use a setting of
7745 &%ldap_default_servers%& such as in the example above with traditional &`ldap`&
7746 or &`ldaps`& queries, and it will work. First, Exim tries a connection via
7747 the Unix domain socket; if that fails, it tries a TCP/IP connection to the
7748 backup host.
7749
7750 If an explicit &`ldapi`& type is given in a query when a host name is
7751 specified, an error is diagnosed. However, if there are more items in
7752 &%ldap_default_servers%&, they are tried. In other words:
7753
7754 .ilist
7755 Using a pathname with &`ldap`& or &`ldaps`& forces the use of the Unix domain
7756 interface.
7757 .next
7758 Using &`ldapi`& with a host name causes an error.
7759 .endlist
7760
7761
7762 Using &`ldapi`& with no host or path in the query, and no setting of
7763 &%ldap_default_servers%&, does whatever the library does by default.
7764
7765
7766
7767 .section "LDAP authentication and control information" "SECID70"
7768 .cindex "LDAP" "authentication"
7769 The LDAP URL syntax provides no way of passing authentication and other control
7770 information to the server. To make this possible, the URL in an LDAP query may
7771 be preceded by any number of <&'name'&>=<&'value'&> settings, separated by
7772 spaces. If a value contains spaces it must be enclosed in double quotes, and
7773 when double quotes are used, backslash is interpreted in the usual way inside
7774 them. The following names are recognized:
7775 .display
7776 &`DEREFERENCE`&  set the dereferencing parameter
7777 &`NETTIME    `&  set a timeout for a network operation
7778 &`USER       `&  set the DN, for authenticating the LDAP bind
7779 &`PASS       `&  set the password, likewise
7780 &`REFERRALS  `&  set the referrals parameter
7781 &`SERVERS    `&  set alternate server list for this query only
7782 &`SIZE       `&  set the limit for the number of entries returned
7783 &`TIME       `&  set the maximum waiting time for a query
7784 .endd
7785 The value of the DEREFERENCE parameter must be one of the words &"never"&,
7786 &"searching"&, &"finding"&, or &"always"&. The value of the REFERRALS parameter
7787 must be &"follow"& (the default) or &"nofollow"&. The latter stops the LDAP
7788 library from trying to follow referrals issued by the LDAP server.
7789
7790 .cindex LDAP timeout
7791 .cindex timeout "LDAP lookup"
7792 The name CONNECT is an obsolete name for NETTIME, retained for
7793 backwards compatibility. This timeout (specified as a number of seconds) is
7794 enforced from the client end for operations that can be carried out over a
7795 network. Specifically, it applies to network connections and calls to the
7796 &'ldap_result()'& function. If the value is greater than zero, it is used if
7797 LDAP_OPT_NETWORK_TIMEOUT is defined in the LDAP headers (OpenLDAP), or
7798 if LDAP_X_OPT_CONNECT_TIMEOUT is defined in the LDAP headers (Netscape
7799 SDK 4.1). A value of zero forces an explicit setting of &"no timeout"& for
7800 Netscape SDK; for OpenLDAP no action is taken.
7801
7802 The TIME parameter (also a number of seconds) is passed to the server to
7803 set a server-side limit on the time taken to complete a search.
7804
7805 The SERVERS parameter allows you to specify an alternate list of ldap servers
7806 to use for an individual lookup.  The global &%ldap_default_servers%& option provides a
7807 default list of ldap servers, and a single lookup can specify a single ldap
7808 server to use.  But when you need to do a lookup with a list of servers that is
7809 different than the default list (maybe different order, maybe a completely
7810 different set of servers), the SERVERS parameter allows you to specify this
7811 alternate list (colon-separated).
7812
7813 Here is an example of an LDAP query in an Exim lookup that uses some of these
7814 values. This is a single line, folded to fit on the page:
7815 .code
7816 ${lookup ldap
7817   {user="cn=manager,o=University of Cambridge,c=UK" pass=secret
7818   ldap:///o=University%20of%20Cambridge,c=UK?sn?sub?(cn=foo)}
7819   {$value}fail}
7820 .endd
7821 The encoding of spaces as &`%20`& is a URL thing which should not be done for
7822 any of the auxiliary data. Exim configuration settings that include lookups
7823 which contain password information should be preceded by &"hide"& to prevent
7824 non-admin users from using the &%-bP%& option to see their values.
7825
7826 The auxiliary data items may be given in any order. The default is no
7827 connection timeout (the system timeout is used), no user or password, no limit
7828 on the number of entries returned, and no time limit on queries.
7829
7830 When a DN is quoted in the USER= setting for LDAP authentication, Exim
7831 removes any URL quoting that it may contain before passing it LDAP. Apparently
7832 some libraries do this for themselves, but some do not. Removing the URL
7833 quoting has two advantages:
7834
7835 .ilist
7836 It makes it possible to use the same &%quote_ldap_dn%& expansion for USER=
7837 DNs as with DNs inside actual queries.
7838 .next
7839 It permits spaces inside USER= DNs.
7840 .endlist
7841
7842 For example, a setting such as
7843 .code
7844 USER=cn=${quote_ldap_dn:$1}
7845 .endd
7846 should work even if &$1$& contains spaces.
7847
7848 Expanded data for the PASS= value should be quoted using the &%quote%&
7849 expansion operator, rather than the LDAP quote operators. The only reason this
7850 field needs quoting is to ensure that it conforms to the Exim syntax, which
7851 does not allow unquoted spaces. For example:
7852 .code
7853 PASS=${quote:$3}
7854 .endd
7855 The LDAP authentication mechanism can be used to check passwords as part of
7856 SMTP authentication. See the &%ldapauth%& expansion string condition in chapter
7857 &<<CHAPexpand>>&.
7858
7859
7860
7861 .section "Format of data returned by LDAP" "SECID71"
7862 .cindex "LDAP" "returned data formats"
7863 The &(ldapdn)& lookup type returns the Distinguished Name from a single entry
7864 as a sequence of values, for example
7865 .code
7866 cn=manager,o=University of Cambridge,c=UK
7867 .endd
7868 The &(ldap)& lookup type generates an error if more than one entry matches the
7869 search filter, whereas &(ldapm)& permits this case, and inserts a newline in
7870 the result between the data from different entries. It is possible for multiple
7871 values to be returned for both &(ldap)& and &(ldapm)&, but in the former case
7872 you know that whatever values are returned all came from a single entry in the
7873 directory.
7874
7875 In the common case where you specify a single attribute in your LDAP query, the
7876 result is not quoted, and does not contain the attribute name. If the attribute
7877 has multiple values, they are separated by commas. Any comma that is
7878 part of an attribute's value is doubled.
7879
7880 If you specify multiple attributes, the result contains space-separated, quoted
7881 strings, each preceded by the attribute name and an equals sign. Within the
7882 quotes, the quote character, backslash, and newline are escaped with
7883 backslashes, and commas are used to separate multiple values for the attribute.
7884 Any commas in attribute values are doubled
7885 (permitting treatment of the values as a comma-separated list).
7886 Apart from the escaping, the string within quotes takes the same form as the
7887 output when a single attribute is requested. Specifying no attributes is the
7888 same as specifying all of an entry's attributes.
7889
7890 Here are some examples of the output format. The first line of each pair is an
7891 LDAP query, and the second is the data that is returned. The attribute called
7892 &%attr1%& has two values, one of them with an embedded comma, whereas
7893 &%attr2%& has only one value. Both attributes are derived from &%attr%&
7894 (they have SUP &%attr%& in their schema definitions).
7895
7896 .code
7897 ldap:///o=base?attr1?sub?(uid=fred)
7898 value1.1,value1,,2
7899
7900 ldap:///o=base?attr2?sub?(uid=fred)
7901 value two
7902
7903 ldap:///o=base?attr?sub?(uid=fred)
7904 value1.1,value1,,2,value two
7905
7906 ldap:///o=base?attr1,attr2?sub?(uid=fred)
7907 attr1="value1.1,value1,,2" attr2="value two"
7908
7909 ldap:///o=base??sub?(uid=fred)
7910 objectClass="top" attr1="value1.1,value1,,2" attr2="value two"
7911 .endd
7912 You can
7913 make use of Exim's &%-be%& option to run expansion tests and thereby check the
7914 results of LDAP lookups.
7915 The &%extract%& operator in string expansions can be used to pick out
7916 individual fields from data that consists of &'key'&=&'value'& pairs.
7917 The &%listextract%& operator should be used to pick out individual values
7918 of attributes, even when only a single value is expected.
7919 The doubling of embedded commas allows you to use the returned data as a
7920 comma separated list (using the "<," syntax for changing the input list separator).
7921
7922
7923
7924
7925 .section "More about NIS+" "SECTnisplus"
7926 .cindex "NIS+ lookup type"
7927 .cindex "lookup" "NIS+"
7928 NIS+ queries consist of a NIS+ &'indexed name'& followed by an optional colon
7929 and field name. If this is given, the result of a successful query is the
7930 contents of the named field; otherwise the result consists of a concatenation
7931 of &'field-name=field-value'& pairs, separated by spaces. Empty values and
7932 values containing spaces are quoted. For example, the query
7933 .code
7934 [name=mg1456],passwd.org_dir
7935 .endd
7936 might return the string
7937 .code
7938 name=mg1456 passwd="" uid=999 gid=999 gcos="Martin Guerre"
7939 home=/home/mg1456 shell=/bin/bash shadow=""
7940 .endd
7941 (split over two lines here to fit on the page), whereas
7942 .code
7943 [name=mg1456],passwd.org_dir:gcos
7944 .endd
7945 would just return
7946 .code
7947 Martin Guerre
7948 .endd
7949 with no quotes. A NIS+ lookup fails if NIS+ returns more than one table entry
7950 for the given indexed key. The effect of the &%quote_nisplus%& expansion
7951 operator is to double any quote characters within the text.
7952
7953
7954
7955 .section "SQL lookups" "SECTsql"
7956 .cindex "SQL lookup types"
7957 .cindex "MySQL" "lookup type"
7958 .cindex "PostgreSQL lookup type"
7959 .cindex "lookup" "MySQL"
7960 .cindex "lookup" "PostgreSQL"
7961 .cindex "Oracle" "lookup type"
7962 .cindex "lookup" "Oracle"
7963 .cindex "InterBase lookup type"
7964 .cindex "lookup" "InterBase"
7965 .cindex "Redis lookup type"
7966 .cindex lookup Redis
7967 Exim can support lookups in InterBase, MySQL, Oracle, PostgreSQL, Redis,
7968 and SQLite
7969 databases. Queries for these databases contain SQL statements, so an example
7970 might be
7971 .code
7972 ${lookup mysql{select mailbox from users where id='userx'}\
7973   {$value}fail}
7974 .endd
7975 If the result of the query contains more than one field, the data for each
7976 field in the row is returned, preceded by its name, so the result of
7977 .code
7978 ${lookup pgsql{select home,name from users where id='userx'}\
7979   {$value}}
7980 .endd
7981 might be
7982 .code
7983 home=/home/userx name="Mister X"
7984 .endd
7985 Empty values and values containing spaces are double quoted, with embedded
7986 quotes escaped by a backslash. If the result of the query contains just one
7987 field, the value is passed back verbatim, without a field name, for example:
7988 .code
7989 Mister X
7990 .endd
7991 If the result of the query yields more than one row, it is all concatenated,
7992 with a newline between the data for each row.
7993
7994
7995 .section "More about MySQL, PostgreSQL, Oracle, InterBase, and Redis" "SECID72"
7996 .cindex "MySQL" "lookup type"
7997 .cindex "PostgreSQL lookup type"
7998 .cindex "lookup" "MySQL"
7999 .cindex "lookup" "PostgreSQL"
8000 .cindex "Oracle" "lookup type"
8001 .cindex "lookup" "Oracle"
8002 .cindex "InterBase lookup type"
8003 .cindex "lookup" "InterBase"
8004 .cindex "Redis lookup type"
8005 .cindex lookup Redis
8006 If any MySQL, PostgreSQL, Oracle, InterBase or Redis lookups are used, the
8007 &%mysql_servers%&, &%pgsql_servers%&, &%oracle_servers%&, &%ibase_servers%&,
8008 or &%redis_servers%&
8009 option (as appropriate) must be set to a colon-separated list of server
8010 information.
8011 .oindex &%mysql_servers%&
8012 .oindex &%pgsql_servers%&
8013 .oindex &%oracle_servers%&
8014 .oindex &%ibase_servers%&
8015 .oindex &%redis_servers%&
8016 (For MySQL and PostgreSQL, the global option need not be set if all
8017 queries contain their own server information &-- see section
8018 &<<SECTspeserque>>&.)
8019 For all but Redis
8020 each item in the list is a slash-separated list of four
8021 items: host name, database name, user name, and password. In the case of
8022 Oracle, the host name field is used for the &"service name"&, and the database
8023 name field is not used and should be empty. For example:
8024 .code
8025 hide oracle_servers = oracle.plc.example//userx/abcdwxyz
8026 .endd
8027 Because password data is sensitive, you should always precede the setting with
8028 &"hide"&, to prevent non-admin users from obtaining the setting via the &%-bP%&
8029 option. Here is an example where two MySQL servers are listed:
8030 .code
8031 hide mysql_servers = localhost/users/root/secret:\
8032                      otherhost/users/root/othersecret
8033 .endd
8034 For MySQL and PostgreSQL, a host may be specified as <&'name'&>:<&'port'&> but
8035 because this is a colon-separated list, the colon has to be doubled. For each
8036 query, these parameter groups are tried in order until a connection is made and
8037 a query is successfully processed. The result of a query may be that no data is
8038 found, but that is still a successful query. In other words, the list of
8039 servers provides a backup facility, not a list of different places to look.
8040
8041 For Redis the global option need not be specified if all queries contain their
8042 own server information &-- see section &<<SECTspeserque>>&.
8043 If specified, the option must be set to a colon-separated list of server
8044 information.
8045 Each item in the list is a slash-separated list of three items:
8046 host, database number, and password.
8047 .olist
8048 The host is required and may be either an IPv4 address and optional
8049 port number (separated by a colon, which needs doubling due to the
8050 higher-level list), or a Unix socket pathname enclosed in parentheses
8051 .next
8052 The database number is optional; if present that number is selected in the backend
8053 .next
8054 The password is optional; if present it is used to authenticate to the backend
8055 .endlist
8056
8057 The &%quote_mysql%&, &%quote_pgsql%&, and &%quote_oracle%& expansion operators
8058 convert newline, tab, carriage return, and backspace to \n, \t, \r, and \b
8059 respectively, and the characters single-quote, double-quote, and backslash
8060 itself are escaped with backslashes.
8061
8062 The &%quote_redis%& expansion operator
8063 escapes whitespace and backslash characters with a backslash.
8064
8065 .section "Specifying the server in the query" "SECTspeserque"
8066 For MySQL, PostgreSQL and Redis lookups (but not currently for Oracle and InterBase),
8067 it is possible to specify a list of servers with an individual query. This is
8068 done by appending a comma-separated option to the query type:
8069 .display
8070 &`,servers=`&&'server1:server2:server3:...'&
8071 .endd
8072 Each item in the list may take one of two forms:
8073 .olist
8074 If it contains no slashes it is assumed to be just a host name. The appropriate
8075 global option (&%mysql_servers%& or &%pgsql_servers%&) is searched for a host
8076 of the same name, and the remaining parameters (database, user, password) are
8077 taken from there.
8078 .next
8079 If it contains any slashes, it is taken as a complete parameter set.
8080 .endlist
8081 The list of servers is used in exactly the same way as the global list.
8082 Once a connection to a server has happened and a query has been
8083 successfully executed, processing of the lookup ceases.
8084
8085 This feature is intended for use in master/slave situations where updates
8086 are occurring and you want to update the master rather than a slave. If the
8087 master is in the list as a backup for reading, you might have a global setting
8088 like this:
8089 .code
8090 mysql_servers = slave1/db/name/pw:\
8091                 slave2/db/name/pw:\
8092                 master/db/name/pw
8093 .endd
8094 In an updating lookup, you could then write:
8095 .code
8096 ${lookup mysql,servers=master {UPDATE ...} }
8097 .endd
8098 That query would then be sent only to the master server. If, on the other hand,
8099 the master is not to be used for reading, and so is not present in the global
8100 option, you can still update it by a query of this form:
8101 .code
8102 ${lookup pgsql,servers=master/db/name/pw {UPDATE ...} }
8103 .endd
8104
8105 An older syntax places the servers specification before the query,
8106 semicolon separated:
8107 .code
8108 ${lookup mysql{servers=master; UPDATE ...} }
8109 .endd
8110 The new version avoids potential issues with tainted
8111 arguments in the query, for explicit expansion.
8112 &*Note*&: server specifications in list-style lookups are still problematic.
8113
8114
8115 .section "Special MySQL features" "SECID73"
8116 For MySQL, an empty host name or the use of &"localhost"& in &%mysql_servers%&
8117 causes a connection to the server on the local host by means of a Unix domain
8118 socket. An alternate socket can be specified in parentheses.
8119 An option group name for MySQL option files can be specified in square brackets;
8120 the default value is &"exim"&.
8121 The full syntax of each item in &%mysql_servers%& is:
8122 .display
8123 <&'hostname'&>::<&'port'&>(<&'socket name'&>)[<&'option group'&>]/&&&
8124   <&'database'&>/<&'user'&>/<&'password'&>
8125 .endd
8126 Any of the four sub-parts of the first field can be omitted. For normal use on
8127 the local host it can be left blank or set to just &"localhost"&.
8128
8129 No database need be supplied &-- but if it is absent here, it must be given in
8130 the queries.
8131
8132 If a MySQL query is issued that does not request any data (an insert, update,
8133 or delete command), the result of the lookup is the number of rows affected.
8134
8135 &*Warning*&: This can be misleading. If an update does not actually change
8136 anything (for example, setting a field to the value it already has), the result
8137 is zero because no rows are affected.
8138
8139
8140 .section "Special PostgreSQL features" "SECID74"
8141 PostgreSQL lookups can also use Unix domain socket connections to the database.
8142 This is usually faster and costs less CPU time than a TCP/IP connection.
8143 However it can be used only if the mail server runs on the same machine as the
8144 database server. A configuration line for PostgreSQL via Unix domain sockets
8145 looks like this:
8146 .code
8147 hide pgsql_servers = (/tmp/.s.PGSQL.5432)/db/user/password : ...
8148 .endd
8149 In other words, instead of supplying a host name, a path to the socket is
8150 given. The path name is enclosed in parentheses so that its slashes aren't
8151 visually confused with the delimiters for the other server parameters.
8152
8153 If a PostgreSQL query is issued that does not request any data (an insert,
8154 update, or delete command), the result of the lookup is the number of rows
8155 affected.
8156
8157 .section "More about SQLite" "SECTsqlite"
8158 .cindex "lookup" "SQLite"
8159 .cindex "sqlite lookup type"
8160 SQLite is different to the other SQL lookups because a filename is required in
8161 addition to the SQL query. An SQLite database is a single file, and there is no
8162 daemon as in the other SQL databases.
8163
8164 .new
8165 .oindex &%sqlite_dbfile%&
8166 There are two ways of
8167 specifying the file.
8168 The first is is by using the &%sqlite_dbfile%& main option.
8169 The second, which allows separate files for each query,
8170 is to use an option appended, comma-separated, to the &"sqlite"&
8171 lookup type word.  The option is the word &"file"&, then an equals,
8172 then the filename.
8173 The filename in this case cannot contain whitespace or open-brace charachters.
8174 .wen
8175
8176 A deprecated method is available, prefixing the query with the filename
8177 separated by white space.
8178 This means that
8179 .cindex "tainted data" "sqlite file"
8180 the query cannot use any tainted values, as that taints
8181 the entire query including the filename - resulting in a refusal to open
8182 the file.
8183
8184 In all the above cases the filename must be an absolute path.
8185
8186 Here is a lookup expansion example:
8187 .code
8188 sqlite_dbfile = /some/thing/sqlitedb
8189 ...
8190 ${lookup sqlite {select name from aliases where id='userx';}}
8191 .endd
8192 In a list, the syntax is similar. For example:
8193 .code
8194 domainlist relay_to_domains = sqlite;\
8195    select * from relays where ip='$sender_host_address';
8196 .endd
8197 The only character affected by the &%quote_sqlite%& operator is a single
8198 quote, which it doubles.
8199
8200 .cindex timeout SQLite
8201 .cindex sqlite "lookup timeout"
8202 The SQLite library handles multiple simultaneous accesses to the database
8203 internally. Multiple readers are permitted, but only one process can
8204 update at once. Attempts to access the database while it is being updated
8205 are rejected after a timeout period, during which the SQLite library
8206 waits for the lock to be released. In Exim, the default timeout is set
8207 to 5 seconds, but it can be changed by means of the &%sqlite_lock_timeout%&
8208 option.
8209
8210 .section "More about Redis" "SECTredis"
8211 .cindex "lookup" "Redis"
8212 .cindex "redis lookup type"
8213 Redis is a non-SQL database. Commands are simple get and set.
8214 Examples:
8215 .code
8216 ${lookup redis{set keyname ${quote_redis:objvalue plus}}}
8217 ${lookup redis{get keyname}}
8218 .endd
8219
8220 As of release 4.91, "lightweight" support for Redis Cluster is available.
8221 Requires &%redis_servers%& list to contain all the servers in the cluster, all
8222 of which must be reachable from the running exim instance. If the cluster has
8223 master/slave replication, the list must contain all the master and slave
8224 servers.
8225
8226 When the Redis Cluster returns a "MOVED" response to a query, Exim does not
8227 immediately follow the redirection but treats the response as a DEFER, moving on
8228 to the next server in the &%redis_servers%& list until the correct server is
8229 reached.
8230
8231 .ecindex IIDfidalo1
8232 .ecindex IIDfidalo2
8233
8234
8235 . ////////////////////////////////////////////////////////////////////////////
8236 . ////////////////////////////////////////////////////////////////////////////
8237
8238 .chapter "Domain, host, address, and local part lists" &&&
8239          "CHAPdomhosaddlists" &&&
8240          "Domain, host, and address lists"
8241 .scindex IIDdohoadli "lists of domains; hosts; etc."
8242 A number of Exim configuration options contain lists of domains, hosts,
8243 email addresses, or local parts. For example, the &%hold_domains%& option
8244 contains a list of domains whose delivery is currently suspended. These lists
8245 are also used as data in ACL statements (see chapter &<<CHAPACL>>&), and as
8246 arguments to expansion conditions such as &%match_domain%&.
8247
8248 Each item in one of these lists is a pattern to be matched against a domain,
8249 host, email address, or local part, respectively. In the sections below, the
8250 different types of pattern for each case are described, but first we cover some
8251 general facilities that apply to all four kinds of list.
8252
8253 Note that other parts of Exim use a &'string list'& which does not
8254 support all the complexity available in
8255 domain, host, address and local part lists.
8256
8257
8258
8259 .section "Expansion of lists" "SECTlistexpand"
8260 .cindex "expansion" "of lists"
8261 Each list is expanded as a single string before it is used.
8262
8263 &'Exception: the router headers_remove option, where list-item
8264 splitting is done before string-expansion.'&
8265
8266 The result of
8267 expansion must be a list, possibly containing empty items, which is split up
8268 into separate items for matching. By default, colon is the separator character,
8269 but this can be varied if necessary. See sections &<<SECTlistconstruct>>& and
8270 &<<SECTempitelis>>& for details of the list syntax; the second of these
8271 discusses the way to specify empty list items.
8272
8273
8274 If the string expansion is forced to fail, Exim behaves as if the item it is
8275 testing (domain, host, address, or local part) is not in the list. Other
8276 expansion failures cause temporary errors.
8277
8278 If an item in a list is a regular expression, backslashes, dollars and possibly
8279 other special characters in the expression must be protected against
8280 misinterpretation by the string expander. The easiest way to do this is to use
8281 the &`\N`& expansion feature to indicate that the contents of the regular
8282 expression should not be expanded. For example, in an ACL you might have:
8283 .code
8284 deny senders = \N^\d{8}\w@.*\.baddomain\.example$\N : \
8285                ${lookup{$domain}lsearch{/badsenders/bydomain}}
8286 .endd
8287 The first item is a regular expression that is protected from expansion by
8288 &`\N`&, whereas the second uses the expansion to obtain a list of unwanted
8289 senders based on the receiving domain.
8290
8291
8292
8293
8294 .section "Negated items in lists" "SECID76"
8295 .cindex "list" "negation"
8296 .cindex "negation" "in lists"
8297 Items in a list may be positive or negative. Negative items are indicated by a
8298 leading exclamation mark, which may be followed by optional white space. A list
8299 defines a set of items (domains, etc). When Exim processes one of these lists,
8300 it is trying to find out whether a domain, host, address, or local part
8301 (respectively) is in the set that is defined by the list. It works like this:
8302
8303 The list is scanned from left to right. If a positive item is matched, the
8304 subject that is being checked is in the set; if a negative item is matched, the
8305 subject is not in the set. If the end of the list is reached without the
8306 subject having matched any of the patterns, it is in the set if the last item
8307 was a negative one, but not if it was a positive one. For example, the list in
8308 .code
8309 domainlist relay_to_domains = !a.b.c : *.b.c
8310 .endd
8311 matches any domain ending in &'.b.c'& except for &'a.b.c'&. Domains that match
8312 neither &'a.b.c'& nor &'*.b.c'& do not match, because the last item in the
8313 list is positive. However, if the setting were
8314 .code
8315 domainlist relay_to_domains = !a.b.c
8316 .endd
8317 then all domains other than &'a.b.c'& would match because the last item in the
8318 list is negative. In other words, a list that ends with a negative item behaves
8319 as if it had an extra item &`:*`& on the end.
8320
8321 Another way of thinking about positive and negative items in lists is to read
8322 the connector as &"or"& after a positive item and as &"and"& after a negative
8323 item.
8324
8325
8326
8327 .section "File names in lists" "SECTfilnamlis"
8328 .cindex "list" "filename in"
8329 If an item in a domain, host, address, or local part list is an absolute
8330 filename (beginning with a slash character), each line of the file is read and
8331 processed as if it were an independent item in the list, except that further
8332 filenames are not allowed,
8333 and no expansion of the data from the file takes place.
8334 Empty lines in the file are ignored, and the file may also contain comment
8335 lines:
8336
8337 .ilist
8338 For domain and host lists, if a # character appears anywhere in a line of the
8339 file, it and all following characters are ignored.
8340 .next
8341 Because local parts may legitimately contain # characters, a comment in an
8342 address list or local part list file is recognized only if # is preceded by
8343 white space or the start of the line. For example:
8344 .code
8345 not#comment@x.y.z   # but this is a comment
8346 .endd
8347 .endlist
8348
8349 Putting a filename in a list has the same effect as inserting each line of the
8350 file as an item in the list (blank lines and comments excepted). However, there
8351 is one important difference: the file is read each time the list is processed,
8352 so if its contents vary over time, Exim's behaviour changes.
8353
8354 If a filename is preceded by an exclamation mark, the sense of any match
8355 within the file is inverted. For example, if
8356 .code
8357 hold_domains = !/etc/nohold-domains
8358 .endd
8359 and the file contains the lines
8360 .code
8361 !a.b.c
8362 *.b.c
8363 .endd
8364 then &'a.b.c'& is in the set of domains defined by &%hold_domains%&, whereas
8365 any domain matching &`*.b.c`& is not.
8366
8367
8368
8369 .section "An lsearch file is not an out-of-line list" "SECID77"
8370 As will be described in the sections that follow, lookups can be used in lists
8371 to provide indexed methods of checking list membership. There has been some
8372 confusion about the way &(lsearch)& lookups work in lists. Because
8373 an &(lsearch)& file contains plain text and is scanned sequentially, it is
8374 sometimes thought that it is allowed to contain wild cards and other kinds of
8375 non-constant pattern. This is not the case. The keys in an &(lsearch)& file are
8376 always fixed strings, just as for any other single-key lookup type.
8377
8378 If you want to use a file to contain wild-card patterns that form part of a
8379 list, just give the filename on its own, without a search type, as described
8380 in the previous section. You could also use the &(wildlsearch)& or
8381 &(nwildlsearch)&, but there is no advantage in doing this.
8382
8383
8384
8385
8386 .section "Results of list checking" SECTlistresults
8387 The primary result of doing a list check is a truth value.
8388 In some contexts additional information is stored
8389 about the list element that matched:
8390 .vlist
8391 .vitem hosts
8392 A &%hosts%& ACL condition
8393 will store a result in the &$host_data$& variable.
8394 .vitem local_parts
8395 A &%local_parts%& router option or &%local_parts%& ACL condition
8396 will store a result in the &$local_part_data$& variable.
8397 .vitem domains
8398 A &%domains%& router option or &%domains%& ACL condition
8399 .vitem senders
8400 A &%senders%& router option or &%senders%& ACL condition
8401 will store a result in the &$sender_data$& variable.
8402 .vitem recipients
8403 A &%recipients%& ACL condition
8404 will store a result in the &$recipient_data$& variable.
8405 .endlist
8406
8407 The detail of the additional information depends on the
8408 type of match and is given below as the &*value*& information.
8409
8410
8411
8412
8413 .section "Named lists" "SECTnamedlists"
8414 .cindex "named lists"
8415 .cindex "list" "named"
8416 A list of domains, hosts, email addresses, or local parts can be given a name
8417 which is then used to refer to the list elsewhere in the configuration. This is
8418 particularly convenient if the same list is required in several different
8419 places. It also allows lists to be given meaningful names, which can improve
8420 the readability of the configuration. For example, it is conventional to define
8421 a domain list called &'local_domains'& for all the domains that are handled
8422 locally on a host, using a configuration line such as
8423 .code
8424 domainlist local_domains = localhost:my.dom.example
8425 .endd
8426 Named lists are referenced by giving their name preceded by a plus sign, so,
8427 for example, a router that is intended to handle local domains would be
8428 configured with the line
8429 .code
8430 domains = +local_domains
8431 .endd
8432 The first router in a configuration is often one that handles all domains
8433 except the local ones, using a configuration with a negated item like this:
8434 .code
8435 dnslookup:
8436   driver = dnslookup
8437   domains = ! +local_domains
8438   transport = remote_smtp
8439   no_more
8440 .endd
8441 The four kinds of named list are created by configuration lines starting with
8442 the words &%domainlist%&, &%hostlist%&, &%addresslist%&, or &%localpartlist%&,
8443 respectively. Then there follows the name that you are defining, followed by an
8444 equals sign and the list itself. For example:
8445 .code
8446 hostlist    relay_from_hosts = 192.168.23.0/24 : my.friend.example
8447 addresslist bad_senders = cdb;/etc/badsenders
8448 .endd
8449 A named list may refer to other named lists:
8450 .code
8451 domainlist  dom1 = first.example : second.example
8452 domainlist  dom2 = +dom1 : third.example
8453 domainlist  dom3 = fourth.example : +dom2 : fifth.example
8454 .endd
8455 &*Warning*&: If the last item in a referenced list is a negative one, the
8456 effect may not be what you intended, because the negation does not propagate
8457 out to the higher level. For example, consider:
8458 .code
8459 domainlist  dom1 = !a.b
8460 domainlist  dom2 = +dom1 : *.b
8461 .endd
8462 The second list specifies &"either in the &%dom1%& list or &'*.b'&"&. The first
8463 list specifies just &"not &'a.b'&"&, so the domain &'x.y'& matches it. That
8464 means it matches the second list as well. The effect is not the same as
8465 .code
8466 domainlist  dom2 = !a.b : *.b
8467 .endd
8468 where &'x.y'& does not match. It's best to avoid negation altogether in
8469 referenced lists if you can.
8470
8471 .cindex "hiding named list values"
8472 .cindex "named lists" "hiding value of"
8473 Some named list definitions may contain sensitive data, for example, passwords for
8474 accessing databases. To stop non-admin users from using the &%-bP%& command
8475 line option to read these values, you can precede the definition with the
8476 word &"hide"&. For example:
8477 .code
8478 hide domainlist filter_for_domains = ldap;PASS=secret ldap::/// ...
8479 .endd
8480
8481
8482 Named lists may have a performance advantage. When Exim is routing an
8483 address or checking an incoming message, it caches the result of tests on named
8484 lists. So, if you have a setting such as
8485 .code
8486 domains = +local_domains
8487 .endd
8488 on several of your routers
8489 or in several ACL statements,
8490 the actual test is done only for the first one. However, the caching works only
8491 if there are no expansions within the list itself or any sublists that it
8492 references. In other words, caching happens only for lists that are known to be
8493 the same each time they are referenced.
8494
8495 By default, there may be up to 16 named lists of each type. This limit can be
8496 extended by changing a compile-time variable. The use of domain and host lists
8497 is recommended for concepts such as local domains, relay domains, and relay
8498 hosts. The default configuration is set up like this.
8499
8500
8501
8502 .section "Named lists compared with macros" "SECID78"
8503 .cindex "list" "named compared with macro"
8504 .cindex "macro" "compared with named list"
8505 At first sight, named lists might seem to be no different from macros in the
8506 configuration file. However, macros are just textual substitutions. If you
8507 write
8508 .code
8509 ALIST = host1 : host2
8510 auth_advertise_hosts = !ALIST
8511 .endd
8512 it probably won't do what you want, because that is exactly the same as
8513 .code
8514 auth_advertise_hosts = !host1 : host2
8515 .endd
8516 Notice that the second host name is not negated. However, if you use a host
8517 list, and write
8518 .code
8519 hostlist alist = host1 : host2
8520 auth_advertise_hosts = ! +alist
8521 .endd
8522 the negation applies to the whole list, and so that is equivalent to
8523 .code
8524 auth_advertise_hosts = !host1 : !host2
8525 .endd
8526
8527
8528 .section "Named list caching" "SECID79"
8529 .cindex "list" "caching of named"
8530 .cindex "caching" "named lists"
8531 While processing a message, Exim caches the result of checking a named list if
8532 it is sure that the list is the same each time. In practice, this means that
8533 the cache operates only if the list contains no $ characters, which guarantees
8534 that it will not change when it is expanded. Sometimes, however, you may have
8535 an expanded list that you know will be the same each time within a given
8536 message. For example:
8537 .code
8538 domainlist special_domains = \
8539            ${lookup{$sender_host_address}cdb{/some/file}}
8540 .endd
8541 This provides a list of domains that depends only on the sending host's IP
8542 address. If this domain list is referenced a number of times (for example,
8543 in several ACL lines, or in several routers) the result of the check is not
8544 cached by default, because Exim does not know that it is going to be the
8545 same list each time.
8546
8547 By appending &`_cache`& to &`domainlist`& you can tell Exim to go ahead and
8548 cache the result anyway. For example:
8549 .code
8550 domainlist_cache special_domains = ${lookup{...
8551 .endd
8552 If you do this, you should be absolutely sure that caching is going to do
8553 the right thing in all cases. When in doubt, leave it out.
8554
8555
8556
8557 .section "Domain lists" "SECTdomainlist"
8558 .cindex "domain list" "patterns for"
8559 .cindex "list" "domain list"
8560 Domain lists contain patterns that are to be matched against a mail domain.
8561 The following types of item may appear in domain lists:
8562
8563 .ilist
8564 .cindex "primary host name"
8565 .cindex "host name" "matched in domain list"
8566 .oindex "&%primary_hostname%&"
8567 .cindex "domain list" "matching primary host name"
8568 .cindex "@ in a domain list"
8569 If a pattern consists of a single @ character, it matches the local host name,
8570 as set by the &%primary_hostname%& option (or defaulted). This makes it
8571 possible to use the same configuration file on several different hosts that
8572 differ only in their names.
8573
8574 The value for a match will be the primary host name.
8575
8576
8577 .next
8578 .cindex "@[] in a domain list"
8579 .cindex "domain list" "matching local IP interfaces"
8580 .cindex "domain literal"
8581 If a pattern consists of the string &`@[]`& it matches an IP address enclosed
8582 in square brackets (as in an email address that contains a domain literal), but
8583 only if that IP address is recognized as local for email routing purposes. The
8584 &%local_interfaces%& and &%extra_local_interfaces%& options can be used to
8585 control which of a host's several IP addresses are treated as local.
8586 In today's Internet, the use of domain literals is controversial;
8587 see the &%allow_domain_literals%& main option.
8588
8589 The value for a match will be the string &`@[]`&.
8590
8591
8592 .next
8593 .cindex "@mx_any"
8594 .cindex "@mx_primary"
8595 .cindex "@mx_secondary"
8596 .cindex "domain list" "matching MX pointers to local host"
8597 If a pattern consists of the string &`@mx_any`& it matches any domain that
8598 has an MX record pointing to the local host or to any host that is listed in
8599 .oindex "&%hosts_treat_as_local%&"
8600 &%hosts_treat_as_local%&. The items &`@mx_primary`& and &`@mx_secondary`&
8601 are similar, except that the first matches only when a primary MX target is the
8602 local host, and the second only when no primary MX target is the local host,
8603 but a secondary MX target is. &"Primary"& means an MX record with the lowest
8604 preference value &-- there may of course be more than one of them.
8605
8606 The MX lookup that takes place when matching a pattern of this type is
8607 performed with the resolver options for widening names turned off. Thus, for
8608 example, a single-component domain will &'not'& be expanded by adding the
8609 resolver's default domain. See the &%qualify_single%& and &%search_parents%&
8610 options of the &(dnslookup)& router for a discussion of domain widening.
8611
8612 Sometimes you may want to ignore certain IP addresses when using one of these
8613 patterns. You can specify this by following the pattern with &`/ignore=`&<&'ip
8614 list'&>, where <&'ip list'&> is a list of IP addresses. These addresses are
8615 ignored when processing the pattern (compare the &%ignore_target_hosts%& option
8616 on a router). For example:
8617 .code
8618 domains = @mx_any/ignore=127.0.0.1
8619 .endd
8620 This example matches any domain that has an MX record pointing to one of
8621 the local host's IP addresses other than 127.0.0.1.
8622
8623 The list of IP addresses is in fact processed by the same code that processes
8624 host lists, so it may contain CIDR-coded network specifications and it may also
8625 contain negative items.
8626
8627 Because the list of IP addresses is a sublist within a domain list, you have to
8628 be careful about delimiters if there is more than one address. Like any other
8629 list, the default delimiter can be changed. Thus, you might have:
8630 .code
8631 domains = @mx_any/ignore=<;127.0.0.1;0.0.0.0 : \
8632           an.other.domain : ...
8633 .endd
8634 so that the sublist uses semicolons for delimiters. When IPv6 addresses are
8635 involved, it is easiest to change the delimiter for the main list as well:
8636 .code
8637 domains = <? @mx_any/ignore=<;127.0.0.1;::1 ? \
8638           an.other.domain ? ...
8639 .endd
8640 The value for a match will be the list element string (starting &`@mx_`&).
8641
8642
8643 .next
8644 .cindex "asterisk" "in domain list"
8645 .cindex "domain list" "asterisk in"
8646 .cindex "domain list" "matching &""ends with""&"
8647 If a pattern starts with an asterisk, the remaining characters of the pattern
8648 are compared with the terminating characters of the domain. The use of &"*"& in
8649 domain lists differs from its use in partial matching lookups. In a domain
8650 list, the character following the asterisk need not be a dot, whereas partial
8651 matching works only in terms of dot-separated components. For example, a domain
8652 list item such as &`*key.ex`& matches &'donkey.ex'& as well as
8653 &'cipher.key.ex'&.
8654
8655 The value for a match will be the list element string (starting with the asterisk).
8656 Additionally, &$0$& will be set to the matched string
8657 and &$1$& to the variable portion which the asterisk matched.
8658
8659 .next
8660 .cindex "regular expressions" "in domain list"
8661 .cindex "domain list" "matching regular expression"
8662 If a pattern starts with a circumflex character, it is treated as a regular
8663 expression, and matched against the domain using a regular expression matching
8664 function. The circumflex is treated as part of the regular expression.
8665 Email domains are case-independent, so this regular expression match is by
8666 default case-independent, but you can make it case-dependent by starting it
8667 with &`(?-i)`&. References to descriptions of the syntax of regular expressions
8668 are given in chapter &<<CHAPregexp>>&.
8669
8670 &*Warning*&: Because domain lists are expanded before being processed, you
8671 must escape any backslash and dollar characters in the regular expression, or
8672 use the special &`\N`& sequence (see chapter &<<CHAPexpand>>&) to specify that
8673 it is not to be expanded (unless you really do want to build a regular
8674 expression by expansion, of course).
8675
8676 The value for a match will be the list element string (starting with the circumflex).
8677 Additionally, &$0$& will be set to the string matching the regular expression,
8678 and &$1$& (onwards) to any submatches identified by parentheses.
8679
8680
8681
8682 .next
8683 .cindex "lookup" "in domain list"
8684 .cindex "domain list" "matching by lookup"
8685 If a pattern starts with the name of a single-key lookup type followed by a
8686 semicolon (for example, &"dbm;"& or &"lsearch;"&), the remainder of the pattern
8687 must be a filename in a suitable format for the lookup type. For example, for
8688 &"cdb;"& it must be an absolute path:
8689 .code
8690 domains = cdb;/etc/mail/local_domains.cdb
8691 .endd
8692 The appropriate type of lookup is done on the file using the domain name as the
8693 key. In most cases, the value resulting from the lookup is not used; Exim is interested
8694 only in whether or not the key is present in the file. However, when a lookup
8695 is used for the &%domains%& option on a router
8696 or a &%domains%& condition in an ACL statement, the value is preserved in the
8697 &$domain_data$& variable and can be referred to in other router options or
8698 other statements in the same ACL.
8699 .cindex "tainted data" "de-tainting"
8700 The value will be untainted.
8701
8702
8703 .next
8704 Any of the single-key lookup type names may be preceded by
8705 &`partial`&<&'n'&>&`-`&, where the <&'n'&> is optional, for example,
8706 .code
8707 domains = partial-dbm;/partial/domains
8708 .endd
8709 This causes partial matching logic to be invoked; a description of how this
8710 works is given in section &<<SECTpartiallookup>>&.
8711
8712 .next
8713 .cindex "asterisk" "in lookup type"
8714 Any of the single-key lookup types may be followed by an asterisk. This causes
8715 a default lookup for a key consisting of a single asterisk to be done if the
8716 original lookup fails. This is not a useful feature when using a domain list to
8717 select particular domains (because any domain would match), but it might have
8718 value if the result of the lookup is being used via the &$domain_data$&
8719 expansion variable.
8720
8721 .next
8722 If the pattern starts with the name of a query-style lookup type followed by a
8723 semicolon (for example, &"nisplus;"& or &"ldap;"&), the remainder of the
8724 pattern must be an appropriate query for the lookup type, as described in
8725 chapter &<<CHAPfdlookup>>&. For example:
8726 .code
8727 hold_domains = mysql;select domain from holdlist \
8728   where domain = '${quote_mysql:$domain}';
8729 .endd
8730 In most cases, the value resulting from the lookup is not used (so for an SQL query, for
8731 example, it doesn't matter what field you select). Exim is interested only in
8732 whether or not the query succeeds. However, when a lookup is used for the
8733 &%domains%& option on a router, the value is preserved in the &$domain_data$&
8734 variable and can be referred to in other options.
8735 .cindex "tainted data" "de-tainting"
8736 The value will be untainted.
8737
8738 .next
8739 If the pattern starts with the name of a lookup type
8740 of either kind (single-key or query-style) it may be
8741 followed by a comma and options,
8742 The options are lookup-type specific and consist of a comma-separated list.
8743 Each item starts with a tag and and equals "=".
8744
8745 .next
8746 .cindex "domain list" "matching literal domain name"
8747 If none of the above cases apply, a caseless textual comparison is made
8748 between the pattern and the domain.
8749
8750 The value for a match will be the list element string.
8751 .cindex "tainted data" "de-tainting"
8752 Note that this is commonly untainted
8753 (depending on the way the list was created).
8754 Specifically, explicit text in the configuration file in not tainted.
8755 This is a useful way of obtaining an untainted equivalent to
8756 the domain, for later operations.
8757
8758 However if the list (including one-element lists)
8759 is created by expanding a variable containing tainted data,
8760 it is tainted and so will the match value be.
8761 .endlist
8762
8763
8764 Here is an example that uses several different kinds of pattern:
8765 .code
8766 domainlist funny_domains = \
8767   @ : \
8768   lib.unseen.edu : \
8769   *.foundation.fict.example : \
8770   \N^[1-2]\d{3}\.fict\.example$\N : \
8771   partial-dbm;/opt/data/penguin/book : \
8772   nis;domains.byname : \
8773   nisplus;[name=$domain,status=local],domains.org_dir
8774 .endd
8775 There are obvious processing trade-offs among the various matching modes. Using
8776 an asterisk is faster than a regular expression, and listing a few names
8777 explicitly probably is too. The use of a file or database lookup is expensive,
8778 but may be the only option if hundreds of names are required. Because the
8779 patterns are tested in order, it makes sense to put the most commonly matched
8780 patterns earlier.
8781
8782
8783
8784 .section "Host lists" "SECThostlist"
8785 .cindex "host list" "patterns in"
8786 .cindex "list" "host list"
8787 Host lists are used to control what remote hosts are allowed to do. For
8788 example, some hosts may be allowed to use the local host as a relay, and some
8789 may be permitted to use the SMTP ETRN command. Hosts can be identified in
8790 two different ways, by name or by IP address. In a host list, some types of
8791 pattern are matched to a host name, and some are matched to an IP address.
8792 You need to be particularly careful with this when single-key lookups are
8793 involved, to ensure that the right value is being used as the key.
8794
8795
8796 .section "Special host list patterns" "SECID80"
8797 .cindex "empty item in hosts list"
8798 .cindex "host list" "empty string in"
8799 If a host list item is the empty string, it matches only when no remote host is
8800 involved. This is the case when a message is being received from a local
8801 process using SMTP on the standard input, that is, when a TCP/IP connection is
8802 not used.
8803
8804 .cindex "asterisk" "in host list"
8805 The special pattern &"*"& in a host list matches any host or no host. Neither
8806 the IP address nor the name is actually inspected.
8807
8808
8809
8810 .section "Host list patterns that match by IP address" "SECThoslispatip"
8811 .cindex "host list" "matching IP addresses"
8812 If an IPv4 host calls an IPv6 host and the call is accepted on an IPv6 socket,
8813 the incoming address actually appears in the IPv6 host as
8814 &`::ffff:`&<&'v4address'&>. When such an address is tested against a host
8815 list, it is converted into a traditional IPv4 address first. (Not all operating
8816 systems accept IPv4 calls on IPv6 sockets, as there have been some security
8817 concerns.)
8818
8819 The following types of pattern in a host list check the remote host by
8820 inspecting its IP address:
8821
8822 .ilist
8823 If the pattern is a plain domain name (not a regular expression, not starting
8824 with *, not a lookup of any kind), Exim calls the operating system function
8825 to find the associated IP address(es). Exim uses the newer
8826 &[getipnodebyname()]& function when available, otherwise &[gethostbyname()]&.
8827 This typically causes a forward DNS lookup of the name. The result is compared
8828 with the IP address of the subject host.
8829
8830 If there is a temporary problem (such as a DNS timeout) with the host name
8831 lookup, a temporary error occurs. For example, if the list is being used in an
8832 ACL condition, the ACL gives a &"defer"& response, usually leading to a
8833 temporary SMTP error code. If no IP address can be found for the host name,
8834 what happens is described in section &<<SECTbehipnot>>& below.
8835
8836 .next
8837 .cindex "@ in a host list"
8838 If the pattern is &"@"&, the primary host name is substituted and used as a
8839 domain name, as just described.
8840
8841 .next
8842 If the pattern is an IP address, it is matched against the IP address of the
8843 subject host. IPv4 addresses are given in the normal &"dotted-quad"& notation.
8844 IPv6 addresses can be given in colon-separated format, but the colons have to
8845 be doubled so as not to be taken as item separators when the default list
8846 separator is used. IPv6 addresses are recognized even when Exim is compiled
8847 without IPv6 support. This means that if they appear in a host list on an
8848 IPv4-only host, Exim will not treat them as host names. They are just addresses
8849 that can never match a client host.
8850
8851 .next
8852 .cindex "@[] in a host list"
8853 If the pattern is &"@[]"&, it matches the IP address of any IP interface on
8854 the local host. For example, if the local host is an IPv4 host with one
8855 interface address 10.45.23.56, these two ACL statements have the same effect:
8856 .code
8857 accept hosts = 127.0.0.1 : 10.45.23.56
8858 accept hosts = @[]
8859 .endd
8860 .next
8861 .cindex "CIDR notation"
8862 If the pattern is an IP address followed by a slash and a mask length (for
8863 example 10.11.42.0/24), it is matched against the IP address of the subject
8864 host under the given mask. This allows, an entire network of hosts to be
8865 included (or excluded) by a single item. The mask uses CIDR notation; it
8866 specifies the number of address bits that must match, starting from the most
8867 significant end of the address.
8868
8869 &*Note*&: The mask is &'not'& a count of addresses, nor is it the high number
8870 of a range of addresses. It is the number of bits in the network portion of the
8871 address. The above example specifies a 24-bit netmask, so it matches all 256
8872 addresses in the 10.11.42.0 network. An item such as
8873 .code
8874 192.168.23.236/31
8875 .endd
8876 matches just two addresses, 192.168.23.236 and 192.168.23.237. A mask value of
8877 32 for an IPv4 address is the same as no mask at all; just a single address
8878 matches.
8879
8880 Here is another example which shows an IPv4 and an IPv6 network:
8881 .code
8882 recipient_unqualified_hosts = 192.168.0.0/16: \
8883                               3ffe::ffff::836f::::/48
8884 .endd
8885 The doubling of list separator characters applies only when these items
8886 appear inline in a host list. It is not required when indirecting via a file.
8887 For example:
8888 .code
8889 recipient_unqualified_hosts = /opt/exim/unqualnets
8890 .endd
8891 could make use of a file containing
8892 .code
8893 172.16.0.0/12
8894 3ffe:ffff:836f::/48
8895 .endd
8896 to have exactly the same effect as the previous example. When listing IPv6
8897 addresses inline, it is usually more convenient to use the facility for
8898 changing separator characters. This list contains the same two networks:
8899 .code
8900 recipient_unqualified_hosts = <; 172.16.0.0/12; \
8901                                  3ffe:ffff:836f::/48
8902 .endd
8903 The separator is changed to semicolon by the leading &"<;"& at the start of the
8904 list.
8905 .endlist
8906
8907
8908
8909 .section "Host list patterns for single-key lookups by host address" &&&
8910          "SECThoslispatsikey"
8911 .cindex "host list" "lookup of IP address"
8912 When a host is to be identified by a single-key lookup of its complete IP
8913 address, the pattern takes this form:
8914 .display
8915 &`net-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8916 .endd
8917 For example:
8918 .code
8919 hosts_lookup = net-cdb;/hosts-by-ip.db
8920 .endd
8921 The text form of the IP address of the subject host is used as the lookup key.
8922 IPv6 addresses are converted to an unabbreviated form, using lower case
8923 letters, with dots as separators because colon is the key terminator in
8924 &(lsearch)& files. [Colons can in fact be used in keys in &(lsearch)& files by
8925 quoting the keys, but this is a facility that was added later.] The data
8926 returned by the lookup is not used.
8927
8928 .cindex "IP address" "masking"
8929 .cindex "host list" "masked IP address"
8930 Single-key lookups can also be performed using masked IP addresses, using
8931 patterns of this form:
8932 .display
8933 &`net<`&&'number'&&`>-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8934 .endd
8935 For example:
8936 .code
8937 net24-dbm;/networks.db
8938 .endd
8939 The IP address of the subject host is masked using <&'number'&> as the mask
8940 length. A textual string is constructed from the masked value, followed by the
8941 mask, and this is used as the lookup key. For example, if the host's IP address
8942 is 192.168.34.6, the key that is looked up for the above example is
8943 &"192.168.34.0/24"&.
8944
8945 When an IPv6 address is converted to a string, dots are normally used instead
8946 of colons, so that keys in &(lsearch)& files need not contain colons (which
8947 terminate &(lsearch)& keys). This was implemented some time before the ability
8948 to quote keys was made available in &(lsearch)& files. However, the more
8949 recently implemented &(iplsearch)& files do require colons in IPv6 keys
8950 (notated using the quoting facility) so as to distinguish them from IPv4 keys.
8951 For this reason, when the lookup type is &(iplsearch)&, IPv6 addresses are
8952 converted using colons and not dots.
8953 In all cases except IPv4-mapped IPv6, full, unabbreviated IPv6
8954 addresses are always used.
8955 The latter are converted to IPv4 addresses, in dotted-quad form.
8956
8957 Ideally, it would be nice to tidy up this anomalous situation by changing to
8958 colons in all cases, given that quoting is now available for &(lsearch)&.
8959 However, this would be an incompatible change that might break some existing
8960 configurations.
8961
8962 &*Warning*&: Specifying &%net32-%& (for an IPv4 address) or &%net128-%& (for an
8963 IPv6 address) is not the same as specifying just &%net-%& without a number. In
8964 the former case the key strings include the mask value, whereas in the latter
8965 case the IP address is used on its own.
8966
8967
8968
8969 .section "Host list patterns that match by host name" "SECThoslispatnam"
8970 .cindex "host" "lookup failures"
8971 .cindex "unknown host name"
8972 .cindex "host list" "matching host name"
8973 There are several types of pattern that require Exim to know the name of the
8974 remote host. These are either wildcard patterns or lookups by name. (If a
8975 complete hostname is given without any wildcarding, it is used to find an IP
8976 address to match against, as described in section &<<SECThoslispatip>>&
8977 above.)
8978
8979 If the remote host name is not already known when Exim encounters one of these
8980 patterns, it has to be found from the IP address.
8981 Although many sites on the Internet are conscientious about maintaining reverse
8982 DNS data for their hosts, there are also many that do not do this.
8983 Consequently, a name cannot always be found, and this may lead to unwanted
8984 effects. Take care when configuring host lists with wildcarded name patterns.
8985 Consider what will happen if a name cannot be found.
8986
8987 Because of the problems of determining host names from IP addresses, matching
8988 against host names is not as common as matching against IP addresses.
8989
8990 By default, in order to find a host name, Exim first does a reverse DNS lookup;
8991 if no name is found in the DNS, the system function (&[gethostbyaddr()]& or
8992 &[getipnodebyaddr()]& if available) is tried. The order in which these lookups
8993 are done can be changed by setting the &%host_lookup_order%& option. For
8994 security, once Exim has found one or more names, it looks up the IP addresses
8995 for these names and compares them with the IP address that it started with.
8996 Only those names whose IP addresses match are accepted. Any other names are
8997 discarded. If no names are left, Exim behaves as if the host name cannot be
8998 found. In the most common case there is only one name and one IP address.
8999
9000 There are some options that control what happens if a host name cannot be
9001 found. These are described in section &<<SECTbehipnot>>& below.
9002
9003 .cindex "host" "alias for"
9004 .cindex "alias for host"
9005 As a result of aliasing, hosts may have more than one name. When processing any
9006 of the following types of pattern, all the host's names are checked:
9007
9008 .ilist
9009 .cindex "asterisk" "in host list"
9010 If a pattern starts with &"*"& the remainder of the item must match the end of
9011 the host name. For example, &`*.b.c`& matches all hosts whose names end in
9012 &'.b.c'&. This special simple form is provided because this is a very common
9013 requirement. Other kinds of wildcarding require the use of a regular
9014 expression.
9015 .next
9016 .cindex "regular expressions" "in host list"
9017 .cindex "host list" "regular expression in"
9018 If the item starts with &"^"& it is taken to be a regular expression which is
9019 matched against the host name. Host names are case-independent, so this regular
9020 expression match is by default case-independent, but you can make it
9021 case-dependent by starting it with &`(?-i)`&. References to descriptions of the
9022 syntax of regular expressions are given in chapter &<<CHAPregexp>>&. For
9023 example,
9024 .code
9025 ^(a|b)\.c\.d$
9026 .endd
9027 is a regular expression that matches either of the two hosts &'a.c.d'& or
9028 &'b.c.d'&. When a regular expression is used in a host list, you must take care
9029 that backslash and dollar characters are not misinterpreted as part of the
9030 string expansion. The simplest way to do this is to use &`\N`& to mark that
9031 part of the string as non-expandable. For example:
9032 .code
9033 sender_unqualified_hosts = \N^(a|b)\.c\.d$\N : ....
9034 .endd
9035 &*Warning*&: If you want to match a complete host name, you must include the
9036 &`$`& terminating metacharacter in the regular expression, as in the above
9037 example. Without it, a match at the start of the host name is all that is
9038 required.
9039 .endlist
9040
9041
9042
9043
9044 .section "Behaviour when an IP address or name cannot be found" "SECTbehipnot"
9045 .cindex "host" "lookup failures, permanent"
9046 While processing a host list, Exim may need to look up an IP address from a
9047 name (see section &<<SECThoslispatip>>&), or it may need to look up a host name
9048 from an IP address (see section &<<SECThoslispatnam>>&). In either case, the
9049 behaviour when it fails to find the information it is seeking is the same.
9050
9051 &*Note*&: This section applies to permanent lookup failures. It does &'not'&
9052 apply to temporary DNS errors, whose handling is described in the next section.
9053
9054 .cindex "&`+include_unknown`&"
9055 .cindex "&`+ignore_unknown`&"
9056 Exim parses a host list from left to right. If it encounters a permanent
9057 lookup failure in any item in the host list before it has found a match,
9058 Exim treats it as a failure and the default behavior is as if the host
9059 does not match the list. This may not always be what you want to happen.
9060 To change Exim's behaviour, the special items &`+include_unknown`& or
9061 &`+ignore_unknown`& may appear in the list (at top level &-- they are
9062 not recognized in an indirected file).
9063
9064 .ilist
9065 If any item that follows &`+include_unknown`& requires information that
9066 cannot found, Exim behaves as if the host does match the list. For example,
9067 .code
9068 host_reject_connection = +include_unknown:*.enemy.ex
9069 .endd
9070 rejects connections from any host whose name matches &`*.enemy.ex`&, and also
9071 any hosts whose name it cannot find.
9072
9073 .next
9074 If any item that follows &`+ignore_unknown`& requires information that cannot
9075 be found, Exim ignores that item and proceeds to the rest of the list. For
9076 example:
9077 .code
9078 accept hosts = +ignore_unknown : friend.example : \
9079                192.168.4.5
9080 .endd
9081 accepts from any host whose name is &'friend.example'& and from 192.168.4.5,
9082 whether or not its host name can be found. Without &`+ignore_unknown`&, if no
9083 name can be found for 192.168.4.5, it is rejected.
9084 .endlist
9085
9086 Both &`+include_unknown`& and &`+ignore_unknown`& may appear in the same
9087 list. The effect of each one lasts until the next, or until the end of the
9088 list.
9089
9090 .section "Mixing wildcarded host names and addresses in host lists" &&&
9091          "SECTmixwilhos"
9092 .cindex "host list" "mixing names and addresses in"
9093
9094 This section explains the host/ip processing logic with the same concepts
9095 as the previous section, but specifically addresses what happens when a
9096 wildcarded hostname is one of the items in the hostlist.
9097
9098 .ilist
9099 If you have name lookups or wildcarded host names and
9100 IP addresses in the same host list, you should normally put the IP
9101 addresses first. For example, in an ACL you could have:
9102 .code
9103 accept hosts = 10.9.8.7 : *.friend.example
9104 .endd
9105 The reason you normally would order it this way lies in the
9106 left-to-right way that Exim processes lists.  It can test IP addresses
9107 without doing any DNS lookups, but when it reaches an item that requires
9108 a host name, it fails if it cannot find a host name to compare with the
9109 pattern. If the above list is given in the opposite order, the
9110 &%accept%& statement fails for a host whose name cannot be found, even
9111 if its IP address is 10.9.8.7.
9112
9113 .next
9114 If you really do want to do the name check first, and still recognize the IP
9115 address, you can rewrite the ACL like this:
9116 .code
9117 accept hosts = *.friend.example
9118 accept hosts = 10.9.8.7
9119 .endd
9120 If the first &%accept%& fails, Exim goes on to try the second one. See chapter
9121 &<<CHAPACL>>& for details of ACLs. Alternatively, you can use
9122 &`+ignore_unknown`&, which was discussed in depth in the first example in
9123 this section.
9124 .endlist
9125
9126
9127 .section "Temporary DNS errors when looking up host information" &&&
9128          "SECTtemdnserr"
9129 .cindex "host" "lookup failures, temporary"
9130 .cindex "&`+include_defer`&"
9131 .cindex "&`+ignore_defer`&"
9132 A temporary DNS lookup failure normally causes a defer action (except when
9133 &%dns_again_means_nonexist%& converts it into a permanent error). However,
9134 host lists can include &`+ignore_defer`& and &`+include_defer`&, analogous to
9135 &`+ignore_unknown`& and &`+include_unknown`&, as described in the previous
9136 section. These options should be used with care, probably only in non-critical
9137 host lists such as whitelists.
9138
9139
9140
9141 .section "Host list patterns for single-key lookups by host name" &&&
9142          "SECThoslispatnamsk"
9143 .cindex "unknown host name"
9144 .cindex "host list" "matching host name"
9145 If a pattern is of the form
9146 .display
9147 <&'single-key-search-type'&>;<&'search-data'&>
9148 .endd
9149 for example
9150 .code
9151 dbm;/host/accept/list
9152 .endd
9153 a single-key lookup is performed, using the host name as its key. If the
9154 lookup succeeds, the host matches the item. The actual data that is looked up
9155 is not used.
9156
9157 &*Reminder*&: With this kind of pattern, you must have host &'names'& as
9158 keys in the file, not IP addresses. If you want to do lookups based on IP
9159 addresses, you must precede the search type with &"net-"& (see section
9160 &<<SECThoslispatsikey>>&). There is, however, no reason why you could not use
9161 two items in the same list, one doing an address lookup and one doing a name
9162 lookup, both using the same file.
9163
9164
9165
9166 .section "Host list patterns for query-style lookups" "SECID81"
9167 If a pattern is of the form
9168 .display
9169 <&'query-style-search-type'&>;<&'query'&>
9170 .endd
9171 the query is obeyed, and if it succeeds, the host matches the item. The actual
9172 data that is looked up is not used. The variables &$sender_host_address$& and
9173 &$sender_host_name$& can be used in the query. For example:
9174 .code
9175 hosts_lookup = pgsql;\
9176   select ip from hostlist where ip='$sender_host_address'
9177 .endd
9178 The value of &$sender_host_address$& for an IPv6 address contains colons. You
9179 can use the &%sg%& expansion item to change this if you need to. If you want to
9180 use masked IP addresses in database queries, you can use the &%mask%& expansion
9181 operator.
9182
9183 If the query contains a reference to &$sender_host_name$&, Exim automatically
9184 looks up the host name if it has not already done so. (See section
9185 &<<SECThoslispatnam>>& for comments on finding host names.)
9186
9187 Historical note: prior to release 4.30, Exim would always attempt to find a
9188 host name before running the query, unless the search type was preceded by
9189 &`net-`&. This is no longer the case. For backwards compatibility, &`net-`& is
9190 still recognized for query-style lookups, but its presence or absence has no
9191 effect. (Of course, for single-key lookups, &`net-`& &'is'& important.
9192 See section &<<SECThoslispatsikey>>&.)
9193
9194
9195
9196
9197
9198 .section "Address lists" "SECTaddresslist"
9199 .cindex "list" "address list"
9200 .cindex "address list" "empty item"
9201 .cindex "address list" "patterns"
9202 Address lists contain patterns that are matched against mail addresses. There
9203 is one special case to be considered: the sender address of a bounce message is
9204 always empty. You can test for this by providing an empty item in an address
9205 list. For example, you can set up a router to process bounce messages by
9206 using this option setting:
9207 .code
9208 senders = :
9209 .endd
9210 The presence of the colon creates an empty item. If you do not provide any
9211 data, the list is empty and matches nothing. The empty sender can also be
9212 detected by a regular expression that matches an empty string,
9213 and by a query-style lookup that succeeds when &$sender_address$& is empty.
9214
9215 Non-empty items in an address list can be straightforward email addresses. For
9216 example:
9217 .code
9218 senders = jbc@askone.example : hs@anacreon.example
9219 .endd
9220 A certain amount of wildcarding is permitted. If a pattern contains an @
9221 character, but is not a regular expression and does not begin with a
9222 semicolon-terminated lookup type (described below), the local part of the
9223 subject address is compared with the local part of the pattern, which may start
9224 with an asterisk. If the local parts match, the domain is checked in exactly
9225 the same way as for a pattern in a domain list. For example, the domain can be
9226 wildcarded, refer to a named list, or be a lookup:
9227 .code
9228 deny senders = *@*.spamming.site:\
9229                *@+hostile_domains:\
9230                bozo@partial-lsearch;/list/of/dodgy/sites:\
9231                *@dbm;/bad/domains.db
9232 .endd
9233 .cindex "local part" "starting with !"
9234 .cindex "address list" "local part starting with !"
9235 If a local part that begins with an exclamation mark is required, it has to be
9236 specified using a regular expression, because otherwise the exclamation mark is
9237 treated as a sign of negation, as is standard in lists.
9238
9239 If a non-empty pattern that is not a regular expression or a lookup does not
9240 contain an @ character, it is matched against the domain part of the subject
9241 address. The only two formats that are recognized this way are a literal
9242 domain, or a domain pattern that starts with *. In both these cases, the effect
9243 is the same as if &`*@`& preceded the pattern. For example:
9244 .code
9245 deny senders = enemy.domain : *.enemy.domain
9246 .endd
9247
9248 The following kinds of more complicated address list pattern can match any
9249 address, including the empty address that is characteristic of bounce message
9250 senders:
9251
9252 .ilist
9253 .cindex "regular expressions" "in address list"
9254 .cindex "address list" "regular expression in"
9255 If (after expansion) a pattern starts with &"^"&, a regular expression match is
9256 done against the complete address, with the pattern as the regular expression.
9257 You must take care that backslash and dollar characters are not misinterpreted
9258 as part of the string expansion. The simplest way to do this is to use &`\N`&
9259 to mark that part of the string as non-expandable. For example:
9260 .code
9261 deny senders = \N^.*this.*@example\.com$\N : \
9262                \N^\d{8}.+@spamhaus.example$\N : ...
9263 .endd
9264 The &`\N`& sequences are removed by the expansion, so these items do indeed
9265 start with &"^"& by the time they are being interpreted as address patterns.
9266
9267 .next
9268 .cindex "address list" "lookup for complete address"
9269 Complete addresses can be looked up by using a pattern that starts with a
9270 lookup type terminated by a semicolon, followed by the data for the lookup. For
9271 example:
9272 .code
9273 deny senders = cdb;/etc/blocked.senders : \
9274   mysql;select address from blocked where \
9275   address='${quote_mysql:$sender_address}'
9276 .endd
9277 Both query-style and single-key lookup types can be used. For a single-key
9278 lookup type, Exim uses the complete address as the key. However, empty keys are
9279 not supported for single-key lookups, so a match against the empty address
9280 always fails. This restriction does not apply to query-style lookups.
9281
9282 Partial matching for single-key lookups (section &<<SECTpartiallookup>>&)
9283 cannot be used, and is ignored if specified, with an entry being written to the
9284 panic log.
9285 .cindex "*@ with single-key lookup"
9286 However, you can configure lookup defaults, as described in section
9287 &<<SECTdefaultvaluelookups>>&, but this is useful only for the &"*@"& type of
9288 default. For example, with this lookup:
9289 .code
9290 accept senders = lsearch*@;/some/file
9291 .endd
9292 the file could contains lines like this:
9293 .code
9294 user1@domain1.example
9295 *@domain2.example
9296 .endd
9297 and for the sender address &'nimrod@jaeger.example'&, the sequence of keys
9298 that are tried is:
9299 .code
9300 nimrod@jaeger.example
9301 *@jaeger.example
9302 *
9303 .endd
9304 &*Warning 1*&: Do not include a line keyed by &"*"& in the file, because that
9305 would mean that every address matches, thus rendering the test useless.
9306
9307 &*Warning 2*&: Do not confuse these two kinds of item:
9308 .code
9309 deny recipients = dbm*@;/some/file
9310 deny recipients = *@dbm;/some/file
9311 .endd
9312 The first does a whole address lookup, with defaulting, as just described,
9313 because it starts with a lookup type. The second matches the local part and
9314 domain independently, as described in a bullet point below.
9315 .endlist
9316
9317
9318 The following kinds of address list pattern can match only non-empty addresses.
9319 If the subject address is empty, a match against any of these pattern types
9320 always fails.
9321
9322
9323 .ilist
9324 .cindex "@@ with single-key lookup"
9325 .cindex "address list" "@@ lookup type"
9326 .cindex "address list" "split local part and domain"
9327 If a pattern starts with &"@@"& followed by a single-key lookup item
9328 (for example, &`@@lsearch;/some/file`&), the address that is being checked is
9329 split into a local part and a domain. The domain is looked up in the file. If
9330 it is not found, there is no match. If it is found, the data that is looked up
9331 from the file is treated as a colon-separated list of local part patterns, each
9332 of which is matched against the subject local part in turn.
9333
9334 .cindex "asterisk" "in address list"
9335 The lookup may be a partial one, and/or one involving a search for a default
9336 keyed by &"*"& (see section &<<SECTdefaultvaluelookups>>&). The local part
9337 patterns that are looked up can be regular expressions or begin with &"*"&, or
9338 even be further lookups. They may also be independently negated. For example,
9339 with
9340 .code
9341 deny senders = @@dbm;/etc/reject-by-domain
9342 .endd
9343 the data from which the DBM file is built could contain lines like
9344 .code
9345 baddomain.com:  !postmaster : *
9346 .endd
9347 to reject all senders except &%postmaster%& from that domain.
9348
9349 .cindex "local part" "starting with !"
9350 If a local part that actually begins with an exclamation mark is required, it
9351 has to be specified using a regular expression. In &(lsearch)& files, an entry
9352 may be split over several lines by indenting the second and subsequent lines,
9353 but the separating colon must still be included at line breaks. White space
9354 surrounding the colons is ignored. For example:
9355 .code
9356 aol.com:  spammer1 : spammer2 : ^[0-9]+$ :
9357   spammer3 : spammer4
9358 .endd
9359 As in all colon-separated lists in Exim, a colon can be included in an item by
9360 doubling.
9361
9362 If the last item in the list starts with a right angle-bracket, the remainder
9363 of the item is taken as a new key to look up in order to obtain a continuation
9364 list of local parts. The new key can be any sequence of characters. Thus one
9365 might have entries like
9366 .code
9367 aol.com: spammer1 : spammer 2 : >*
9368 xyz.com: spammer3 : >*
9369 *:       ^\d{8}$
9370 .endd
9371 in a file that was searched with &%@@dbm*%&, to specify a match for 8-digit
9372 local parts for all domains, in addition to the specific local parts listed for
9373 each domain. Of course, using this feature costs another lookup each time a
9374 chain is followed, but the effort needed to maintain the data is reduced.
9375
9376 .cindex "loop" "in lookups"
9377 It is possible to construct loops using this facility, and in order to catch
9378 them, the chains may be no more than fifty items long.
9379
9380 .next
9381 The @@<&'lookup'&> style of item can also be used with a query-style
9382 lookup, but in this case, the chaining facility is not available. The lookup
9383 can only return a single list of local parts.
9384 .endlist
9385
9386 &*Warning*&: There is an important difference between the address list items
9387 in these two examples:
9388 .code
9389 senders = +my_list
9390 senders = *@+my_list
9391 .endd
9392 In the first one, &`my_list`& is a named address list, whereas in the second
9393 example it is a named domain list.
9394
9395
9396
9397
9398 .section "Case of letters in address lists" "SECTcasletadd"
9399 .cindex "case of local parts"
9400 .cindex "address list" "case forcing"
9401 .cindex "case forcing in address lists"
9402 Domains in email addresses are always handled caselessly, but for local parts
9403 case may be significant on some systems (see &%caseful_local_part%& for how
9404 Exim deals with this when routing addresses). However, RFC 2505 (&'Anti-Spam
9405 Recommendations for SMTP MTAs'&) suggests that matching of addresses to
9406 blocking lists should be done in a case-independent manner. Since most address
9407 lists in Exim are used for this kind of control, Exim attempts to do this by
9408 default.
9409
9410 The domain portion of an address is always lowercased before matching it to an
9411 address list. The local part is lowercased by default, and any string
9412 comparisons that take place are done caselessly. This means that the data in
9413 the address list itself, in files included as plain filenames, and in any file
9414 that is looked up using the &"@@"& mechanism, can be in any case. However, the
9415 keys in files that are looked up by a search type other than &(lsearch)& (which
9416 works caselessly) must be in lower case, because these lookups are not
9417 case-independent.
9418
9419 .cindex "&`+caseful`&"
9420 To allow for the possibility of caseful address list matching, if an item in
9421 an address list is the string &"+caseful"&, the original case of the local
9422 part is restored for any comparisons that follow, and string comparisons are no
9423 longer case-independent. This does not affect the domain, which remains in
9424 lower case. However, although independent matches on the domain alone are still
9425 performed caselessly, regular expressions that match against an entire address
9426 become case-sensitive after &"+caseful"& has been seen.
9427
9428
9429
9430 .section "Local part lists" "SECTlocparlis"
9431 .cindex "list" "local part list"
9432 .cindex "local part" "list"
9433 Case-sensitivity in local part lists is handled in the same way as for address
9434 lists, as just described. The &"+caseful"& item can be used if required. In a
9435 setting of the &%local_parts%& option in a router with &%caseful_local_part%&
9436 set false, the subject is lowercased and the matching is initially
9437 case-insensitive. In this case, &"+caseful"& will restore case-sensitive
9438 matching in the local part list, but not elsewhere in the router. If
9439 &%caseful_local_part%& is set true in a router, matching in the &%local_parts%&
9440 option is case-sensitive from the start.
9441
9442 If a local part list is indirected to a file (see section &<<SECTfilnamlis>>&),
9443 comments are handled in the same way as address lists &-- they are recognized
9444 only if the # is preceded by white space or the start of the line.
9445 Otherwise, local part lists are matched in the same way as domain lists, except
9446 that the special items that refer to the local host (&`@`&, &`@[]`&,
9447 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`&) are not recognized.
9448 Refer to section &<<SECTdomainlist>>& for details of the other available item
9449 types.
9450 .ecindex IIDdohoadli
9451
9452
9453
9454
9455 . ////////////////////////////////////////////////////////////////////////////
9456 . ////////////////////////////////////////////////////////////////////////////
9457
9458 .chapter "String expansions" "CHAPexpand"
9459 .scindex IIDstrexp "expansion" "of strings"
9460 Many strings in Exim's runtime configuration are expanded before use. Some of
9461 them are expanded every time they are used; others are expanded only once.
9462
9463 When a string is being expanded it is copied verbatim from left to right except
9464 .cindex expansion "string concatenation"
9465 when a dollar or backslash character is encountered. A dollar specifies the
9466 start of a portion of the string that is interpreted and replaced as described
9467 below in section &<<SECTexpansionitems>>& onwards. Backslash is used as an
9468 escape character, as described in the following section.
9469
9470 Whether a string is expanded depends upon the context.  Usually this is solely
9471 dependent upon the option for which a value is sought; in this documentation,
9472 options for which string expansion is performed are marked with &dagger; after
9473 the data type.  ACL rules always expand strings.  A couple of expansion
9474 conditions do not expand some of the brace-delimited branches, for security
9475 reasons,
9476 .cindex "tainted data" expansion
9477 .cindex "tainted data" definition
9478 .cindex expansion "tainted data"
9479 and expansion of data deriving from the sender (&"tainted data"&)
9480 is not permitted.
9481
9482 .new
9483 Common ways of obtaining untainted equivalents of variables with
9484 tainted values
9485 .cindex "tainted data" "de-tainting"
9486 come down to using the tainted value as a lookup key in a trusted database.
9487 This database could be the filesystem structure,
9488 or the password file,
9489 or accessed via a DBMS.
9490 Specific methods are indexed under &"de-tainting"&.
9491 .wen
9492
9493
9494
9495 .section "Literal text in expanded strings" "SECTlittext"
9496 .cindex "expansion" "including literal text"
9497 An uninterpreted dollar can be included in an expanded string by putting a
9498 backslash in front of it. A backslash can be used to prevent any special
9499 character being treated specially in an expansion, including backslash itself.
9500 If the string appears in quotes in the configuration file, two backslashes are
9501 required because the quotes themselves cause interpretation of backslashes when
9502 the string is read in (see section &<<SECTstrings>>&).
9503
9504 .cindex "expansion" "non-expandable substrings"
9505 A portion of the string can specified as non-expandable by placing it between
9506 two occurrences of &`\N`&. This is particularly useful for protecting regular
9507 expressions, which often contain backslashes and dollar signs. For example:
9508 .code
9509 deny senders = \N^\d{8}[a-z]@some\.site\.example$\N
9510 .endd
9511 On encountering the first &`\N`&, the expander copies subsequent characters
9512 without interpretation until it reaches the next &`\N`& or the end of the
9513 string.
9514
9515
9516
9517 .section "Character escape sequences in expanded strings" "SECID82"
9518 .cindex "expansion" "escape sequences"
9519 A backslash followed by one of the letters &"n"&, &"r"&, or &"t"& in an
9520 expanded string is recognized as an escape sequence for the character newline,
9521 carriage return, or tab, respectively. A backslash followed by up to three
9522 octal digits is recognized as an octal encoding for a single character, and a
9523 backslash followed by &"x"& and up to two hexadecimal digits is a hexadecimal
9524 encoding.
9525
9526 These escape sequences are also recognized in quoted strings when they are read
9527 in. Their interpretation in expansions as well is useful for unquoted strings,
9528 and for other cases such as looked-up strings that are then expanded.
9529
9530
9531 .section "Testing string expansions" "SECID83"
9532 .cindex "expansion" "testing"
9533 .cindex "testing" "string expansion"
9534 .oindex "&%-be%&"
9535 Many expansions can be tested by calling Exim with the &%-be%& option. This
9536 takes the command arguments, or lines from the standard input if there are no
9537 arguments, runs them through the string expansion code, and writes the results
9538 to the standard output. Variables based on configuration values are set up, but
9539 since no message is being processed, variables such as &$local_part$& have no
9540 value. Nevertheless the &%-be%& option can be useful for checking out file and
9541 database lookups, and the use of expansion operators such as &%sg%&, &%substr%&
9542 and &%nhash%&.
9543
9544 Exim gives up its root privilege when it is called with the &%-be%& option, and
9545 instead runs under the uid and gid it was called with, to prevent users from
9546 using &%-be%& for reading files to which they do not have access.
9547
9548 .oindex "&%-bem%&"
9549 If you want to test expansions that include variables whose values are taken
9550 from a message, there are two other options that can be used. The &%-bem%&
9551 option is like &%-be%& except that it is followed by a filename. The file is
9552 read as a message before doing the test expansions. For example:
9553 .code
9554 exim -bem /tmp/test.message '$h_subject:'
9555 .endd
9556 The &%-Mset%& option is used in conjunction with &%-be%& and is followed by an
9557 Exim message identifier. For example:
9558 .code
9559 exim -be -Mset 1GrA8W-0004WS-LQ '$recipients'
9560 .endd
9561 This loads the message from Exim's spool before doing the test expansions, and
9562 is therefore restricted to admin users.
9563
9564
9565 .section "Forced expansion failure" "SECTforexpfai"
9566 .cindex "expansion" "forced failure"
9567 A number of expansions that are described in the following section have
9568 alternative &"true"& and &"false"& substrings, enclosed in brace characters
9569 (which are sometimes called &"curly brackets"&). Which of the two strings is
9570 used depends on some condition that is evaluated as part of the expansion. If,
9571 instead of a &"false"& substring, the word &"fail"& is used (not in braces),
9572 the entire string expansion fails in a way that can be detected by the code
9573 that requested the expansion. This is called &"forced expansion failure"&, and
9574 its consequences depend on the circumstances. In some cases it is no different
9575 from any other expansion failure, but in others a different action may be
9576 taken. Such variations are mentioned in the documentation of the option that is
9577 being expanded.
9578
9579
9580
9581
9582 .section "Expansion items" "SECTexpansionitems"
9583 The following items are recognized in expanded strings. White space may be used
9584 between sub-items that are keywords or substrings enclosed in braces inside an
9585 outer set of braces, to improve readability. &*Warning*&: Within braces,
9586 white space is significant.
9587
9588 .vlist
9589 .vitem &*$*&<&'variable&~name'&>&~or&~&*${*&<&'variable&~name'&>&*}*&
9590 .cindex "expansion" "variables"
9591 Substitute the contents of the named variable, for example:
9592 .code
9593 $local_part
9594 ${domain}
9595 .endd
9596 The second form can be used to separate the name from subsequent alphanumeric
9597 characters. This form (using braces) is available only for variables; it does
9598 &'not'& apply to message headers. The names of the variables are given in
9599 section &<<SECTexpvar>>& below. If the name of a non-existent variable is
9600 given, the expansion fails.
9601
9602 .vitem &*${*&<&'op'&>&*:*&<&'string'&>&*}*&
9603 .cindex "expansion" "operators"
9604 The string is first itself expanded, and then the operation specified by
9605 <&'op'&> is applied to it. For example:
9606 .code
9607 ${lc:$local_part}
9608 .endd
9609 The string starts with the first character after the colon, which may be
9610 leading white space. A list of operators is given in section &<<SECTexpop>>&
9611 below. The operator notation is used for simple expansion items that have just
9612 one argument, because it reduces the number of braces and therefore makes the
9613 string easier to understand.
9614
9615 .vitem &*$bheader_*&<&'header&~name'&>&*:*&&~or&~&*$bh_*&<&'header&~name'&>&*:*&
9616 This item inserts &"basic"& header lines. It is described with the &%header%&
9617 expansion item below.
9618
9619
9620 .vitem "&*${acl{*&<&'name'&>&*}{*&<&'arg'&>&*}...}*&"
9621 .cindex "expansion" "calling an acl"
9622 .cindex "&%acl%&" "call from expansion"
9623 The name and zero to nine argument strings are first expanded separately.  The expanded
9624 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
9625 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
9626 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
9627 and may use the variables; if another acl expansion is used the values
9628 are restored after it returns.  If the ACL sets
9629 a value using a "message =" modifier and returns accept or deny, the value becomes
9630 the result of the expansion.
9631 If no message is set and the ACL returns accept or deny
9632 the expansion result is an empty string.
9633 If the ACL returns defer the result is a forced-fail.  Otherwise the expansion fails.
9634
9635
9636 .vitem "&*${authresults{*&<&'authserv-id'&>&*}}*&"
9637 .cindex authentication "results header"
9638 .cindex headers "authentication-results:"
9639 .cindex authentication "expansion item"
9640 This item returns a string suitable for insertion as an
9641 &'Authentication-Results:'&
9642 header line.
9643 The given <&'authserv-id'&> is included in the result; typically this
9644 will be a domain name identifying the system performing the authentications.
9645 Methods that might be present in the result include:
9646 .code
9647 none
9648 iprev
9649 auth
9650 spf
9651 dkim
9652 .endd
9653
9654 Example use (as an ACL modifier):
9655 .code
9656       add_header = :at_start:${authresults {$primary_hostname}}
9657 .endd
9658 This is safe even if no authentication results are available.
9659
9660
9661 .vitem "&*${certextract{*&<&'field'&>&*}{*&<&'certificate'&>&*}&&&
9662        {*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9663 .cindex "expansion" "extracting certificate fields"
9664 .cindex "&%certextract%&" "certificate fields"
9665 .cindex "certificate" "extracting fields"
9666 The <&'certificate'&> must be a variable of type certificate.
9667 The field name is expanded and used to retrieve the relevant field from
9668 the certificate.  Supported fields are:
9669 .display
9670 &`version        `&
9671 &`serial_number  `&
9672 &`subject        `& RFC4514 DN
9673 &`issuer         `& RFC4514 DN
9674 &`notbefore      `& time
9675 &`notafter       `& time
9676 &`sig_algorithm  `&
9677 &`signature      `&
9678 &`subj_altname   `& tagged list
9679 &`ocsp_uri       `& list
9680 &`crl_uri        `& list
9681 .endd
9682 If the field is found,
9683 <&'string2'&> is expanded, and replaces the whole item;
9684 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9685 variable &$value$& contains the value that has been extracted. Afterwards, it
9686 is restored to any previous value it might have had.
9687
9688 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9689 key is not found. If {<&'string2'&>} is also omitted, the value that was
9690 extracted is used.
9691
9692 Some field names take optional modifiers, appended and separated by commas.
9693
9694 The field selectors marked as "RFC4514" above
9695 output a Distinguished Name string which is
9696 not quite
9697 parseable by Exim as a comma-separated tagged list
9698 (the exceptions being elements containing commas).
9699 RDN elements of a single type may be selected by
9700 a modifier of the type label; if so the expansion
9701 result is a list (newline-separated by default).
9702 The separator may be changed by another modifier of
9703 a right angle-bracket followed immediately by the new separator.
9704 Recognised RDN type labels include "CN", "O", "OU" and "DC".
9705
9706 The field selectors marked as "time" above
9707 take an optional modifier of "int"
9708 for which the result is the number of seconds since epoch.
9709 Otherwise the result is a human-readable string
9710 in the timezone selected by the main "timezone" option.
9711
9712 The field selectors marked as "list" above return a list,
9713 newline-separated by default,
9714 (embedded separator characters in elements are doubled).
9715 The separator may be changed by a modifier of
9716 a right angle-bracket followed immediately by the new separator.
9717
9718 The field selectors marked as "tagged" above
9719 prefix each list element with a type string and an equals sign.
9720 Elements of only one type may be selected by a modifier
9721 which is one of "dns", "uri" or "mail";
9722 if so the element tags are omitted.
9723
9724 If not otherwise noted field values are presented in human-readable form.
9725
9726 .vitem "&*${dlfunc{*&<&'file'&>&*}{*&<&'function'&>&*}{*&<&'arg'&>&*}&&&
9727        {*&<&'arg'&>&*}...}*&"
9728 .cindex &%dlfunc%&
9729 This expansion dynamically loads and then calls a locally-written C function.
9730 This functionality is available only if Exim is compiled with
9731 .code
9732 EXPAND_DLFUNC=yes
9733 .endd
9734 set in &_Local/Makefile_&. Once loaded, Exim remembers the dynamically loaded
9735 object so that it doesn't reload the same object file in the same Exim process
9736 (but of course Exim does start new processes frequently).
9737
9738 There may be from zero to eight arguments to the function.
9739
9740 When compiling
9741 a local function that is to be called in this way,
9742 first &_DLFUNC_IMPL_& should be defined,
9743 and second &_local_scan.h_& should be included.
9744 The Exim variables and functions that are defined by that API
9745 are also available for dynamically loaded functions. The function itself
9746 must have the following type:
9747 .code
9748 int dlfunction(uschar **yield, int argc, uschar *argv[])
9749 .endd
9750 Where &`uschar`& is a typedef for &`unsigned char`& in &_local_scan.h_&. The
9751 function should return one of the following values:
9752
9753 &`OK`&: Success. The string that is placed in the variable &'yield'& is put
9754 into the expanded string that is being built.
9755
9756 &`FAIL`&: A non-forced expansion failure occurs, with the error message taken
9757 from &'yield'&, if it is set.
9758
9759 &`FAIL_FORCED`&: A forced expansion failure occurs, with the error message
9760 taken from &'yield'& if it is set.
9761
9762 &`ERROR`&: Same as &`FAIL`&, except that a panic log entry is written.
9763
9764 When compiling a function that is to be used in this way with gcc,
9765 you need to add &%-shared%& to the gcc command. Also, in the Exim build-time
9766 configuration, you must add &%-export-dynamic%& to EXTRALIBS.
9767
9768
9769 .vitem "&*${env{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&"
9770 .cindex "expansion" "extracting value from environment"
9771 .cindex "environment" "values from"
9772 The key is first expanded separately, and leading and trailing white space
9773 removed.
9774 This is then searched for as a name in the environment.
9775 If a variable is found then its value is placed in &$value$&
9776 and <&'string1'&> is expanded, otherwise <&'string2'&> is expanded.
9777
9778 Instead of {<&'string2'&>} the word &"fail"& (not in curly brackets) can
9779 appear, for example:
9780 .code
9781 ${env{USER}{$value} fail }
9782 .endd
9783 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9784 {<&'string1'&>} must be present for &"fail"& to be recognized.
9785
9786 If {<&'string2'&>} is omitted an empty string is substituted on
9787 search failure.
9788 If {<&'string1'&>} is omitted the search result is substituted on
9789 search success.
9790
9791 The environment is adjusted by the &%keep_environment%& and
9792 &%add_environment%& main section options.
9793
9794
9795 .vitem "&*${extract{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9796        {*&<&'string3'&>&*}}*&"
9797 .cindex "expansion" "extracting substrings by key"
9798 .cindex "&%extract%&" "substrings by key"
9799 The key and <&'string1'&> are first expanded separately. Leading and trailing
9800 white space is removed from the key (but not from any of the strings). The key
9801 must not be empty and must not consist entirely of digits.
9802 The expanded <&'string1'&> must be of the form:
9803 .display
9804 <&'key1'&> = <&'value1'&>  <&'key2'&> = <&'value2'&> ...
9805 .endd
9806 .vindex "&$value$&"
9807 where the equals signs and spaces (but not both) are optional. If any of the
9808 values contain white space, they must be enclosed in double quotes, and any
9809 values that are enclosed in double quotes are subject to escape processing as
9810 described in section &<<SECTstrings>>&. The expanded <&'string1'&> is searched
9811 for the value that corresponds to the key. The search is case-insensitive. If
9812 the key is found, <&'string2'&> is expanded, and replaces the whole item;
9813 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9814 variable &$value$& contains the value that has been extracted. Afterwards, it
9815 is restored to any previous value it might have had.
9816
9817 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9818 key is not found. If {<&'string2'&>} is also omitted, the value that was
9819 extracted is used. Thus, for example, these two expansions are identical, and
9820 yield &"2001"&:
9821 .code
9822 ${extract{gid}{uid=1984 gid=2001}}
9823 ${extract{gid}{uid=1984 gid=2001}{$value}}
9824 .endd
9825 Instead of {<&'string3'&>} the word &"fail"& (not in curly brackets) can
9826 appear, for example:
9827 .code
9828 ${extract{Z}{A=... B=...}{$value} fail }
9829 .endd
9830 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9831 {<&'string2'&>} must be present for &"fail"& to be recognized.
9832
9833 .vitem "&*${extract json{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9834        {*&<&'string3'&>&*}}*&" &&&
9835        "&*${extract jsons{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9836        {*&<&'string3'&>&*}}*&"
9837 .cindex "expansion" "extracting from JSON object"
9838 .cindex JSON expansions
9839 The key and <&'string1'&> are first expanded separately. Leading and trailing
9840 white space is removed from the key (but not from any of the strings). The key
9841 must not be empty and must not consist entirely of digits.
9842 The expanded <&'string1'&> must be of the form:
9843 .display
9844 { <&'"key1"'&> : <&'value1'&> ,  <&'"key2"'&> , <&'value2'&> ... }
9845 .endd
9846 .vindex "&$value$&"
9847 The braces, commas and colons, and the quoting of the member name are required;
9848 the spaces are optional.
9849 Matching of the key against the member names is done case-sensitively.
9850 For the &"json"& variant,
9851 if a returned value is a JSON string, it retains its leading and
9852 trailing quotes.
9853 For the &"jsons"& variant, which is intended for use with JSON strings, the
9854 leading and trailing quotes are removed from the returned value.
9855 . XXX should be a UTF-8 compare
9856
9857 The results of matching are handled as above.
9858
9859
9860 .vitem "&*${extract{*&<&'number'&>&*}{*&<&'separators'&>&*}&&&
9861         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9862 .cindex "expansion" "extracting substrings by number"
9863 .cindex "&%extract%&" "substrings by number"
9864 The <&'number'&> argument must consist entirely of decimal digits,
9865 apart from leading and trailing white space, which is ignored.
9866 This is what distinguishes this form of &%extract%& from the previous kind. It
9867 behaves in the same way, except that, instead of extracting a named field, it
9868 extracts from <&'string1'&> the field whose number is given as the first
9869 argument. You can use &$value$& in <&'string2'&> or &`fail`& instead of
9870 <&'string3'&> as before.
9871
9872 The fields in the string are separated by any one of the characters in the
9873 separator string. These may include space or tab characters.
9874 The first field is numbered one. If the number is negative, the fields are
9875 counted from the end of the string, with the rightmost one numbered -1. If the
9876 number given is zero, the entire string is returned. If the modulus of the
9877 number is greater than the number of fields in the string, the result is the
9878 expansion of <&'string3'&>, or the empty string if <&'string3'&> is not
9879 provided. For example:
9880 .code
9881 ${extract{2}{:}{x:42:99:& Mailer::/bin/bash}}
9882 .endd
9883 yields &"42"&, and
9884 .code
9885 ${extract{-4}{:}{x:42:99:& Mailer::/bin/bash}}
9886 .endd
9887 yields &"99"&. Two successive separators mean that the field between them is
9888 empty (for example, the fifth field above).
9889
9890
9891 .vitem "&*${extract json {*&<&'number'&>&*}}&&&
9892         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&" &&&
9893        "&*${extract jsons{*&<&'number'&>&*}}&&&
9894         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9895 .cindex "expansion" "extracting from JSON array"
9896 .cindex JSON expansions
9897 The <&'number'&> argument must consist entirely of decimal digits,
9898 apart from leading and trailing white space, which is ignored.
9899
9900 Field selection and result handling is as above;
9901 there is no choice of field separator.
9902 For the &"json"& variant,
9903 if a returned value is a JSON string, it retains its leading and
9904 trailing quotes.
9905 For the &"jsons"& variant, which is intended for use with JSON strings, the
9906 leading and trailing quotes are removed from the returned value.
9907
9908
9909 .vitem &*${filter{*&<&'string'&>&*}{*&<&'condition'&>&*}}*&
9910 .cindex "list" "selecting by condition"
9911 .cindex "expansion" "selecting from list by condition"
9912 .vindex "&$item$&"
9913 After expansion, <&'string'&> is interpreted as a list, colon-separated by
9914 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
9915 For each item
9916 in this list, its value is place in &$item$&, and then the condition is
9917 evaluated. If the condition is true, &$item$& is added to the output as an
9918 item in a new list; if the condition is false, the item is discarded. The
9919 separator used for the output list is the same as the one used for the
9920 input, but a separator setting is not included in the output. For example:
9921 .code
9922 ${filter{a:b:c}{!eq{$item}{b}}}
9923 .endd
9924 yields &`a:c`&. At the end of the expansion, the value of &$item$& is restored
9925 to what it was before. See also the &%map%& and &%reduce%& expansion items.
9926
9927
9928 .vitem &*${hash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9929 .cindex "hash function" "textual"
9930 .cindex "expansion" "textual hash"
9931 This is a textual hashing function, and was the first to be implemented in
9932 early versions of Exim. In current releases, there are other hashing functions
9933 (numeric, MD5, and SHA-1), which are described below.
9934
9935 The first two strings, after expansion, must be numbers. Call them <&'m'&> and
9936 <&'n'&>. If you are using fixed values for these numbers, that is, if
9937 <&'string1'&> and <&'string2'&> do not change when they are expanded, you can
9938 use the simpler operator notation that avoids some of the braces:
9939 .code
9940 ${hash_<n>_<m>:<string>}
9941 .endd
9942 The second number is optional (in both notations). If <&'n'&> is greater than
9943 or equal to the length of the string, the expansion item returns the string.
9944 Otherwise it computes a new string of length <&'n'&> by applying a hashing
9945 function to the string. The new string consists of characters taken from the
9946 first <&'m'&> characters of the string
9947 .code
9948 abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQWRSTUVWXYZ0123456789
9949 .endd
9950 If <&'m'&> is not present the value 26 is used, so that only lower case
9951 letters appear. For example:
9952 .display
9953 &`$hash{3}{monty}}           `&   yields  &`jmg`&
9954 &`$hash{5}{monty}}           `&   yields  &`monty`&
9955 &`$hash{4}{62}{monty python}}`&   yields  &`fbWx`&
9956 .endd
9957
9958 .vitem "&*$header_*&<&'header&~name'&>&*:*&&~or&~&&&
9959         &*$h_*&<&'header&~name'&>&*:*&" &&&
9960        "&*$bheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9961         &*$bh_*&<&'header&~name'&>&*:*&" &&&
9962        "&*$lheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9963         &*$lh_*&<&'header&~name'&>&*:*&" &&&
9964        "&*$rheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9965         &*$rh_*&<&'header&~name'&>&*:*&"
9966 .cindex "expansion" "header insertion"
9967 .vindex "&$header_$&"
9968 .vindex "&$bheader_$&"
9969 .vindex "&$lheader_$&"
9970 .vindex "&$rheader_$&"
9971 .cindex "header lines" "in expansion strings"
9972 .cindex "header lines" "character sets"
9973 .cindex "header lines" "decoding"
9974 Substitute the contents of the named message header line, for example
9975 .code
9976 $header_reply-to:
9977 .endd
9978 The newline that terminates a header line is not included in the expansion, but
9979 internal newlines (caused by splitting the header line over several physical
9980 lines) may be present.
9981
9982 The difference between the four pairs of expansions is in the way
9983 the data in the header line is interpreted.
9984
9985 .ilist
9986 .cindex "white space" "in header lines"
9987 &%rheader%& gives the original &"raw"& content of the header line, with no
9988 processing at all, and without the removal of leading and trailing white space.
9989
9990 .next
9991 .cindex "list" "of header lines"
9992 &%lheader%& gives a colon-separated list, one element per header when there
9993 are multiple headers with a given name.
9994 Any embedded colon characters within an element are doubled, so normal Exim
9995 list-processing facilities can be used.
9996 The terminating newline of each element is removed; in other respects
9997 the content is &"raw"&.
9998
9999 .next
10000 .cindex "base64 encoding" "in header lines"
10001 &%bheader%& removes leading and trailing white space, and then decodes base64
10002 or quoted-printable MIME &"words"& within the header text, but does no
10003 character set translation. If decoding of what looks superficially like a MIME
10004 &"word"& fails, the raw string is returned. If decoding
10005 .cindex "binary zero" "in header line"
10006 produces a binary zero character, it is replaced by a question mark &-- this is
10007 what Exim does for binary zeros that are actually received in header lines.
10008
10009 .next
10010 &%header%& tries to translate the string as decoded by &%bheader%& to a
10011 standard character set. This is an attempt to produce the same string as would
10012 be displayed on a user's MUA. If translation fails, the &%bheader%& string is
10013 returned. Translation is attempted only on operating systems that support the
10014 &[iconv()]& function. This is indicated by the compile-time macro HAVE_ICONV in
10015 a system Makefile or in &_Local/Makefile_&.
10016 .endlist ilist
10017
10018 In a filter file, the target character set for &%header%& can be specified by a
10019 command of the following form:
10020 .code
10021 headers charset "UTF-8"
10022 .endd
10023 This command affects all references to &$h_$& (or &$header_$&) expansions in
10024 subsequently obeyed filter commands. In the absence of this command, the target
10025 character set in a filter is taken from the setting of the &%headers_charset%&
10026 option in the runtime configuration. The value of this option defaults to the
10027 value of HEADERS_CHARSET in &_Local/Makefile_&. The ultimate default is
10028 ISO-8859-1.
10029
10030 Header names follow the syntax of RFC 2822, which states that they may contain
10031 any printing characters except space and colon. Consequently, curly brackets
10032 &'do not'& terminate header names, and should not be used to enclose them as
10033 if they were variables. Attempting to do so causes a syntax error.
10034
10035 Only header lines that are common to all copies of a message are visible to
10036 this mechanism. These are the original header lines that are received with the
10037 message, and any that are added by an ACL statement or by a system
10038 filter. Header lines that are added to a particular copy of a message by a
10039 router or transport are not accessible.
10040
10041 For incoming SMTP messages, no header lines are visible in
10042 ACLs that are obeyed before the data phase completes,
10043 because the header structure is not set up until the message is received.
10044 They are visible in DKIM, PRDR and DATA ACLs.
10045 Header lines that are added in a RCPT ACL (for example)
10046 are saved until the message's incoming header lines are available, at which
10047 point they are added.
10048 When any of the above ACLs ar
10049 running, however, header lines added by earlier ACLs are visible.
10050
10051 Upper case and lower case letters are synonymous in header names. If the
10052 following character is white space, the terminating colon may be omitted, but
10053 this is not recommended, because you may then forget it when it is needed. When
10054 white space terminates the header name, this white space is included in the
10055 expanded string.  If the message does not contain the given header, the
10056 expansion item is replaced by an empty string. (See the &%def%& condition in
10057 section &<<SECTexpcond>>& for a means of testing for the existence of a
10058 header.)
10059
10060 If there is more than one header with the same name, they are all concatenated
10061 to form the substitution string, up to a maximum length of 64K. Unless
10062 &%rheader%& is being used, leading and trailing white space is removed from
10063 each header before concatenation, and a completely empty header is ignored. A
10064 newline character is then inserted between non-empty headers, but there is no
10065 newline at the very end. For the &%header%& and &%bheader%& expansion, for
10066 those headers that contain lists of addresses, a comma is also inserted at the
10067 junctions between headers. This does not happen for the &%rheader%& expansion.
10068
10069 .cindex "tainted data"
10070 When the headers are from an incoming message,
10071 the result of expanding any of these variables is tainted.
10072
10073
10074 .vitem &*${hmac{*&<&'hashname'&>&*}{*&<&'secret'&>&*}{*&<&'string'&>&*}}*&
10075 .cindex "expansion" "hmac hashing"
10076 .cindex &%hmac%&
10077 This function uses cryptographic hashing (either MD5 or SHA-1) to convert a
10078 shared secret and some text into a message authentication code, as specified in
10079 RFC 2104. This differs from &`${md5:secret_text...}`& or
10080 &`${sha1:secret_text...}`& in that the hmac step adds a signature to the
10081 cryptographic hash, allowing for authentication that is not possible with MD5
10082 or SHA-1 alone. The hash name must expand to either &`md5`& or &`sha1`& at
10083 present. For example:
10084 .code
10085 ${hmac{md5}{somesecret}{$primary_hostname $tod_log}}
10086 .endd
10087 For the hostname &'mail.example.com'& and time 2002-10-17 11:30:59, this
10088 produces:
10089 .code
10090 dd97e3ba5d1a61b5006108f8c8252953
10091 .endd
10092 As an example of how this might be used, you might put in the main part of
10093 an Exim configuration:
10094 .code
10095 SPAMSCAN_SECRET=cohgheeLei2thahw
10096 .endd
10097 In a router or a transport you could then have:
10098 .code
10099 headers_add = \
10100   X-Spam-Scanned: ${primary_hostname} ${message_exim_id} \
10101   ${hmac{md5}{SPAMSCAN_SECRET}\
10102   {${primary_hostname},${message_exim_id},$h_message-id:}}
10103 .endd
10104 Then given a message, you can check where it was scanned by looking at the
10105 &'X-Spam-Scanned:'& header line. If you know the secret, you can check that
10106 this header line is authentic by recomputing the authentication code from the
10107 host name, message ID and the &'Message-id:'& header line. This can be done
10108 using Exim's &%-be%& option, or by other means, for example, by using the
10109 &'hmac_md5_hex()'& function in Perl.
10110
10111
10112 .vitem &*${if&~*&<&'condition'&>&*&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
10113 .cindex "expansion" "conditional"
10114 .cindex "&%if%&, expansion item"
10115 If <&'condition'&> is true, <&'string1'&> is expanded and replaces the whole
10116 item; otherwise <&'string2'&> is used. The available conditions are described
10117 in section &<<SECTexpcond>>& below. For example:
10118 .code
10119 ${if eq {$local_part}{postmaster} {yes}{no} }
10120 .endd
10121 The second string need not be present; if it is not and the condition is not
10122 true, the item is replaced with nothing. Alternatively, the word &"fail"& may
10123 be present instead of the second string (without any curly brackets). In this
10124 case, the expansion is forced to fail if the condition is not true (see section
10125 &<<SECTforexpfai>>&).
10126
10127 If both strings are omitted, the result is the string &`true`& if the condition
10128 is true, and the empty string if the condition is false. This makes it less
10129 cumbersome to write custom ACL and router conditions. For example, instead of
10130 .code
10131 condition = ${if >{$acl_m4}{3}{true}{false}}
10132 .endd
10133 you can use
10134 .code
10135 condition = ${if >{$acl_m4}{3}}
10136 .endd
10137
10138
10139
10140 .vitem &*${imapfolder{*&<&'foldername'&>&*}}*&
10141 .cindex expansion "imap folder"
10142 .cindex "&%imapfolder%& expansion item"
10143 This item converts a (possibly multilevel, or with non-ASCII characters)
10144 folder specification to a Maildir name for filesystem use.
10145 For information on internationalisation support see &<<SECTi18nMDA>>&.
10146
10147
10148
10149 .vitem &*${length{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
10150 .cindex "expansion" "string truncation"
10151 .cindex "&%length%& expansion item"
10152 The &%length%& item is used to extract the initial portion of a string. Both
10153 strings are expanded, and the first one must yield a number, <&'n'&>, say. If
10154 you are using a fixed value for the number, that is, if <&'string1'&> does not
10155 change when expanded, you can use the simpler operator notation that avoids
10156 some of the braces:
10157 .code
10158 ${length_<n>:<string>}
10159 .endd
10160 The result of this item is either the first <&'n'&> bytes or the whole
10161 of <&'string2'&>, whichever is the shorter. Do not confuse &%length%& with
10162 &%strlen%&, which gives the length of a string.
10163 All measurement is done in bytes and is not UTF-8 aware.
10164
10165
10166 .vitem "&*${listextract{*&<&'number'&>&*}&&&
10167         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
10168 .cindex "expansion" "extracting list elements by number"
10169 .cindex "&%listextract%&" "extract list elements by number"
10170 .cindex "list" "extracting elements by number"
10171 The <&'number'&> argument must consist entirely of decimal digits,
10172 apart from an optional leading minus,
10173 and leading and trailing white space (which is ignored).
10174
10175 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
10176 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10177
10178 The first field of the list is numbered one.
10179 If the number is negative, the fields are
10180 counted from the end of the list, with the rightmost one numbered -1.
10181 The numbered element of the list is extracted and placed in &$value$&,
10182 then <&'string2'&> is expanded as the result.
10183
10184 If the modulus of the
10185 number is zero or greater than the number of fields in the string,
10186 the result is the expansion of <&'string3'&>.
10187
10188 For example:
10189 .code
10190 ${listextract{2}{x:42:99}}
10191 .endd
10192 yields &"42"&, and
10193 .code
10194 ${listextract{-3}{<, x,42,99,& Mailer,,/bin/bash}{result: $value}}
10195 .endd
10196 yields &"result: 42"&.
10197
10198 If {<&'string3'&>} is omitted, an empty string is used for string3.
10199 If {<&'string2'&>} is also omitted, the value that was
10200 extracted is used.
10201 You can use &`fail`& instead of {<&'string3'&>} as in a string extract.
10202
10203
10204 .new
10205 .vitem &*${listquote{*&<&'separator'&>&*}{*&<&'string'&>&*}}*&
10206 .cindex quoting "for list"
10207 .cindex list quoting
10208 This item doubles any occurrence of the separator character
10209 in the given string.
10210 An empty string is replaced with a single space.
10211 This converts the string into a safe form for use as a list element,
10212 in a list using the given separator.
10213 .wen
10214
10215
10216 .vitem "&*${lookup&~{*&<&'key'&>&*}&~*&<&'search&~type'&>&*&~&&&
10217         {*&<&'file'&>&*}&~{*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&" &&&
10218        "&*${lookup&~*&<&'search&~type'&>&*&~{*&<&'query'&>&*}&~&&&
10219         {*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
10220 .cindex "expansion" "lookup in"
10221 .cindex "file" "lookups"
10222 .cindex "lookup" "in expanded string"
10223 The two forms of lookup item specify data lookups in files and databases, as
10224 discussed in chapter &<<CHAPfdlookup>>&. The first form is used for single-key
10225 lookups, and the second is used for query-style lookups. The <&'key'&>,
10226 <&'file'&>, and <&'query'&> strings are expanded before use.
10227
10228 If there is any white space in a lookup item which is part of a filter command,
10229 a retry or rewrite rule, a routing rule for the &(manualroute)& router, or any
10230 other place where white space is significant, the lookup item must be enclosed
10231 in double quotes. The use of data lookups in users' filter files may be locked
10232 out by the system administrator.
10233
10234 .vindex "&$value$&"
10235 If the lookup succeeds, <&'string1'&> is expanded and replaces the entire item.
10236 During its expansion, the variable &$value$& contains the data returned by the
10237 lookup. Afterwards it reverts to the value it had previously (at the outer
10238 level it is empty). If the lookup fails, <&'string2'&> is expanded and replaces
10239 the entire item. If {<&'string2'&>} is omitted, the replacement is the empty
10240 string on failure. If <&'string2'&> is provided, it can itself be a nested
10241 lookup, thus providing a mechanism for looking up a default value when the
10242 original lookup fails.
10243
10244 If a nested lookup is used as part of <&'string1'&>, &$value$& contains the
10245 data for the outer lookup while the parameters of the second lookup are
10246 expanded, and also while <&'string2'&> of the second lookup is expanded, should
10247 the second lookup fail. Instead of {<&'string2'&>} the word &"fail"& can
10248 appear, and in this case, if the lookup fails, the entire expansion is forced
10249 to fail (see section &<<SECTforexpfai>>&). If both {<&'string1'&>} and
10250 {<&'string2'&>} are omitted, the result is the looked up value in the case of a
10251 successful lookup, and nothing in the case of failure.
10252
10253 For single-key lookups, the string &"partial"& is permitted to precede the
10254 search type in order to do partial matching, and * or *@ may follow a search
10255 type to request default lookups if the key does not match (see sections
10256 &<<SECTdefaultvaluelookups>>& and &<<SECTpartiallookup>>& for details).
10257
10258 .cindex "numerical variables (&$1$& &$2$& etc)" "in lookup expansion"
10259 If a partial search is used, the variables &$1$& and &$2$& contain the wild
10260 and non-wild parts of the key during the expansion of the replacement text.
10261 They return to their previous values at the end of the lookup item.
10262
10263 This example looks up the postmaster alias in the conventional alias file:
10264 .code
10265 ${lookup {postmaster} lsearch {/etc/aliases} {$value}}
10266 .endd
10267 This example uses NIS+ to look up the full name of the user corresponding to
10268 the local part of an address, forcing the expansion to fail if it is not found:
10269 .code
10270 ${lookup nisplus {[name=$local_part],passwd.org_dir:gcos} \
10271   {$value}fail}
10272 .endd
10273
10274
10275 .vitem &*${map{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
10276 .cindex "expansion" "list creation"
10277 .vindex "&$item$&"
10278 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
10279 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10280 For each item
10281 in this list, its value is place in &$item$&, and then <&'string2'&> is
10282 expanded and added to the output as an item in a new list. The separator used
10283 for the output list is the same as the one used for the input, but a separator
10284 setting is not included in the output. For example:
10285 .code
10286 ${map{a:b:c}{[$item]}} ${map{<- x-y-z}{($item)}}
10287 .endd
10288 expands to &`[a]:[b]:[c] (x)-(y)-(z)`&. At the end of the expansion, the
10289 value of &$item$& is restored to what it was before. See also the &%filter%&
10290 and &%reduce%& expansion items.
10291
10292 .vitem &*${nhash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
10293 .cindex "expansion" "numeric hash"
10294 .cindex "hash function" "numeric"
10295 The three strings are expanded; the first two must yield numbers. Call them
10296 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
10297 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
10298 can use the simpler operator notation that avoids some of the braces:
10299 .code
10300 ${nhash_<n>_<m>:<string>}
10301 .endd
10302 The second number is optional (in both notations). If there is only one number,
10303 the result is a number in the range 0&--<&'n'&>-1. Otherwise, the string is
10304 processed by a div/mod hash function that returns two numbers, separated by a
10305 slash, in the ranges 0 to <&'n'&>-1 and 0 to <&'m'&>-1, respectively. For
10306 example,
10307 .code
10308 ${nhash{8}{64}{supercalifragilisticexpialidocious}}
10309 .endd
10310 returns the string &"6/33"&.
10311
10312
10313
10314 .vitem &*${perl{*&<&'subroutine'&>&*}{*&<&'arg'&>&*}{*&<&'arg'&>&*}...}*&
10315 .cindex "Perl" "use in expanded string"
10316 .cindex "expansion" "calling Perl from"
10317 This item is available only if Exim has been built to include an embedded Perl
10318 interpreter. The subroutine name and the arguments are first separately
10319 expanded, and then the Perl subroutine is called with those arguments. No
10320 additional arguments need be given; the maximum number permitted, including the
10321 name of the subroutine, is nine.
10322
10323 The return value of the subroutine is inserted into the expanded string, unless
10324 the return value is &%undef%&. In that case, the expansion fails in the same
10325 way as an explicit &"fail"& on a lookup item. The return value is a scalar.
10326 Whatever you return is evaluated in a scalar context. For example, if you
10327 return the name of a Perl vector, the return value is the size of the vector,
10328 not its contents.
10329
10330 If the subroutine exits by calling Perl's &%die%& function, the expansion fails
10331 with the error message that was passed to &%die%&. More details of the embedded
10332 Perl facility are given in chapter &<<CHAPperl>>&.
10333
10334 The &(redirect)& router has an option called &%forbid_filter_perl%& which locks
10335 out the use of this expansion item in filter files.
10336
10337
10338 .vitem &*${prvs{*&<&'address'&>&*}{*&<&'secret'&>&*}{*&<&'keynumber'&>&*}}*&
10339 .cindex "&%prvs%& expansion item"
10340 The first argument is a complete email address and the second is secret
10341 keystring. The third argument, specifying a key number, is optional. If absent,
10342 it defaults to 0. The result of the expansion is a prvs-signed email address,
10343 to be typically used with the &%return_path%& option on an &(smtp)& transport
10344 as part of a bounce address tag validation (BATV) scheme. For more discussion
10345 and an example, see section &<<SECTverifyPRVS>>&.
10346
10347 .vitem "&*${prvscheck{*&<&'address'&>&*}{*&<&'secret'&>&*}&&&
10348         {*&<&'string'&>&*}}*&"
10349 .cindex "&%prvscheck%& expansion item"
10350 This expansion item is the complement of the &%prvs%& item. It is used for
10351 checking prvs-signed addresses. If the expansion of the first argument does not
10352 yield a syntactically valid prvs-signed address, the whole item expands to the
10353 empty string. When the first argument does expand to a syntactically valid
10354 prvs-signed address, the second argument is expanded, with the prvs-decoded
10355 version of the address and the key number extracted from the address in the
10356 variables &$prvscheck_address$& and &$prvscheck_keynum$&, respectively.
10357
10358 These two variables can be used in the expansion of the second argument to
10359 retrieve the secret. The validity of the prvs-signed address is then checked
10360 against the secret. The result is stored in the variable &$prvscheck_result$&,
10361 which is empty for failure or &"1"& for success.
10362
10363 The third argument is optional; if it is missing, it defaults to an empty
10364 string. This argument is now expanded. If the result is an empty string, the
10365 result of the expansion is the decoded version of the address. This is the case
10366 whether or not the signature was valid. Otherwise, the result of the expansion
10367 is the expansion of the third argument.
10368
10369 All three variables can be used in the expansion of the third argument.
10370 However, once the expansion is complete, only &$prvscheck_result$& remains set.
10371 For more discussion and an example, see section &<<SECTverifyPRVS>>&.
10372
10373 .vitem &*${readfile{*&<&'file&~name'&>&*}{*&<&'eol&~string'&>&*}}*&
10374 .cindex "expansion" "inserting an entire file"
10375 .cindex "file" "inserting into expansion"
10376 .cindex "&%readfile%& expansion item"
10377 The filename and end-of-line string are first expanded separately. The file is
10378 then read, and its contents replace the entire item. All newline characters in
10379 the file are replaced by the end-of-line string if it is present. Otherwise,
10380 newlines are left in the string.
10381 String expansion is not applied to the contents of the file. If you want this,
10382 you must wrap the item in an &%expand%& operator. If the file cannot be read,
10383 the string expansion fails.
10384
10385 The &(redirect)& router has an option called &%forbid_filter_readfile%& which
10386 locks out the use of this expansion item in filter files.
10387
10388
10389
10390 .vitem "&*${readsocket{*&<&'name'&>&*}{*&<&'request'&>&*}&&&
10391         {*&<&'options'&>&*}{*&<&'eol&~string'&>&*}{*&<&'fail&~string'&>&*}}*&"
10392 .cindex "expansion" "inserting from a socket"
10393 .cindex "socket, use of in expansion"
10394 .cindex "&%readsocket%& expansion item"
10395 This item inserts data from a Unix domain or TCP socket into the expanded
10396 string. The minimal way of using it uses just two arguments, as in these
10397 examples:
10398 .code
10399 ${readsocket{/socket/name}{request string}}
10400 ${readsocket{inet:some.host:1234}{request string}}
10401 .endd
10402 For a Unix domain socket, the first substring must be the path to the socket.
10403 For an Internet socket, the first substring must contain &`inet:`& followed by
10404 a host name or IP address, followed by a colon and a port, which can be a
10405 number or the name of a TCP port in &_/etc/services_&. An IP address may
10406 optionally be enclosed in square brackets. This is best for IPv6 addresses. For
10407 example:
10408 .code
10409 ${readsocket{inet:[::1]:1234}{request string}}
10410 .endd
10411 Only a single host name may be given, but if looking it up yields more than
10412 one IP address, they are each tried in turn until a connection is made. For
10413 both kinds of socket, Exim makes a connection, writes the request string
10414 unless it is an empty string; and no terminating NUL is ever sent)
10415 and reads from the socket until an end-of-file
10416 is read. A timeout of 5 seconds is applied. Additional, optional arguments
10417 extend what can be done. Firstly, you can vary the timeout. For example:
10418 .code
10419 ${readsocket{/socket/name}{request string}{3s}}
10420 .endd
10421
10422 The third argument is a list of options, of which the first element is the timeout
10423 and must be present if any options are given.
10424 Further elements are options of form &'name=value'&.
10425 Example:
10426 .code
10427 ${readsocket{/socket/name}{request string}{3s:shutdown=no}}
10428 .endd
10429
10430 The following option names are recognised:
10431 .ilist
10432 &*cache*&
10433 Defines if the result data can be cached for use by a later identical
10434 request in the same process.
10435 Values are &"yes"& or &"no"& (the default).
10436 If not, all cached results for this connection specification
10437 will be invalidated.
10438
10439 .next
10440 &*shutdown*&
10441 Defines whether or not a write-shutdown is done on the connection after
10442 sending the request. Values are &"yes"& (the default) or &"no"&
10443 (preferred, eg. by some webservers).
10444
10445 .next
10446 &*tls*&
10447 Controls the use of TLS on the connection.
10448 Values are &"yes"& or &"no"& (the default).
10449 If it is enabled, a shutdown as descripbed above is never done.
10450 .endlist
10451
10452
10453 A fourth argument allows you to change any newlines that are in the data
10454 that is read, in the same way as for &%readfile%& (see above). This example
10455 turns them into spaces:
10456 .code
10457 ${readsocket{inet:127.0.0.1:3294}{request string}{3s}{ }}
10458 .endd
10459 As with all expansions, the substrings are expanded before the processing
10460 happens. Errors in these sub-expansions cause the expansion to fail. In
10461 addition, the following errors can occur:
10462
10463 .ilist
10464 Failure to create a socket file descriptor;
10465 .next
10466 Failure to connect the socket;
10467 .next
10468 Failure to write the request string;
10469 .next
10470 Timeout on reading from the socket.
10471 .endlist
10472
10473 By default, any of these errors causes the expansion to fail. However, if
10474 you supply a fifth substring, it is expanded and used when any of the above
10475 errors occurs. For example:
10476 .code
10477 ${readsocket{/socket/name}{request string}{3s}{\n}\
10478   {socket failure}}
10479 .endd
10480 You can test for the existence of a Unix domain socket by wrapping this
10481 expansion in &`${if exists`&, but there is a race condition between that test
10482 and the actual opening of the socket, so it is safer to use the fifth argument
10483 if you want to be absolutely sure of avoiding an expansion error for a
10484 non-existent Unix domain socket, or a failure to connect to an Internet socket.
10485
10486 The &(redirect)& router has an option called &%forbid_filter_readsocket%& which
10487 locks out the use of this expansion item in filter files.
10488
10489
10490 .vitem &*${reduce{*&<&'string1'&>}{<&'string2'&>&*}{*&<&'string3'&>&*}}*&
10491 .cindex "expansion" "reducing a list to a scalar"
10492 .cindex "list" "reducing to a scalar"
10493 .vindex "&$value$&"
10494 .vindex "&$item$&"
10495 This operation reduces a list to a single, scalar string. After expansion,
10496 <&'string1'&> is interpreted as a list, colon-separated by default, but the
10497 separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10498 Then <&'string2'&> is expanded and
10499 assigned to the &$value$& variable. After this, each item in the <&'string1'&>
10500 list is assigned to &$item$&, in turn, and <&'string3'&> is expanded for each of
10501 them. The result of that expansion is assigned to &$value$& before the next
10502 iteration. When the end of the list is reached, the final value of &$value$& is
10503 added to the expansion output. The &%reduce%& expansion item can be used in a
10504 number of ways. For example, to add up a list of numbers:
10505 .code
10506 ${reduce {<, 1,2,3}{0}{${eval:$value+$item}}}
10507 .endd
10508 The result of that expansion would be &`6`&. The maximum of a list of numbers
10509 can be found:
10510 .code
10511 ${reduce {3:0:9:4:6}{0}{${if >{$item}{$value}{$item}{$value}}}}
10512 .endd
10513 At the end of a &*reduce*& expansion, the values of &$item$& and &$value$& are
10514 restored to what they were before. See also the &%filter%& and &%map%&
10515 expansion items.
10516
10517 .vitem &*$rheader_*&<&'header&~name'&>&*:*&&~or&~&*$rh_*&<&'header&~name'&>&*:*&
10518 This item inserts &"raw"& header lines. It is described with the &%header%&
10519 expansion item in section &<<SECTexpansionitems>>& above.
10520
10521 .vitem "&*${run{*&<&'command'&>&*&~*&<&'args'&>&*}{*&<&'string1'&>&*}&&&
10522         {*&<&'string2'&>&*}}*&"
10523 .cindex "expansion" "running a command"
10524 .cindex "&%run%& expansion item"
10525 The command and its arguments are first expanded as one string. The string is
10526 split apart into individual arguments by spaces, and then the command is run
10527 in a separate process, but under the same uid and gid.  As in other command
10528 executions from Exim, a shell is not used by default. If the command requires
10529 a shell, you must explicitly code it.
10530
10531 Since the arguments are split by spaces, when there is a variable expansion
10532 which has an empty result, it will cause the situation that the argument will
10533 simply be omitted when the program is actually executed by Exim. If the
10534 script/program requires a specific number of arguments and the expanded
10535 variable could possibly result in this empty expansion, the variable must be
10536 quoted. This is more difficult if the expanded variable itself could result
10537 in a string containing quotes, because it would interfere with the quotes
10538 around the command arguments. A possible guard against this is to wrap the
10539 variable in the &%sg%& operator to change any quote marks to some other
10540 character.
10541
10542 The standard input for the command exists, but is empty. The standard output
10543 and standard error are set to the same file descriptor.
10544 .cindex "return code" "from &%run%& expansion"
10545 .vindex "&$value$&"
10546 If the command succeeds (gives a zero return code) <&'string1'&> is expanded
10547 and replaces the entire item; during this expansion, the standard output/error
10548 from the command is in the variable &$value$&. If the command fails,
10549 <&'string2'&>, if present, is expanded and used. Once again, during the
10550 expansion, the standard output/error from the command is in the variable
10551 &$value$&.
10552
10553 If <&'string2'&> is absent, the result is empty. Alternatively, <&'string2'&>
10554 can be the word &"fail"& (not in braces) to force expansion failure if the
10555 command does not succeed. If both strings are omitted, the result is contents
10556 of the standard output/error on success, and nothing on failure.
10557
10558 .vindex "&$run_in_acl$&"
10559 The standard output/error of the command is put in the variable &$value$&.
10560 In this ACL example, the output of a command is logged for the admin to
10561 troubleshoot:
10562 .code
10563 warn  condition    = ${run{/usr/bin/id}{yes}{no}}
10564       log_message  = Output of id: $value
10565 .endd
10566 If the command requires shell idioms, such as the > redirect operator, the
10567 shell must be invoked directly, such as with:
10568 .code
10569 ${run{/bin/bash -c "/usr/bin/id >/tmp/id"}{yes}{yes}}
10570 .endd
10571
10572 .vindex "&$runrc$&"
10573 The return code from the command is put in the variable &$runrc$&, and this
10574 remains set afterwards, so in a filter file you can do things like this:
10575 .code
10576 if "${run{x y z}{}}$runrc" is 1 then ...
10577   elif $runrc is 2 then ...
10578   ...
10579 endif
10580 .endd
10581 If execution of the command fails (for example, the command does not exist),
10582 the return code is 127 &-- the same code that shells use for non-existent
10583 commands.
10584
10585 &*Warning*&: In a router or transport, you cannot assume the order in which
10586 option values are expanded, except for those preconditions whose order of
10587 testing is documented. Therefore, you cannot reliably expect to set &$runrc$&
10588 by the expansion of one option, and use it in another.
10589
10590 The &(redirect)& router has an option called &%forbid_filter_run%& which locks
10591 out the use of this expansion item in filter files.
10592
10593
10594 .vitem &*${sg{*&<&'subject'&>&*}{*&<&'regex'&>&*}{*&<&'replacement'&>&*}}*&
10595 .cindex "expansion" "string substitution"
10596 .cindex "&%sg%& expansion item"
10597 This item works like Perl's substitution operator (s) with the global (/g)
10598 option; hence its name. However, unlike the Perl equivalent, Exim does not
10599 modify the subject string; instead it returns the modified string for insertion
10600 into the overall expansion. The item takes three arguments: the subject string,
10601 a regular expression, and a substitution string. For example:
10602 .code
10603 ${sg{abcdefabcdef}{abc}{xyz}}
10604 .endd
10605 yields &"xyzdefxyzdef"&. Because all three arguments are expanded before use,
10606 if any $, } or \ characters are required in the regular expression or in the
10607 substitution string, they have to be escaped. For example:
10608 .code
10609 ${sg{abcdef}{^(...)(...)\$}{\$2\$1}}
10610 .endd
10611 yields &"defabc"&, and
10612 .code
10613 ${sg{1=A 4=D 3=C}{\N(\d+)=\N}{K\$1=}}
10614 .endd
10615 yields &"K1=A K4=D K3=C"&. Note the use of &`\N`& to protect the contents of
10616 the regular expression from string expansion.
10617
10618 The regular expression is compiled in 8-bit mode, working against bytes
10619 rather than any Unicode-aware character handling.
10620
10621
10622 .vitem &*${sort{*&<&'string'&>&*}{*&<&'comparator'&>&*}{*&<&'extractor'&>&*}}*&
10623 .cindex sorting "a list"
10624 .cindex list sorting
10625 .cindex expansion "list sorting"
10626 After expansion, <&'string'&> is interpreted as a list, colon-separated by
10627 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10628 The <&'comparator'&> argument is interpreted as the operator
10629 of a two-argument expansion condition.
10630 The numeric operators plus ge, gt, le, lt (and ~i variants) are supported.
10631 The comparison should return true when applied to two values
10632 if the first value should sort before the second value.
10633 The <&'extractor'&> expansion is applied repeatedly to elements of the list,
10634 the element being placed in &$item$&,
10635 to give values for comparison.
10636
10637 The item result is a sorted list,
10638 with the original list separator,
10639 of the list elements (in full) of the original.
10640
10641 Examples:
10642 .code
10643 ${sort{3:2:1:4}{<}{$item}}
10644 .endd
10645 sorts a list of numbers, and
10646 .code
10647 ${sort {${lookup dnsdb{>:,,mx=example.com}}} {<} {${listextract{1}{<,$item}}}}
10648 .endd
10649 will sort an MX lookup into priority order.
10650
10651
10652
10653 .new
10654 .vitem &*${srs_encode&~{*&<&'secret'&>&*}{*&<&'return&~path'&>&*}{*&<&'original&~domain'&>&*}}*&
10655 SRS encoding.  See SECT &<<SECTSRS>>& for details.
10656 .wen
10657
10658
10659
10660 .vitem &*${substr{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
10661 .cindex "&%substr%& expansion item"
10662 .cindex "substring extraction"
10663 .cindex "expansion" "substring extraction"
10664 The three strings are expanded; the first two must yield numbers. Call them
10665 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
10666 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
10667 can use the simpler operator notation that avoids some of the braces:
10668 .code
10669 ${substr_<n>_<m>:<string>}
10670 .endd
10671 The second number is optional (in both notations).
10672 If it is absent in the simpler format, the preceding underscore must also be
10673 omitted.
10674
10675 The &%substr%& item can be used to extract more general substrings than
10676 &%length%&. The first number, <&'n'&>, is a starting offset, and <&'m'&> is the
10677 length required. For example
10678 .code
10679 ${substr{3}{2}{$local_part}}
10680 .endd
10681 If the starting offset is greater than the string length the result is the
10682 null string; if the length plus starting offset is greater than the string
10683 length, the result is the right-hand part of the string, starting from the
10684 given offset. The first byte (character) in the string has offset zero.
10685
10686 The &%substr%& expansion item can take negative offset values to count
10687 from the right-hand end of its operand. The last byte (character) is offset -1,
10688 the second-last is offset -2, and so on. Thus, for example,
10689 .code
10690 ${substr{-5}{2}{1234567}}
10691 .endd
10692 yields &"34"&. If the absolute value of a negative offset is greater than the
10693 length of the string, the substring starts at the beginning of the string, and
10694 the length is reduced by the amount of overshoot. Thus, for example,
10695 .code
10696 ${substr{-5}{2}{12}}
10697 .endd
10698 yields an empty string, but
10699 .code
10700 ${substr{-3}{2}{12}}
10701 .endd
10702 yields &"1"&.
10703
10704 When the second number is omitted from &%substr%&, the remainder of the string
10705 is taken if the offset is positive. If it is negative, all bytes (characters) in the
10706 string preceding the offset point are taken. For example, an offset of -1 and
10707 no length, as in these semantically identical examples:
10708 .code
10709 ${substr_-1:abcde}
10710 ${substr{-1}{abcde}}
10711 .endd
10712 yields all but the last character of the string, that is, &"abcd"&.
10713
10714 All measurement is done in bytes and is not UTF-8 aware.
10715
10716
10717
10718 .vitem "&*${tr{*&<&'subject'&>&*}{*&<&'characters'&>&*}&&&
10719         {*&<&'replacements'&>&*}}*&"
10720 .cindex "expansion" "character translation"
10721 .cindex "&%tr%& expansion item"
10722 This item does single-character (in bytes) translation on its subject string. The second
10723 argument is a list of characters to be translated in the subject string. Each
10724 matching character is replaced by the corresponding character from the
10725 replacement list. For example
10726 .code
10727 ${tr{abcdea}{ac}{13}}
10728 .endd
10729 yields &`1b3de1`&. If there are duplicates in the second character string, the
10730 last occurrence is used. If the third string is shorter than the second, its
10731 last character is replicated. However, if it is empty, no translation takes
10732 place.
10733
10734 All character handling is done in bytes and is not UTF-8 aware.
10735
10736 .endlist
10737
10738
10739
10740 .section "Expansion operators" "SECTexpop"
10741 .cindex "expansion" "operators"
10742 For expansion items that perform transformations on a single argument string,
10743 the &"operator"& notation is used because it is simpler and uses fewer braces.
10744 The substring is first expanded before the operation is applied to it. The
10745 following operations can be performed:
10746
10747 .vlist
10748 .vitem &*${address:*&<&'string'&>&*}*&
10749 .cindex "expansion" "RFC 2822 address handling"
10750 .cindex "&%address%& expansion item"
10751 The string is interpreted as an RFC 2822 address, as it might appear in a
10752 header line, and the effective address is extracted from it. If the string does
10753 not parse successfully, the result is empty.
10754
10755 The parsing correctly handles SMTPUTF8 Unicode in the string.
10756
10757
10758 .vitem &*${addresses:*&<&'string'&>&*}*&
10759 .cindex "expansion" "RFC 2822 address handling"
10760 .cindex "&%addresses%& expansion item"
10761 The string (after expansion) is interpreted as a list of addresses in RFC
10762 2822 format, such as can be found in a &'To:'& or &'Cc:'& header line. The
10763 operative address (&'local-part@domain'&) is extracted from each item, and the
10764 result of the expansion is a colon-separated list, with appropriate
10765 doubling of colons should any happen to be present in the email addresses.
10766 Syntactically invalid RFC2822 address items are omitted from the output.
10767
10768 It is possible to specify a character other than colon for the output
10769 separator by starting the string with > followed by the new separator
10770 character. For example:
10771 .code
10772 ${addresses:>& Chief <ceo@up.stairs>, sec@base.ment (dogsbody)}
10773 .endd
10774 expands to &`ceo@up.stairs&&sec@base.ment`&. The string is expanded
10775 first, so if the expanded string starts with >, it may change the output
10776 separator unintentionally. This can be avoided by setting the output
10777 separator explicitly:
10778 .code
10779 ${addresses:>:$h_from:}
10780 .endd
10781
10782 Compare the &%address%& (singular)
10783 expansion item, which extracts the working address from a single RFC2822
10784 address. See the &%filter%&, &%map%&, and &%reduce%& items for ways of
10785 processing lists.
10786
10787 To clarify "list of addresses in RFC 2822 format" mentioned above, Exim follows
10788 a strict interpretation of header line formatting.  Exim parses the bare,
10789 unquoted portion of an email address and if it finds a comma, treats it as an
10790 email address separator. For the example header line:
10791 .code
10792 From: =?iso-8859-2?Q?Last=2C_First?= <user@example.com>
10793 .endd
10794 The first example below demonstrates that Q-encoded email addresses are parsed
10795 properly if it is given the raw header (in this example, &`$rheader_from:`&).
10796 It does not see the comma because it's still encoded as "=2C".  The second
10797 example below is passed the contents of &`$header_from:`&, meaning it gets
10798 de-mimed. Exim sees the decoded "," so it treats it as &*two*& email addresses.
10799 The third example shows that the presence of a comma is skipped when it is
10800 quoted.  The fourth example shows SMTPUTF8 handling.
10801 .code
10802 # exim -be '${addresses:From: \
10803 =?iso-8859-2?Q?Last=2C_First?= <user@example.com>}'
10804 user@example.com
10805 # exim -be '${addresses:From: Last, First <user@example.com>}'
10806 Last:user@example.com
10807 # exim -be '${addresses:From: "Last, First" <user@example.com>}'
10808 user@example.com
10809 # exim -be '${addresses:フィル <フィリップ@example.jp>}'
10810 フィリップ@example.jp
10811 .endd
10812
10813 .vitem &*${base32:*&<&'digits'&>&*}*&
10814 .cindex "&%base32%& expansion item"
10815 .cindex "expansion" "conversion to base 32"
10816 The string must consist entirely of decimal digits. The number is converted to
10817 base 32 and output as a (empty, for zero) string of characters.
10818 Only lowercase letters are used.
10819
10820 .vitem &*${base32d:*&<&'base-32&~digits'&>&*}*&
10821 .cindex "&%base32d%& expansion item"
10822 .cindex "expansion" "conversion to base 32"
10823 The string must consist entirely of base-32 digits.
10824 The number is converted to decimal and output as a string.
10825
10826 .vitem &*${base62:*&<&'digits'&>&*}*&
10827 .cindex "&%base62%& expansion item"
10828 .cindex "expansion" "conversion to base 62"
10829 The string must consist entirely of decimal digits. The number is converted to
10830 base 62 and output as a string of six characters, including leading zeros. In
10831 the few operating environments where Exim uses base 36 instead of base 62 for
10832 its message identifiers (because those systems do not have case-sensitive
10833 filenames), base 36 is used by this operator, despite its name. &*Note*&: Just
10834 to be absolutely clear: this is &'not'& base64 encoding.
10835
10836 .vitem &*${base62d:*&<&'base-62&~digits'&>&*}*&
10837 .cindex "&%base62d%& expansion item"
10838 .cindex "expansion" "conversion to base 62"
10839 The string must consist entirely of base-62 digits, or, in operating
10840 environments where Exim uses base 36 instead of base 62 for its message
10841 identifiers, base-36 digits. The number is converted to decimal and output as a
10842 string.
10843
10844 .vitem &*${base64:*&<&'string'&>&*}*&
10845 .cindex "expansion" "base64 encoding"
10846 .cindex "base64 encoding" "in string expansion"
10847 .cindex "&%base64%& expansion item"
10848 .cindex certificate "base64 of DER"
10849 This operator converts a string into one that is base64 encoded.
10850
10851 If the string is a single variable of type certificate,
10852 returns the base64 encoding of the DER form of the certificate.
10853
10854
10855 .vitem &*${base64d:*&<&'string'&>&*}*&
10856 .cindex "expansion" "base64 decoding"
10857 .cindex "base64 decoding" "in string expansion"
10858 .cindex "&%base64d%& expansion item"
10859 This operator converts a base64-encoded string into the un-coded form.
10860
10861
10862 .vitem &*${domain:*&<&'string'&>&*}*&
10863 .cindex "domain" "extraction"
10864 .cindex "expansion" "domain extraction"
10865 The string is interpreted as an RFC 2822 address and the domain is extracted
10866 from it. If the string does not parse successfully, the result is empty.
10867
10868
10869 .vitem &*${escape:*&<&'string'&>&*}*&
10870 .cindex "expansion" "escaping non-printing characters"
10871 .cindex "&%escape%& expansion item"
10872 If the string contains any non-printing characters, they are converted to
10873 escape sequences starting with a backslash. Whether characters with the most
10874 significant bit set (so-called &"8-bit characters"&) count as printing or not
10875 is controlled by the &%print_topbitchars%& option.
10876
10877 .vitem &*${escape8bit:*&<&'string'&>&*}*&
10878 .cindex "expansion" "escaping 8-bit characters"
10879 .cindex "&%escape8bit%& expansion item"
10880 If the string contains and characters with the most significant bit set,
10881 they are converted to escape sequences starting with a backslash.
10882 Backslashes and DEL characters are also converted.
10883
10884
10885 .vitem &*${eval:*&<&'string'&>&*}*&&~and&~&*${eval10:*&<&'string'&>&*}*&
10886 .cindex "expansion" "expression evaluation"
10887 .cindex "expansion" "arithmetic expression"
10888 .cindex "&%eval%& expansion item"
10889 These items supports simple arithmetic and bitwise logical operations in
10890 expansion strings. The string (after expansion) must be a conventional
10891 arithmetic expression, but it is limited to basic arithmetic operators, bitwise
10892 logical operators, and parentheses. All operations are carried out using
10893 integer arithmetic. The operator priorities are as follows (the same as in the
10894 C programming language):
10895 .table2 70pt 300pt
10896 .irow &'highest:'& "not (~), negate (-)"
10897 .irow ""   "multiply (*), divide (/), remainder (%)"
10898 .irow ""   "plus (+), minus (-)"
10899 .irow ""   "shift-left (<<), shift-right (>>)"
10900 .irow ""   "and (&&)"
10901 .irow ""   "xor (^)"
10902 .irow &'lowest:'&  "or (|)"
10903 .endtable
10904 Binary operators with the same priority are evaluated from left to right. White
10905 space is permitted before or after operators.
10906
10907 For &%eval%&, numbers may be decimal, octal (starting with &"0"&) or
10908 hexadecimal (starting with &"0x"&). For &%eval10%&, all numbers are taken as
10909 decimal, even if they start with a leading zero; hexadecimal numbers are not
10910 permitted. This can be useful when processing numbers extracted from dates or
10911 times, which often do have leading zeros.
10912
10913 A number may be followed by &"K"&, &"M"& or &"G"& to multiply it by 1024, 1024*1024
10914 or 1024*1024*1024,
10915 respectively. Negative numbers are supported. The result of the computation is
10916 a decimal representation of the answer (without &"K"&, &"M"& or &"G"&). For example:
10917
10918 .display
10919 &`${eval:1+1}            `&  yields 2
10920 &`${eval:1+2*3}          `&  yields 7
10921 &`${eval:(1+2)*3}        `&  yields 9
10922 &`${eval:2+42%5}         `&  yields 4
10923 &`${eval:0xc&amp;5}          `&  yields 4
10924 &`${eval:0xc|5}          `&  yields 13
10925 &`${eval:0xc^5}          `&  yields 9
10926 &`${eval:0xc>>1}         `&  yields 6
10927 &`${eval:0xc<<1}         `&  yields 24
10928 &`${eval:~255&amp;0x1234}    `&  yields 4608
10929 &`${eval:-(~255&amp;0x1234)} `&  yields -4608
10930 .endd
10931
10932 As a more realistic example, in an ACL you might have
10933 .code
10934 deny   condition =                    \
10935          ${if and {                   \
10936            {>{$rcpt_count}{10}}       \
10937            {                          \
10938            <                          \
10939              {$recipients_count}      \
10940              {${eval:$rcpt_count/2}}  \
10941            }                          \
10942          }{yes}{no}}
10943        message = Too many bad recipients
10944 .endd
10945 The condition is true if there have been more than 10 RCPT commands and
10946 fewer than half of them have resulted in a valid recipient.
10947
10948
10949 .vitem &*${expand:*&<&'string'&>&*}*&
10950 .cindex "expansion" "re-expansion of substring"
10951 The &%expand%& operator causes a string to be expanded for a second time. For
10952 example,
10953 .code
10954 ${expand:${lookup{$domain}dbm{/some/file}{$value}}}
10955 .endd
10956 first looks up a string in a file while expanding the operand for &%expand%&,
10957 and then re-expands what it has found.
10958
10959
10960 .vitem &*${from_utf8:*&<&'string'&>&*}*&
10961 .cindex "Unicode"
10962 .cindex "UTF-8" "conversion from"
10963 .cindex "expansion" "UTF-8 conversion"
10964 .cindex "&%from_utf8%& expansion item"
10965 The world is slowly moving towards Unicode, although there are no standards for
10966 email yet. However, other applications (including some databases) are starting
10967 to store data in Unicode, using UTF-8 encoding. This operator converts from a
10968 UTF-8 string to an ISO-8859-1 string. UTF-8 code values greater than 255 are
10969 converted to underscores. The input must be a valid UTF-8 string. If it is not,
10970 the result is an undefined sequence of bytes.
10971
10972 Unicode code points with values less than 256 are compatible with ASCII and
10973 ISO-8859-1 (also known as Latin-1).
10974 For example, character 169 is the copyright symbol in both cases, though the
10975 way it is encoded is different. In UTF-8, more than one byte is needed for
10976 characters with code values greater than 127, whereas ISO-8859-1 is a
10977 single-byte encoding (but thereby limited to 256 characters). This makes
10978 translation from UTF-8 to ISO-8859-1 straightforward.
10979
10980
10981 .vitem &*${hash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
10982 .cindex "hash function" "textual"
10983 .cindex "expansion" "textual hash"
10984 The &%hash%& operator is a simpler interface to the hashing function that can
10985 be used when the two parameters are fixed numbers (as opposed to strings that
10986 change when expanded). The effect is the same as
10987 .code
10988 ${hash{<n>}{<m>}{<string>}}
10989 .endd
10990 See the description of the general &%hash%& item above for details. The
10991 abbreviation &%h%& can be used when &%hash%& is used as an operator.
10992
10993
10994
10995 .vitem &*${hex2b64:*&<&'hexstring'&>&*}*&
10996 .cindex "base64 encoding" "conversion from hex"
10997 .cindex "expansion" "hex to base64"
10998 .cindex "&%hex2b64%& expansion item"
10999 This operator converts a hex string into one that is base64 encoded. This can
11000 be useful for processing the output of the various hashing functions.
11001
11002
11003
11004 .vitem &*${hexquote:*&<&'string'&>&*}*&
11005 .cindex "quoting" "hex-encoded unprintable characters"
11006 .cindex "&%hexquote%& expansion item"
11007 This operator converts non-printable characters in a string into a hex
11008 escape form. Byte values between 33 (!) and 126 (~) inclusive are left
11009 as is, and other byte values are converted to &`\xNN`&, for example, a
11010 byte value 127 is converted to &`\x7f`&.
11011
11012
11013 .vitem &*${ipv6denorm:*&<&'string'&>&*}*&
11014 .cindex "&%ipv6denorm%& expansion item"
11015 .cindex "IP address" normalisation
11016 This expands an IPv6 address to a full eight-element colon-separated set
11017 of hex digits including leading zeroes.
11018 A trailing ipv4-style dotted-decimal set is converted to hex.
11019 Pure IPv4 addresses are converted to IPv4-mapped IPv6.
11020
11021 .vitem &*${ipv6norm:*&<&'string'&>&*}*&
11022 .cindex "&%ipv6norm%& expansion item"
11023 .cindex "IP address" normalisation
11024 .cindex "IP address" "canonical form"
11025 This converts an IPv6 address to canonical form.
11026 Leading zeroes of groups are omitted, and the longest
11027 set of zero-valued groups is replaced with a double colon.
11028 A trailing ipv4-style dotted-decimal set is converted to hex.
11029 Pure IPv4 addresses are converted to IPv4-mapped IPv6.
11030
11031
11032 .vitem &*${lc:*&<&'string'&>&*}*&
11033 .cindex "case forcing in strings"
11034 .cindex "string" "case forcing"
11035 .cindex "lower casing"
11036 .cindex "expansion" "case forcing"
11037 .cindex "&%lc%& expansion item"
11038 This forces the letters in the string into lower-case, for example:
11039 .code
11040 ${lc:$local_part}
11041 .endd
11042 Case is defined per the system C locale.
11043
11044 .vitem &*${length_*&<&'number'&>&*:*&<&'string'&>&*}*&
11045 .cindex "expansion" "string truncation"
11046 .cindex "&%length%& expansion item"
11047 The &%length%& operator is a simpler interface to the &%length%& function that
11048 can be used when the parameter is a fixed number (as opposed to a string that
11049 changes when expanded). The effect is the same as
11050 .code
11051 ${length{<number>}{<string>}}
11052 .endd
11053 See the description of the general &%length%& item above for details. Note that
11054 &%length%& is not the same as &%strlen%&. The abbreviation &%l%& can be used
11055 when &%length%& is used as an operator.
11056 All measurement is done in bytes and is not UTF-8 aware.
11057
11058
11059 .vitem &*${listcount:*&<&'string'&>&*}*&
11060 .cindex "expansion" "list item count"
11061 .cindex "list" "item count"
11062 .cindex "list" "count of items"
11063 .cindex "&%listcount%& expansion item"
11064 The string is interpreted as a list and the number of items is returned.
11065
11066
11067 .vitem &*${listnamed:*&<&'name'&>&*}*&&~and&~&*${listnamed_*&<&'type'&>&*:*&<&'name'&>&*}*&
11068 .cindex "expansion" "named list"
11069 .cindex "&%listnamed%& expansion item"
11070 The name is interpreted as a named list and the content of the list is returned,
11071 expanding any referenced lists, re-quoting as needed for colon-separation.
11072 If the optional type is given it must be one of "a", "d", "h" or "l"
11073 and selects address-, domain-, host- or localpart- lists to search among respectively.
11074 Otherwise all types are searched in an undefined order and the first
11075 matching list is returned.
11076
11077
11078 .vitem &*${local_part:*&<&'string'&>&*}*&
11079 .cindex "expansion" "local part extraction"
11080 .cindex "&%local_part%& expansion item"
11081 The string is interpreted as an RFC 2822 address and the local part is
11082 extracted from it. If the string does not parse successfully, the result is
11083 empty.
11084 The parsing correctly handles SMTPUTF8 Unicode in the string.
11085
11086
11087 .vitem &*${mask:*&<&'IP&~address'&>&*/*&<&'bit&~count'&>&*}*&
11088 .cindex "masked IP address"
11089 .cindex "IP address" "masking"
11090 .cindex "CIDR notation"
11091 .cindex "expansion" "IP address masking"
11092 .cindex "&%mask%& expansion item"
11093 If the form of the string to be operated on is not an IP address followed by a
11094 slash and an integer (that is, a network address in CIDR notation), the
11095 expansion fails. Otherwise, this operator converts the IP address to binary,
11096 masks off the least significant bits according to the bit count, and converts
11097 the result back to text, with mask appended. For example,
11098 .code
11099 ${mask:10.111.131.206/28}
11100 .endd
11101 returns the string &"10.111.131.192/28"&. Since this operation is expected to
11102 be mostly used for looking up masked addresses in files, the result for an IPv6
11103 address uses dots to separate components instead of colons, because colon
11104 terminates a key string in lsearch files. So, for example,
11105 .code
11106 ${mask:3ffe:ffff:836f:0a00:000a:0800:200a:c031/99}
11107 .endd
11108 returns the string
11109 .code
11110 3ffe.ffff.836f.0a00.000a.0800.2000.0000/99
11111 .endd
11112 Letters in IPv6 addresses are always output in lower case.
11113
11114
11115 .vitem &*${md5:*&<&'string'&>&*}*&
11116 .cindex "MD5 hash"
11117 .cindex "expansion" "MD5 hash"
11118 .cindex certificate fingerprint
11119 .cindex "&%md5%& expansion item"
11120 The &%md5%& operator computes the MD5 hash value of the string, and returns it
11121 as a 32-digit hexadecimal number, in which any letters are in lower case.
11122
11123 If the string is a single variable of type certificate,
11124 returns the MD5 hash fingerprint of the certificate.
11125
11126
11127 .vitem &*${nhash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
11128 .cindex "expansion" "numeric hash"
11129 .cindex "hash function" "numeric"
11130 The &%nhash%& operator is a simpler interface to the numeric hashing function
11131 that can be used when the two parameters are fixed numbers (as opposed to
11132 strings that change when expanded). The effect is the same as
11133 .code
11134 ${nhash{<n>}{<m>}{<string>}}
11135 .endd
11136 See the description of the general &%nhash%& item above for details.
11137
11138
11139 .vitem &*${quote:*&<&'string'&>&*}*&
11140 .cindex "quoting" "in string expansions"
11141 .cindex "expansion" "quoting"
11142 .cindex "&%quote%& expansion item"
11143 The &%quote%& operator puts its argument into double quotes if it
11144 is an empty string or
11145 contains anything other than letters, digits, underscores, dots, and hyphens.
11146 Any occurrences of double quotes and backslashes are escaped with a backslash.
11147 Newlines and carriage returns are converted to &`\n`& and &`\r`&,
11148 respectively For example,
11149 .code
11150 ${quote:ab"*"cd}
11151 .endd
11152 becomes
11153 .code
11154 "ab\"*\"cd"
11155 .endd
11156 The place where this is useful is when the argument is a substitution from a
11157 variable or a message header.
11158
11159 .vitem &*${quote_local_part:*&<&'string'&>&*}*&
11160 .cindex "&%quote_local_part%& expansion item"
11161 This operator is like &%quote%&, except that it quotes the string only if
11162 required to do so by the rules of RFC 2822 for quoting local parts. For
11163 example, a plus sign would not cause quoting (but it would for &%quote%&).
11164 If you are creating a new email address from the contents of &$local_part$&
11165 (or any other unknown data), you should always use this operator.
11166
11167 This quoting determination is not SMTPUTF8-aware, thus quoting non-ASCII data
11168 will likely use the quoting form.
11169 Thus &'${quote_local_part:フィル}'& will always become &'"フィル"'&.
11170
11171
11172 .vitem &*${quote_*&<&'lookup-type'&>&*:*&<&'string'&>&*}*&
11173 .cindex "quoting" "lookup-specific"
11174 This operator applies lookup-specific quoting rules to the string. Each
11175 query-style lookup type has its own quoting rules which are described with
11176 the lookups in chapter &<<CHAPfdlookup>>&. For example,
11177 .code
11178 ${quote_ldap:two * two}
11179 .endd
11180 returns
11181 .code
11182 two%20%5C2A%20two
11183 .endd
11184 For single-key lookup types, no quoting is ever necessary and this operator
11185 yields an unchanged string.
11186
11187
11188 .vitem &*${randint:*&<&'n'&>&*}*&
11189 .cindex "random number"
11190 This operator returns a somewhat random number which is less than the
11191 supplied number and is at least 0.  The quality of this randomness depends
11192 on how Exim was built; the values are not suitable for keying material.
11193 If Exim is linked against OpenSSL then RAND_pseudo_bytes() is used.
11194 If Exim is linked against GnuTLS then gnutls_rnd(GNUTLS_RND_NONCE) is used,
11195 for versions of GnuTLS with that function.
11196 Otherwise, the implementation may be arc4random(), random() seeded by
11197 srandomdev() or srandom(), or a custom implementation even weaker than
11198 random().
11199
11200
11201 .vitem &*${reverse_ip:*&<&'ipaddr'&>&*}*&
11202 .cindex "expansion" "IP address"
11203 This operator reverses an IP address; for IPv4 addresses, the result is in
11204 dotted-quad decimal form, while for IPv6 addresses the result is in
11205 dotted-nibble hexadecimal form.  In both cases, this is the "natural" form
11206 for DNS.  For example,
11207 .code
11208 ${reverse_ip:192.0.2.4}
11209 ${reverse_ip:2001:0db8:c42:9:1:abcd:192.0.2.127}
11210 .endd
11211 returns
11212 .code
11213 4.2.0.192
11214 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
11215 .endd
11216
11217
11218 .vitem &*${rfc2047:*&<&'string'&>&*}*&
11219 .cindex "expansion" "RFC 2047"
11220 .cindex "RFC 2047" "expansion operator"
11221 .cindex "&%rfc2047%& expansion item"
11222 This operator encodes text according to the rules of RFC 2047. This is an
11223 encoding that is used in header lines to encode non-ASCII characters. It is
11224 assumed that the input string is in the encoding specified by the
11225 &%headers_charset%& option, which gets its default at build time. If the string
11226 contains only characters in the range 33&--126, and no instances of the
11227 characters
11228 .code
11229 ? = ( ) < > @ , ; : \ " . [ ] _
11230 .endd
11231 it is not modified. Otherwise, the result is the RFC 2047 encoding of the
11232 string, using as many &"encoded words"& as necessary to encode all the
11233 characters.
11234
11235
11236 .vitem &*${rfc2047d:*&<&'string'&>&*}*&
11237 .cindex "expansion" "RFC 2047"
11238 .cindex "RFC 2047" "decoding"
11239 .cindex "&%rfc2047d%& expansion item"
11240 This operator decodes strings that are encoded as per RFC 2047. Binary zero
11241 bytes are replaced by question marks. Characters are converted into the
11242 character set defined by &%headers_charset%&. Overlong RFC 2047 &"words"& are
11243 not recognized unless &%check_rfc2047_length%& is set false.
11244
11245 &*Note*&: If you use &%$header%&_&'xxx'&&*:*& (or &%$h%&_&'xxx'&&*:*&) to
11246 access a header line, RFC 2047 decoding is done automatically. You do not need
11247 to use this operator as well.
11248
11249
11250
11251 .vitem &*${rxquote:*&<&'string'&>&*}*&
11252 .cindex "quoting" "in regular expressions"
11253 .cindex "regular expressions" "quoting"
11254 .cindex "&%rxquote%& expansion item"
11255 The &%rxquote%& operator inserts a backslash before any non-alphanumeric
11256 characters in its argument. This is useful when substituting the values of
11257 variables or headers inside regular expressions.
11258
11259
11260 .vitem &*${sha1:*&<&'string'&>&*}*&
11261 .cindex "SHA-1 hash"
11262 .cindex "expansion" "SHA-1 hashing"
11263 .cindex certificate fingerprint
11264 .cindex "&%sha1%& expansion item"
11265 The &%sha1%& operator computes the SHA-1 hash value of the string, and returns
11266 it as a 40-digit hexadecimal number, in which any letters are in upper case.
11267
11268 If the string is a single variable of type certificate,
11269 returns the SHA-1 hash fingerprint of the certificate.
11270
11271
11272 .vitem &*${sha256:*&<&'string'&>&*}*& &&&
11273        &*${sha2:*&<&'string'&>&*}*& &&&
11274        &*${sha2_<n>:*&<&'string'&>&*}*&
11275 .cindex "SHA-256 hash"
11276 .cindex "SHA-2 hash"
11277 .cindex certificate fingerprint
11278 .cindex "expansion" "SHA-256 hashing"
11279 .cindex "&%sha256%& expansion item"
11280 .cindex "&%sha2%& expansion item"
11281 The &%sha256%& operator computes the SHA-256 hash value of the string
11282 and returns
11283 it as a 64-digit hexadecimal number, in which any letters are in upper case.
11284
11285 If the string is a single variable of type certificate,
11286 returns the SHA-256 hash fingerprint of the certificate.
11287
11288 The operator can also be spelled &%sha2%& and does the same as &%sha256%&
11289 (except for certificates, which are not supported).
11290 Finally, if an underbar
11291 and a number is appended it specifies the output length, selecting a
11292 member of the SHA-2 family of hash functions.
11293 Values of 256, 384 and 512 are accepted, with 256 being the default.
11294
11295
11296 .vitem &*${sha3:*&<&'string'&>&*}*& &&&
11297        &*${sha3_<n>:*&<&'string'&>&*}*&
11298 .cindex "SHA3 hash"
11299 .cindex "expansion" "SHA3 hashing"
11300 .cindex "&%sha3%& expansion item"
11301 The &%sha3%& operator computes the SHA3-256 hash value of the string
11302 and returns
11303 it as a 64-digit hexadecimal number, in which any letters are in upper case.
11304
11305 If a number is appended, separated by an underbar, it specifies
11306 the output length.  Values of 224, 256, 384 and 512 are accepted;
11307 with 256 being the default.
11308
11309 The &%sha3%& expansion item is only supported if Exim has been
11310 compiled with GnuTLS 3.5.0 or later,
11311 or OpenSSL 1.1.1 or later.
11312 The macro "_CRYPTO_HASH_SHA3" will be defined if it is supported.
11313
11314
11315 .vitem &*${stat:*&<&'string'&>&*}*&
11316 .cindex "expansion" "statting a file"
11317 .cindex "file" "extracting characteristics"
11318 .cindex "&%stat%& expansion item"
11319 The string, after expansion, must be a file path. A call to the &[stat()]&
11320 function is made for this path. If &[stat()]& fails, an error occurs and the
11321 expansion fails. If it succeeds, the data from the stat replaces the item, as a
11322 series of <&'name'&>=<&'value'&> pairs, where the values are all numerical,
11323 except for the value of &"smode"&. The names are: &"mode"& (giving the mode as
11324 a 4-digit octal number), &"smode"& (giving the mode in symbolic format as a
11325 10-character string, as for the &'ls'& command), &"inode"&, &"device"&,
11326 &"links"&, &"uid"&, &"gid"&, &"size"&, &"atime"&, &"mtime"&, and &"ctime"&. You
11327 can extract individual fields using the &%extract%& expansion item.
11328
11329 The use of the &%stat%& expansion in users' filter files can be locked out by
11330 the system administrator. &*Warning*&: The file size may be incorrect on 32-bit
11331 systems for files larger than 2GB.
11332
11333 .vitem &*${str2b64:*&<&'string'&>&*}*&
11334 .cindex "&%str2b64%& expansion item"
11335 Now deprecated, a synonym for the &%base64%& expansion operator.
11336
11337
11338
11339 .vitem &*${strlen:*&<&'string'&>&*}*&
11340 .cindex "expansion" "string length"
11341 .cindex "string" "length in expansion"
11342 .cindex "&%strlen%& expansion item"
11343 The item is replace by the length of the expanded string, expressed as a
11344 decimal number. &*Note*&: Do not confuse &%strlen%& with &%length%&.
11345 All measurement is done in bytes and is not UTF-8 aware.
11346
11347
11348 .vitem &*${substr_*&<&'start'&>&*_*&<&'length'&>&*:*&<&'string'&>&*}*&
11349 .cindex "&%substr%& expansion item"
11350 .cindex "substring extraction"
11351 .cindex "expansion" "substring expansion"
11352 The &%substr%& operator is a simpler interface to the &%substr%& function that
11353 can be used when the two parameters are fixed numbers (as opposed to strings
11354 that change when expanded). The effect is the same as
11355 .code
11356 ${substr{<start>}{<length>}{<string>}}
11357 .endd
11358 See the description of the general &%substr%& item above for details. The
11359 abbreviation &%s%& can be used when &%substr%& is used as an operator.
11360 All measurement is done in bytes and is not UTF-8 aware.
11361
11362 .vitem &*${time_eval:*&<&'string'&>&*}*&
11363 .cindex "&%time_eval%& expansion item"
11364 .cindex "time interval" "decoding"
11365 This item converts an Exim time interval such as &`2d4h5m`& into a number of
11366 seconds.
11367
11368 .vitem &*${time_interval:*&<&'string'&>&*}*&
11369 .cindex "&%time_interval%& expansion item"
11370 .cindex "time interval" "formatting"
11371 The argument (after sub-expansion) must be a sequence of decimal digits that
11372 represents an interval of time as a number of seconds. It is converted into a
11373 number of larger units and output in Exim's normal time format, for example,
11374 &`1w3d4h2m6s`&.
11375
11376 .vitem &*${uc:*&<&'string'&>&*}*&
11377 .cindex "case forcing in strings"
11378 .cindex "string" "case forcing"
11379 .cindex "upper casing"
11380 .cindex "expansion" "case forcing"
11381 .cindex "&%uc%& expansion item"
11382 This forces the letters in the string into upper-case.
11383 Case is defined per the system C locale.
11384
11385 .vitem &*${utf8clean:*&<&'string'&>&*}*&
11386 .cindex "correction of invalid utf-8 sequences in strings"
11387 .cindex "utf-8" "utf-8 sequences"
11388 .cindex "incorrect utf-8"
11389 .cindex "expansion" "utf-8 forcing"
11390 .cindex "&%utf8clean%& expansion item"
11391 This replaces any invalid utf-8 sequence in the string by the character &`?`&.
11392 In versions of Exim before 4.92, this did not correctly do so for a truncated
11393 final codepoint's encoding, and the character would be silently dropped.
11394 If you must handle detection of this scenario across both sets of Exim behavior,
11395 the complexity will depend upon the task.
11396 For instance, to detect if the first character is multibyte and a 1-byte
11397 extraction can be successfully used as a path component (as is common for
11398 dividing up delivery folders), you might use:
11399 .code
11400 condition = ${if inlist{${utf8clean:${length_1:$local_part}}}{:?}{yes}{no}}
11401 .endd
11402 (which will false-positive if the first character of the local part is a
11403 literal question mark).
11404
11405 .vitem "&*${utf8_domain_to_alabel:*&<&'string'&>&*}*&" &&&
11406        "&*${utf8_domain_from_alabel:*&<&'string'&>&*}*&" &&&
11407        "&*${utf8_localpart_to_alabel:*&<&'string'&>&*}*&" &&&
11408        "&*${utf8_localpart_from_alabel:*&<&'string'&>&*}*&"
11409 .cindex expansion UTF-8
11410 .cindex UTF-8 expansion
11411 .cindex EAI
11412 .cindex internationalisation
11413 .cindex "&%utf8_domain_to_alabel%& expansion item"
11414 .cindex "&%utf8_domain_from_alabel%& expansion item"
11415 .cindex "&%utf8_localpart_to_alabel%& expansion item"
11416 .cindex "&%utf8_localpart_from_alabel%& expansion item"
11417 These convert EAI mail name components between UTF-8 and a-label forms.
11418 For information on internationalisation support see &<<SECTi18nMTA>>&.
11419 .endlist
11420
11421
11422
11423
11424
11425
11426 .section "Expansion conditions" "SECTexpcond"
11427 .scindex IIDexpcond "expansion" "conditions"
11428 The following conditions are available for testing by the &%${if%& construct
11429 while expanding strings:
11430
11431 .vlist
11432 .vitem &*!*&<&'condition'&>
11433 .cindex "expansion" "negating a condition"
11434 .cindex "negation" "in expansion condition"
11435 Preceding any condition with an exclamation mark negates the result of the
11436 condition.
11437
11438 .vitem <&'symbolic&~operator'&>&~&*{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11439 .cindex "numeric comparison"
11440 .cindex "expansion" "numeric comparison"
11441 There are a number of symbolic operators for doing numeric comparisons. They
11442 are:
11443 .display
11444 &`=   `&   equal
11445 &`==  `&   equal
11446 &`>   `&   greater
11447 &`>=  `&   greater or equal
11448 &`<   `&   less
11449 &`<=  `&   less or equal
11450 .endd
11451 For example:
11452 .code
11453 ${if >{$message_size}{10M} ...
11454 .endd
11455 Note that the general negation operator provides for inequality testing. The
11456 two strings must take the form of optionally signed decimal integers,
11457 optionally followed by one of the letters &"K"&, &"M"& or &"G"& (in either upper or
11458 lower case), signifying multiplication by 1024, 1024*1024 or 1024*1024*1024, respectively.
11459 As a special case, the numerical value of an empty string is taken as
11460 zero.
11461
11462 In all cases, a relative comparator OP is testing if <&'string1'&> OP
11463 <&'string2'&>; the above example is checking if &$message_size$& is larger than
11464 10M, not if 10M is larger than &$message_size$&.
11465
11466
11467 .vitem &*acl&~{{*&<&'name'&>&*}{*&<&'arg1'&>&*}&&&
11468         {*&<&'arg2'&>&*}...}*&
11469 .cindex "expansion" "calling an acl"
11470 .cindex "&%acl%&" "expansion condition"
11471 The name and zero to nine argument strings are first expanded separately.  The expanded
11472 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
11473 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
11474 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
11475 and may use the variables; if another acl expansion is used the values
11476 are restored after it returns.  If the ACL sets
11477 a value using a "message =" modifier the variable $value becomes
11478 the result of the expansion, otherwise it is empty.
11479 If the ACL returns accept the condition is true; if deny, false.
11480 If the ACL returns defer the result is a forced-fail.
11481
11482 .vitem &*bool&~{*&<&'string'&>&*}*&
11483 .cindex "expansion" "boolean parsing"
11484 .cindex "&%bool%& expansion condition"
11485 This condition turns a string holding a true or false representation into
11486 a boolean state.  It parses &"true"&, &"false"&, &"yes"& and &"no"&
11487 (case-insensitively); also integer numbers map to true if non-zero,
11488 false if zero.
11489 An empty string is treated as false.
11490 Leading and trailing whitespace is ignored;
11491 thus a string consisting only of whitespace is false.
11492 All other string values will result in expansion failure.
11493
11494 When combined with ACL variables, this expansion condition will let you
11495 make decisions in one place and act on those decisions in another place.
11496 For example:
11497 .code
11498 ${if bool{$acl_m_privileged_sender} ...
11499 .endd
11500
11501
11502 .vitem &*bool_lax&~{*&<&'string'&>&*}*&
11503 .cindex "expansion" "boolean parsing"
11504 .cindex "&%bool_lax%& expansion condition"
11505 Like &%bool%&, this condition turns a string into a boolean state.  But
11506 where &%bool%& accepts a strict set of strings, &%bool_lax%& uses the same
11507 loose definition that the Router &%condition%& option uses.  The empty string
11508 and the values &"false"&, &"no"& and &"0"& map to false, all others map to
11509 true.  Leading and trailing whitespace is ignored.
11510
11511 Note that where &"bool{00}"& is false, &"bool_lax{00}"& is true.
11512
11513 .vitem &*crypteq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11514 .cindex "expansion" "encrypted comparison"
11515 .cindex "encrypted strings, comparing"
11516 .cindex "&%crypteq%& expansion condition"
11517 This condition is included in the Exim binary if it is built to support any
11518 authentication mechanisms (see chapter &<<CHAPSMTPAUTH>>&). Otherwise, it is
11519 necessary to define SUPPORT_CRYPTEQ in &_Local/Makefile_& to get &%crypteq%&
11520 included in the binary.
11521
11522 The &%crypteq%& condition has two arguments. The first is encrypted and
11523 compared against the second, which is already encrypted. The second string may
11524 be in the LDAP form for storing encrypted strings, which starts with the
11525 encryption type in curly brackets, followed by the data. If the second string
11526 does not begin with &"{"& it is assumed to be encrypted with &[crypt()]& or
11527 &[crypt16()]& (see below), since such strings cannot begin with &"{"&.
11528 Typically this will be a field from a password file. An example of an encrypted
11529 string in LDAP form is:
11530 .code
11531 {md5}CY9rzUYh03PK3k6DJie09g==
11532 .endd
11533 If such a string appears directly in an expansion, the curly brackets have to
11534 be quoted, because they are part of the expansion syntax. For example:
11535 .code
11536 ${if crypteq {test}{\{md5\}CY9rzUYh03PK3k6DJie09g==}{yes}{no}}
11537 .endd
11538 The following encryption types (whose names are matched case-independently) are
11539 supported:
11540
11541 .ilist
11542 .cindex "MD5 hash"
11543 .cindex "base64 encoding" "in encrypted password"
11544 &%{md5}%& computes the MD5 digest of the first string, and expresses this as
11545 printable characters to compare with the remainder of the second string. If the
11546 length of the comparison string is 24, Exim assumes that it is base64 encoded
11547 (as in the above example). If the length is 32, Exim assumes that it is a
11548 hexadecimal encoding of the MD5 digest. If the length not 24 or 32, the
11549 comparison fails.
11550
11551 .next
11552 .cindex "SHA-1 hash"
11553 &%{sha1}%& computes the SHA-1 digest of the first string, and expresses this as
11554 printable characters to compare with the remainder of the second string. If the
11555 length of the comparison string is 28, Exim assumes that it is base64 encoded.
11556 If the length is 40, Exim assumes that it is a hexadecimal encoding of the
11557 SHA-1 digest. If the length is not 28 or 40, the comparison fails.
11558
11559 .next
11560 .cindex "&[crypt()]&"
11561 &%{crypt}%& calls the &[crypt()]& function, which traditionally used to use
11562 only the first eight characters of the password. However, in modern operating
11563 systems this is no longer true, and in many cases the entire password is used,
11564 whatever its length.
11565
11566 .next
11567 .cindex "&[crypt16()]&"
11568 &%{crypt16}%& calls the &[crypt16()]& function, which was originally created to
11569 use up to 16 characters of the password in some operating systems. Again, in
11570 modern operating systems, more characters may be used.
11571 .endlist
11572 Exim has its own version of &[crypt16()]&, which is just a double call to
11573 &[crypt()]&. For operating systems that have their own version, setting
11574 HAVE_CRYPT16 in &_Local/Makefile_& when building Exim causes it to use the
11575 operating system version instead of its own. This option is set by default in
11576 the OS-dependent &_Makefile_& for those operating systems that are known to
11577 support &[crypt16()]&.
11578
11579 Some years after Exim's &[crypt16()]& was implemented, a user discovered that
11580 it was not using the same algorithm as some operating systems' versions. It
11581 turns out that as well as &[crypt16()]& there is a function called
11582 &[bigcrypt()]& in some operating systems. This may or may not use the same
11583 algorithm, and both of them may be different to Exim's built-in &[crypt16()]&.
11584
11585 However, since there is now a move away from the traditional &[crypt()]&
11586 functions towards using SHA1 and other algorithms, tidying up this area of
11587 Exim is seen as very low priority.
11588
11589 If you do not put a encryption type (in curly brackets) in a &%crypteq%&
11590 comparison, the default is usually either &`{crypt}`& or &`{crypt16}`&, as
11591 determined by the setting of DEFAULT_CRYPT in &_Local/Makefile_&. The default
11592 default is &`{crypt}`&. Whatever the default, you can always use either
11593 function by specifying it explicitly in curly brackets.
11594
11595 .vitem &*def:*&<&'variable&~name'&>
11596 .cindex "expansion" "checking for empty variable"
11597 .cindex "&%def%& expansion condition"
11598 The &%def%& condition must be followed by the name of one of the expansion
11599 variables defined in section &<<SECTexpvar>>&. The condition is true if the
11600 variable does not contain the empty string. For example:
11601 .code
11602 ${if def:sender_ident {from $sender_ident}}
11603 .endd
11604 Note that the variable name is given without a leading &%$%& character. If the
11605 variable does not exist, the expansion fails.
11606
11607 .vitem "&*def:header_*&<&'header&~name'&>&*:*&&~&~or&~&&&
11608         &~&*def:h_*&<&'header&~name'&>&*:*&"
11609 .cindex "expansion" "checking header line existence"
11610 This condition is true if a message is being processed and the named header
11611 exists in the message. For example,
11612 .code
11613 ${if def:header_reply-to:{$h_reply-to:}{$h_from:}}
11614 .endd
11615 &*Note*&: No &%$%& appears before &%header_%& or &%h_%& in the condition, and
11616 the header name must be terminated by a colon if white space does not follow.
11617
11618 .vitem &*eq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11619        &*eqi&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11620 .cindex "string" "comparison"
11621 .cindex "expansion" "string comparison"
11622 .cindex "&%eq%& expansion condition"
11623 .cindex "&%eqi%& expansion condition"
11624 The two substrings are first expanded. The condition is true if the two
11625 resulting strings are identical. For &%eq%& the comparison includes the case of
11626 letters, whereas for &%eqi%& the comparison is case-independent, where
11627 case is defined per the system C locale.
11628
11629 .vitem &*exists&~{*&<&'file&~name'&>&*}*&
11630 .cindex "expansion" "file existence test"
11631 .cindex "file" "existence test"
11632 .cindex "&%exists%&, expansion condition"
11633 The substring is first expanded and then interpreted as an absolute path. The
11634 condition is true if the named file (or directory) exists. The existence test
11635 is done by calling the &[stat()]& function. The use of the &%exists%& test in
11636 users' filter files may be locked out by the system administrator.
11637
11638 .vitem &*first_delivery*&
11639 .cindex "delivery" "first"
11640 .cindex "first delivery"
11641 .cindex "expansion" "first delivery test"
11642 .cindex "&%first_delivery%& expansion condition"
11643 This condition, which has no data, is true during a message's first delivery
11644 attempt. It is false during any subsequent delivery attempts.
11645
11646
11647 .vitem "&*forall{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&" &&&
11648        "&*forany{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&"
11649 .cindex "list" "iterative conditions"
11650 .cindex "expansion" "&*forall*& condition"
11651 .cindex "expansion" "&*forany*& condition"
11652 .vindex "&$item$&"
11653 These conditions iterate over a list. The first argument is expanded to form
11654 the list. By default, the list separator is a colon, but it can be changed by
11655 the normal method (&<<SECTlistsepchange>>&).
11656 The second argument is interpreted as a condition that is to
11657 be applied to each item in the list in turn. During the interpretation of the
11658 condition, the current list item is placed in a variable called &$item$&.
11659 .ilist
11660 For &*forany*&, interpretation stops if the condition is true for any item, and
11661 the result of the whole condition is true. If the condition is false for all
11662 items in the list, the overall condition is false.
11663 .next
11664 For &*forall*&, interpretation stops if the condition is false for any item,
11665 and the result of the whole condition is false. If the condition is true for
11666 all items in the list, the overall condition is true.
11667 .endlist
11668 Note that negation of &*forany*& means that the condition must be false for all
11669 items for the overall condition to succeed, and negation of &*forall*& means
11670 that the condition must be false for at least one item. In this example, the
11671 list separator is changed to a comma:
11672 .code
11673 ${if forany{<, $recipients}{match{$item}{^user3@}}{yes}{no}}
11674 .endd
11675 The value of &$item$& is saved and restored while &%forany%& or &%forall%& is
11676 being processed, to enable these expansion items to be nested.
11677
11678 To scan a named list, expand it with the &*listnamed*& operator.
11679
11680 .vitem "&*forall_json{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&" &&&
11681        "&*forany_json{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&" &&&
11682        "&*forall_jsons{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&" &&&
11683        "&*forany_jsons{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&"
11684 .cindex JSON "iterative conditions"
11685 .cindex JSON expansions
11686 .cindex expansion "&*forall_json*& condition"
11687 .cindex expansion "&*forany_json*& condition"
11688 .cindex expansion "&*forall_jsons*& condition"
11689 .cindex expansion "&*forany_jsons*& condition"
11690 As for the above, except that the first argument must, after expansion,
11691 be a JSON array.
11692 The array separator is not changeable.
11693 For the &"jsons"& variants the elements are expected to be JSON strings
11694 and have their quotes removed before the evaluation of the condition.
11695
11696
11697
11698 .vitem &*ge&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11699        &*gei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11700 .cindex "string" "comparison"
11701 .cindex "expansion" "string comparison"
11702 .cindex "&%ge%& expansion condition"
11703 .cindex "&%gei%& expansion condition"
11704 The two substrings are first expanded. The condition is true if the first
11705 string is lexically greater than or equal to the second string. For &%ge%& the
11706 comparison includes the case of letters, whereas for &%gei%& the comparison is
11707 case-independent.
11708 Case and collation order are defined per the system C locale.
11709
11710 .vitem &*gt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11711        &*gti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11712 .cindex "string" "comparison"
11713 .cindex "expansion" "string comparison"
11714 .cindex "&%gt%& expansion condition"
11715 .cindex "&%gti%& expansion condition"
11716 The two substrings are first expanded. The condition is true if the first
11717 string is lexically greater than the second string. For &%gt%& the comparison
11718 includes the case of letters, whereas for &%gti%& the comparison is
11719 case-independent.
11720 Case and collation order are defined per the system C locale.
11721
11722
11723 .new
11724 .vitem &*inbound_srs&~{*&<&'local&~part'&>&*}{*&<&'secret'&>&*}*&
11725 SRS decode.  See SECT &<<SECTSRS>>& for details.
11726 .wen
11727
11728
11729 .vitem &*inlist&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11730        &*inlisti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11731 .cindex "string" "comparison"
11732 .cindex "list" "iterative conditions"
11733 Both strings are expanded; the second string is treated as a list of simple
11734 strings; if the first string is a member of the second, then the condition
11735 is true.
11736 For the case-independent &%inlisti%& condition, case is defined per the system C locale.
11737
11738 These are simpler to use versions of the more powerful &*forany*& condition.
11739 Examples, and the &*forany*& equivalents:
11740 .code
11741 ${if inlist{needle}{foo:needle:bar}}
11742   ${if forany{foo:needle:bar}{eq{$item}{needle}}}
11743 ${if inlisti{Needle}{fOo:NeeDLE:bAr}}
11744   ${if forany{fOo:NeeDLE:bAr}{eqi{$item}{Needle}}}
11745 .endd
11746
11747 .vitem &*isip&~{*&<&'string'&>&*}*&  &&&
11748        &*isip4&~{*&<&'string'&>&*}*& &&&
11749        &*isip6&~{*&<&'string'&>&*}*&
11750 .cindex "IP address" "testing string format"
11751 .cindex "string" "testing for IP address"
11752 .cindex "&%isip%& expansion condition"
11753 .cindex "&%isip4%& expansion condition"
11754 .cindex "&%isip6%& expansion condition"
11755 The substring is first expanded, and then tested to see if it has the form of
11756 an IP address. Both IPv4 and IPv6 addresses are valid for &%isip%&, whereas
11757 &%isip4%& and &%isip6%& test specifically for IPv4 or IPv6 addresses.
11758
11759 For an IPv4 address, the test is for four dot-separated components, each of
11760 which consists of from one to three digits. For an IPv6 address, up to eight
11761 colon-separated components are permitted, each containing from one to four
11762 hexadecimal digits. There may be fewer than eight components if an empty
11763 component (adjacent colons) is present. Only one empty component is permitted.
11764
11765 &*Note*&: The checks used to be just on the form of the address; actual numerical
11766 values were not considered. Thus, for example, 999.999.999.999 passed the IPv4
11767 check.
11768 This is no longer the case.
11769
11770 The main use of these tests is to distinguish between IP addresses and
11771 host names, or between IPv4 and IPv6 addresses. For example, you could use
11772 .code
11773 ${if isip4{$sender_host_address}...
11774 .endd
11775 to test which IP version an incoming SMTP connection is using.
11776
11777 .vitem &*ldapauth&~{*&<&'ldap&~query'&>&*}*&
11778 .cindex "LDAP" "use for authentication"
11779 .cindex "expansion" "LDAP authentication test"
11780 .cindex "&%ldapauth%& expansion condition"
11781 This condition supports user authentication using LDAP. See section
11782 &<<SECTldap>>& for details of how to use LDAP in lookups and the syntax of
11783 queries. For this use, the query must contain a user name and password. The
11784 query itself is not used, and can be empty. The condition is true if the
11785 password is not empty, and the user name and password are accepted by the LDAP
11786 server. An empty password is rejected without calling LDAP because LDAP binds
11787 with an empty password are considered anonymous regardless of the username, and
11788 will succeed in most configurations. See chapter &<<CHAPSMTPAUTH>>& for details
11789 of SMTP authentication, and chapter &<<CHAPplaintext>>& for an example of how
11790 this can be used.
11791
11792
11793 .vitem &*le&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11794        &*lei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11795 .cindex "string" "comparison"
11796 .cindex "expansion" "string comparison"
11797 .cindex "&%le%& expansion condition"
11798 .cindex "&%lei%& expansion condition"
11799 The two substrings are first expanded. The condition is true if the first
11800 string is lexically less than or equal to the second string. For &%le%& the
11801 comparison includes the case of letters, whereas for &%lei%& the comparison is
11802 case-independent.
11803 Case and collation order are defined per the system C locale.
11804
11805 .vitem &*lt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11806        &*lti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11807 .cindex "string" "comparison"
11808 .cindex "expansion" "string comparison"
11809 .cindex "&%lt%& expansion condition"
11810 .cindex "&%lti%& expansion condition"
11811 The two substrings are first expanded. The condition is true if the first
11812 string is lexically less than the second string. For &%lt%& the comparison
11813 includes the case of letters, whereas for &%lti%& the comparison is
11814 case-independent.
11815 Case and collation order are defined per the system C locale.
11816
11817
11818 .vitem &*match&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11819 .cindex "expansion" "regular expression comparison"
11820 .cindex "regular expressions" "match in expanded string"
11821 .cindex "&%match%& expansion condition"
11822 The two substrings are first expanded. The second is then treated as a regular
11823 expression and applied to the first. Because of the pre-expansion, if the
11824 regular expression contains dollar, or backslash characters, they must be
11825 escaped. Care must also be taken if the regular expression contains braces
11826 (curly brackets). A closing brace must be escaped so that it is not taken as a
11827 premature termination of <&'string2'&>. The easiest approach is to use the
11828 &`\N`& feature to disable expansion of the regular expression.
11829 For example,
11830 .code
11831 ${if match {$local_part}{\N^\d{3}\N} ...
11832 .endd
11833 If the whole expansion string is in double quotes, further escaping of
11834 backslashes is also required.
11835
11836 The condition is true if the regular expression match succeeds.
11837 The regular expression is not required to begin with a circumflex
11838 metacharacter, but if there is no circumflex, the expression is not anchored,
11839 and it may match anywhere in the subject, not just at the start. If you want
11840 the pattern to match at the end of the subject, you must include the &`$`&
11841 metacharacter at an appropriate point.
11842 All character handling is done in bytes and is not UTF-8 aware,
11843 but we might change this in a future Exim release.
11844
11845 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%if%& expansion"
11846 At the start of an &%if%& expansion the values of the numeric variable
11847 substitutions &$1$& etc. are remembered. Obeying a &%match%& condition that
11848 succeeds causes them to be reset to the substrings of that condition and they
11849 will have these values during the expansion of the success string. At the end
11850 of the &%if%& expansion, the previous values are restored. After testing a
11851 combination of conditions using &%or%&, the subsequent values of the numeric
11852 variables are those of the condition that succeeded.
11853
11854 .vitem &*match_address&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11855 .cindex "&%match_address%& expansion condition"
11856 See &*match_local_part*&.
11857
11858 .vitem &*match_domain&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11859 .cindex "&%match_domain%& expansion condition"
11860 See &*match_local_part*&.
11861
11862 .vitem &*match_ip&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11863 .cindex "&%match_ip%& expansion condition"
11864 This condition matches an IP address to a list of IP address patterns. It must
11865 be followed by two argument strings. The first (after expansion) must be an IP
11866 address or an empty string. The second (not expanded) is a restricted host
11867 list that can match only an IP address, not a host name. For example:
11868 .code
11869 ${if match_ip{$sender_host_address}{1.2.3.4:5.6.7.8}{...}{...}}
11870 .endd
11871 The specific types of host list item that are permitted in the list are:
11872
11873 .ilist
11874 An IP address, optionally with a CIDR mask.
11875 .next
11876 A single asterisk, which matches any IP address.
11877 .next
11878 An empty item, which matches only if the IP address is empty. This could be
11879 useful for testing for a locally submitted message or one from specific hosts
11880 in a single test such as
11881 . ==== As this is a nested list, any displays it contains must be indented
11882 . ==== as otherwise they are too far to the left. This comment applies to
11883 . ==== the use of xmlto plus fop. There's no problem when formatting with
11884 . ==== sdop, with or without the extra indent.
11885 .code
11886   ${if match_ip{$sender_host_address}{:4.3.2.1:...}{...}{...}}
11887 .endd
11888 where the first item in the list is the empty string.
11889 .next
11890 The item @[] matches any of the local host's interface addresses.
11891 .next
11892 Single-key lookups are assumed to be like &"net-"& style lookups in host lists,
11893 even if &`net-`& is not specified. There is never any attempt to turn the IP
11894 address into a host name. The most common type of linear search for
11895 &*match_ip*& is likely to be &*iplsearch*&, in which the file can contain CIDR
11896 masks. For example:
11897 .code
11898   ${if match_ip{$sender_host_address}{iplsearch;/some/file}...
11899 .endd
11900 It is of course possible to use other kinds of lookup, and in such a case, you
11901 do need to specify the &`net-`& prefix if you want to specify a specific
11902 address mask, for example:
11903 .code
11904   ${if match_ip{$sender_host_address}{net24-dbm;/some/file}...
11905 .endd
11906 However, unless you are combining a &%match_ip%& condition with others, it is
11907 just as easy to use the fact that a lookup is itself a condition, and write:
11908 .code
11909   ${lookup{${mask:$sender_host_address/24}}dbm{/a/file}...
11910 .endd
11911 .endlist ilist
11912
11913 Note that <&'string2'&> is not itself subject to string expansion, unless
11914 Exim was built with the EXPAND_LISTMATCH_RHS option.
11915
11916 Consult section &<<SECThoslispatip>>& for further details of these patterns.
11917
11918 .vitem &*match_local_part&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11919 .cindex "domain list" "in expansion condition"
11920 .cindex "address list" "in expansion condition"
11921 .cindex "local part" "list, in expansion condition"
11922 .cindex "&%match_local_part%& expansion condition"
11923 This condition, together with &%match_address%& and &%match_domain%&, make it
11924 possible to test domain, address, and local part lists within expansions. Each
11925 condition requires two arguments: an item and a list to match. A trivial
11926 example is:
11927 .code
11928 ${if match_domain{a.b.c}{x.y.z:a.b.c:p.q.r}{yes}{no}}
11929 .endd
11930 In each case, the second argument may contain any of the allowable items for a
11931 list of the appropriate type. Also, because the second argument
11932 is a standard form of list, it is possible to refer to a named list.
11933 Thus, you can use conditions like this:
11934 .code
11935 ${if match_domain{$domain}{+local_domains}{...
11936 .endd
11937 .cindex "&`+caseful`&"
11938 For address lists, the matching starts off caselessly, but the &`+caseful`&
11939 item can be used, as in all address lists, to cause subsequent items to
11940 have their local parts matched casefully. Domains are always matched
11941 caselessly.
11942
11943 Note that <&'string2'&> is not itself subject to string expansion, unless
11944 Exim was built with the EXPAND_LISTMATCH_RHS option.
11945
11946 &*Note*&: Host lists are &'not'& supported in this way. This is because
11947 hosts have two identities: a name and an IP address, and it is not clear
11948 how to specify cleanly how such a test would work. However, IP addresses can be
11949 matched using &%match_ip%&.
11950
11951 .vitem &*pam&~{*&<&'string1'&>&*:*&<&'string2'&>&*:...}*&
11952 .cindex "PAM authentication"
11953 .cindex "AUTH" "with PAM"
11954 .cindex "Solaris" "PAM support"
11955 .cindex "expansion" "PAM authentication test"
11956 .cindex "&%pam%& expansion condition"
11957 &'Pluggable Authentication Modules'&
11958 (&url(https://mirrors.edge.kernel.org/pub/linux/libs/pam/)) are a facility that is
11959 available in the latest releases of Solaris and in some GNU/Linux
11960 distributions. The Exim support, which is intended for use in conjunction with
11961 the SMTP AUTH command, is available only if Exim is compiled with
11962 .code
11963 SUPPORT_PAM=yes
11964 .endd
11965 in &_Local/Makefile_&. You probably need to add &%-lpam%& to EXTRALIBS, and
11966 in some releases of GNU/Linux &%-ldl%& is also needed.
11967
11968 The argument string is first expanded, and the result must be a
11969 colon-separated list of strings. Leading and trailing white space is ignored.
11970 The PAM module is initialized with the service name &"exim"& and the user name
11971 taken from the first item in the colon-separated data string (<&'string1'&>).
11972 The remaining items in the data string are passed over in response to requests
11973 from the authentication function. In the simple case there will only be one
11974 request, for a password, so the data consists of just two strings.
11975
11976 There can be problems if any of the strings are permitted to contain colon
11977 characters. In the usual way, these have to be doubled to avoid being taken as
11978 separators.
11979 The &%listquote%& expansion item can be used for this.
11980 For example, the configuration
11981 of a LOGIN authenticator might contain this setting:
11982 .code
11983 server_condition = ${if pam{$auth1:${listquote{:}{$auth2}}}}
11984 .endd
11985 In some operating systems, PAM authentication can be done only from a process
11986 running as root. Since Exim is running as the Exim user when receiving
11987 messages, this means that PAM cannot be used directly in those systems.
11988 . --- 2018-09-07: the pam_exim modified variant has gone, removed claims re using Exim via that
11989
11990
11991 .vitem &*pwcheck&~{*&<&'string1'&>&*:*&<&'string2'&>&*}*&
11992 .cindex "&'pwcheck'& daemon"
11993 .cindex "Cyrus"
11994 .cindex "expansion" "&'pwcheck'& authentication test"
11995 .cindex "&%pwcheck%& expansion condition"
11996 This condition supports user authentication using the Cyrus &'pwcheck'& daemon.
11997 This is one way of making it possible for passwords to be checked by a process
11998 that is not running as root. &*Note*&: The use of &'pwcheck'& is now
11999 deprecated. Its replacement is &'saslauthd'& (see below).
12000
12001 The pwcheck support is not included in Exim by default. You need to specify
12002 the location of the pwcheck daemon's socket in &_Local/Makefile_& before
12003 building Exim. For example:
12004 .code
12005 CYRUS_PWCHECK_SOCKET=/var/pwcheck/pwcheck
12006 .endd
12007 You do not need to install the full Cyrus software suite in order to use
12008 the pwcheck daemon. You can compile and install just the daemon alone
12009 from the Cyrus SASL library. Ensure that &'exim'& is the only user that has
12010 access to the &_/var/pwcheck_& directory.
12011
12012 The &%pwcheck%& condition takes one argument, which must be the user name and
12013 password, separated by a colon. For example, in a LOGIN authenticator
12014 configuration, you might have this:
12015 .code
12016 server_condition = ${if pwcheck{$auth1:$auth2}}
12017 .endd
12018 Again, for a PLAIN authenticator configuration, this would be:
12019 .code
12020 server_condition = ${if pwcheck{$auth2:$auth3}}
12021 .endd
12022 .vitem &*queue_running*&
12023 .cindex "queue runner" "detecting when delivering from"
12024 .cindex "expansion" "queue runner test"
12025 .cindex "&%queue_running%& expansion condition"
12026 This condition, which has no data, is true during delivery attempts that are
12027 initiated by queue runner processes, and false otherwise.
12028
12029
12030 .vitem &*radius&~{*&<&'authentication&~string'&>&*}*&
12031 .cindex "Radius"
12032 .cindex "expansion" "Radius authentication"
12033 .cindex "&%radius%& expansion condition"
12034 Radius authentication (RFC 2865) is supported in a similar way to PAM. You must
12035 set RADIUS_CONFIG_FILE in &_Local/Makefile_& to specify the location of
12036 the Radius client configuration file in order to build Exim with Radius
12037 support.
12038
12039 With just that one setting, Exim expects to be linked with the &%radiusclient%&
12040 library, using the original API. If you are using release 0.4.0 or later of
12041 this library, you need to set
12042 .code
12043 RADIUS_LIB_TYPE=RADIUSCLIENTNEW
12044 .endd
12045 in &_Local/Makefile_& when building Exim. You can also link Exim with the
12046 &%libradius%& library that comes with FreeBSD. To do this, set
12047 .code
12048 RADIUS_LIB_TYPE=RADLIB
12049 .endd
12050 in &_Local/Makefile_&, in addition to setting RADIUS_CONFIGURE_FILE.
12051 You may also have to supply a suitable setting in EXTRALIBS so that the
12052 Radius library can be found when Exim is linked.
12053
12054 The string specified by RADIUS_CONFIG_FILE is expanded and passed to the
12055 Radius client library, which calls the Radius server. The condition is true if
12056 the authentication is successful. For example:
12057 .code
12058 server_condition = ${if radius{<arguments>}}
12059 .endd
12060
12061
12062 .vitem "&*saslauthd&~{{*&<&'user'&>&*}{*&<&'password'&>&*}&&&
12063         {*&<&'service'&>&*}{*&<&'realm'&>&*}}*&"
12064 .cindex "&'saslauthd'& daemon"
12065 .cindex "Cyrus"
12066 .cindex "expansion" "&'saslauthd'& authentication test"
12067 .cindex "&%saslauthd%& expansion condition"
12068 This condition supports user authentication using the Cyrus &'saslauthd'&
12069 daemon. This replaces the older &'pwcheck'& daemon, which is now deprecated.
12070 Using this daemon is one way of making it possible for passwords to be checked
12071 by a process that is not running as root.
12072
12073 The saslauthd support is not included in Exim by default. You need to specify
12074 the location of the saslauthd daemon's socket in &_Local/Makefile_& before
12075 building Exim. For example:
12076 .code
12077 CYRUS_SASLAUTHD_SOCKET=/var/state/saslauthd/mux
12078 .endd
12079 You do not need to install the full Cyrus software suite in order to use
12080 the saslauthd daemon. You can compile and install just the daemon alone
12081 from the Cyrus SASL library.
12082
12083 Up to four arguments can be supplied to the &%saslauthd%& condition, but only
12084 two are mandatory. For example:
12085 .code
12086 server_condition = ${if saslauthd{{$auth1}{$auth2}}}
12087 .endd
12088 The service and the realm are optional (which is why the arguments are enclosed
12089 in their own set of braces). For details of the meaning of the service and
12090 realm, and how to run the daemon, consult the Cyrus documentation.
12091 .endlist vlist
12092
12093
12094
12095 .section "Combining expansion conditions" "SECID84"
12096 .cindex "expansion" "combining conditions"
12097 Several conditions can be tested at once by combining them using the &%and%&
12098 and &%or%& combination conditions. Note that &%and%& and &%or%& are complete
12099 conditions on their own, and precede their lists of sub-conditions. Each
12100 sub-condition must be enclosed in braces within the overall braces that contain
12101 the list. No repetition of &%if%& is used.
12102
12103
12104 .vlist
12105 .vitem &*or&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
12106 .cindex "&""or""& expansion condition"
12107 .cindex "expansion" "&""or""& of conditions"
12108 The sub-conditions are evaluated from left to right. The condition is true if
12109 any one of the sub-conditions is true.
12110 For example,
12111 .code
12112 ${if or {{eq{$local_part}{spqr}}{eq{$domain}{testing.com}}}...
12113 .endd
12114 When a true sub-condition is found, the following ones are parsed but not
12115 evaluated. If there are several &"match"& sub-conditions the values of the
12116 numeric variables afterwards are taken from the first one that succeeds.
12117
12118 .vitem &*and&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
12119 .cindex "&""and""& expansion condition"
12120 .cindex "expansion" "&""and""& of conditions"
12121 The sub-conditions are evaluated from left to right. The condition is true if
12122 all of the sub-conditions are true. If there are several &"match"&
12123 sub-conditions, the values of the numeric variables afterwards are taken from
12124 the last one. When a false sub-condition is found, the following ones are
12125 parsed but not evaluated.
12126 .endlist
12127 .ecindex IIDexpcond
12128
12129
12130
12131
12132 .section "Expansion variables" "SECTexpvar"
12133 .cindex "expansion" "variables, list of"
12134 This section contains an alphabetical list of all the expansion variables. Some
12135 of them are available only when Exim is compiled with specific options such as
12136 support for TLS or the content scanning extension.
12137
12138 .vlist
12139 .vitem "&$0$&, &$1$&, etc"
12140 .cindex "numerical variables (&$1$& &$2$& etc)"
12141 When a &%match%& expansion condition succeeds, these variables contain the
12142 captured substrings identified by the regular expression during subsequent
12143 processing of the success string of the containing &%if%& expansion item.
12144 In the expansion condition case
12145 they do not retain their values afterwards; in fact, their previous
12146 values are restored at the end of processing an &%if%& item. The numerical
12147 variables may also be set externally by some other matching process which
12148 precedes the expansion of the string. For example, the commands available in
12149 Exim filter files include an &%if%& command with its own regular expression
12150 matching condition.
12151
12152 .vitem "&$acl_arg1$&, &$acl_arg2$&, etc"
12153 Within an acl condition, expansion condition or expansion item
12154 any arguments are copied to these variables,
12155 any unused variables being made empty.
12156
12157 .vitem "&$acl_c...$&"
12158 Values can be placed in these variables by the &%set%& modifier in an ACL. They
12159 can be given any name that starts with &$acl_c$& and is at least six characters
12160 long, but the sixth character must be either a digit or an underscore. For
12161 example: &$acl_c5$&, &$acl_c_mycount$&. The values of the &$acl_c...$&
12162 variables persist throughout the lifetime of an SMTP connection. They can be
12163 used to pass information between ACLs and between different invocations of the
12164 same ACL. When a message is received, the values of these variables are saved
12165 with the message, and can be accessed by filters, routers, and transports
12166 during subsequent delivery.
12167
12168 .vitem "&$acl_m...$&"
12169 These variables are like the &$acl_c...$& variables, except that their values
12170 are reset after a message has been received. Thus, if several messages are
12171 received in one SMTP connection, &$acl_m...$& values are not passed on from one
12172 message to the next, as &$acl_c...$& values are. The &$acl_m...$& variables are
12173 also reset by MAIL, RSET, EHLO, HELO, and after starting a TLS session. When a
12174 message is received, the values of these variables are saved with the message,
12175 and can be accessed by filters, routers, and transports during subsequent
12176 delivery.
12177
12178 .vitem &$acl_narg$&
12179 Within an acl condition, expansion condition or expansion item
12180 this variable has the number of arguments.
12181
12182 .vitem &$acl_verify_message$&
12183 .vindex "&$acl_verify_message$&"
12184 After an address verification has failed, this variable contains the failure
12185 message. It retains its value for use in subsequent modifiers. The message can
12186 be preserved by coding like this:
12187 .code
12188 warn !verify = sender
12189      set acl_m0 = $acl_verify_message
12190 .endd
12191 You can use &$acl_verify_message$& during the expansion of the &%message%& or
12192 &%log_message%& modifiers, to include information about the verification
12193 failure.
12194
12195 .vitem &$address_data$&
12196 .vindex "&$address_data$&"
12197 This variable is set by means of the &%address_data%& option in routers. The
12198 value then remains with the address while it is processed by subsequent routers
12199 and eventually a transport. If the transport is handling multiple addresses,
12200 the value from the first address is used. See chapter &<<CHAProutergeneric>>&
12201 for more details. &*Note*&: The contents of &$address_data$& are visible in
12202 user filter files.
12203
12204 If &$address_data$& is set when the routers are called from an ACL to verify
12205 a recipient address, the final value is still in the variable for subsequent
12206 conditions and modifiers of the ACL statement. If routing the address caused it
12207 to be redirected to just one address, the child address is also routed as part
12208 of the verification, and in this case the final value of &$address_data$& is
12209 from the child's routing.
12210
12211 If &$address_data$& is set when the routers are called from an ACL to verify a
12212 sender address, the final value is also preserved, but this time in
12213 &$sender_address_data$&, to distinguish it from data from a recipient
12214 address.
12215
12216 In both cases (recipient and sender verification), the value does not persist
12217 after the end of the current ACL statement. If you want to preserve
12218 these values for longer, you can save them in ACL variables.
12219
12220 .vitem &$address_file$&
12221 .vindex "&$address_file$&"
12222 When, as a result of aliasing, forwarding, or filtering, a message is directed
12223 to a specific file, this variable holds the name of the file when the transport
12224 is running. At other times, the variable is empty. For example, using the
12225 default configuration, if user &%r2d2%& has a &_.forward_& file containing
12226 .code
12227 /home/r2d2/savemail
12228 .endd
12229 then when the &(address_file)& transport is running, &$address_file$&
12230 contains the text string &`/home/r2d2/savemail`&.
12231 .cindex "Sieve filter" "value of &$address_file$&"
12232 For Sieve filters, the value may be &"inbox"& or a relative folder name. It is
12233 then up to the transport configuration to generate an appropriate absolute path
12234 to the relevant file.
12235
12236 .vitem &$address_pipe$&
12237 .vindex "&$address_pipe$&"
12238 When, as a result of aliasing or forwarding, a message is directed to a pipe,
12239 this variable holds the pipe command when the transport is running.
12240
12241 .vitem "&$auth1$& &-- &$auth3$&"
12242 .vindex "&$auth1$&, &$auth2$&, etc"
12243 These variables are used in SMTP authenticators (see chapters
12244 &<<CHAPplaintext>>&&--&<<CHAPtlsauth>>&). Elsewhere, they are empty.
12245
12246 .vitem &$authenticated_id$&
12247 .cindex "authentication" "id"
12248 .vindex "&$authenticated_id$&"
12249 When a server successfully authenticates a client it may be configured to
12250 preserve some of the authentication information in the variable
12251 &$authenticated_id$& (see chapter &<<CHAPSMTPAUTH>>&). For example, a
12252 user/password authenticator configuration might preserve the user name for use
12253 in the routers. Note that this is not the same information that is saved in
12254 &$sender_host_authenticated$&.
12255
12256 When a message is submitted locally (that is, not over a TCP connection)
12257 the value of &$authenticated_id$& is normally the login name of the calling
12258 process. However, a trusted user can override this by means of the &%-oMai%&
12259 command line option.
12260 This second case also sets up information used by the
12261 &$authresults$& expansion item.
12262
12263 .vitem &$authenticated_fail_id$&
12264 .cindex "authentication" "fail" "id"
12265 .vindex "&$authenticated_fail_id$&"
12266 When an authentication attempt fails, the variable &$authenticated_fail_id$&
12267 will contain the failed authentication id. If more than one authentication
12268 id is attempted, it will contain only the last one. The variable is
12269 available for processing in the ACL's, generally the quit or notquit ACL.
12270 A message to a local recipient could still be accepted without requiring
12271 authentication, which means this variable could also be visible in all of
12272 the ACL's as well.
12273
12274
12275 .vitem &$authenticated_sender$&
12276 .cindex "sender" "authenticated"
12277 .cindex "authentication" "sender"
12278 .cindex "AUTH" "on MAIL command"
12279 .vindex "&$authenticated_sender$&"
12280 When acting as a server, Exim takes note of the AUTH= parameter on an incoming
12281 SMTP MAIL command if it believes the sender is sufficiently trusted, as
12282 described in section &<<SECTauthparamail>>&. Unless the data is the string
12283 &"<>"&, it is set as the authenticated sender of the message, and the value is
12284 available during delivery in the &$authenticated_sender$& variable. If the
12285 sender is not trusted, Exim accepts the syntax of AUTH=, but ignores the data.
12286
12287 .vindex "&$qualify_domain$&"
12288 When a message is submitted locally (that is, not over a TCP connection), the
12289 value of &$authenticated_sender$& is an address constructed from the login
12290 name of the calling process and &$qualify_domain$&, except that a trusted user
12291 can override this by means of the &%-oMas%& command line option.
12292
12293
12294 .vitem &$authentication_failed$&
12295 .cindex "authentication" "failure"
12296 .vindex "&$authentication_failed$&"
12297 This variable is set to &"1"& in an Exim server if a client issues an AUTH
12298 command that does not succeed. Otherwise it is set to &"0"&. This makes it
12299 possible to distinguish between &"did not try to authenticate"&
12300 (&$sender_host_authenticated$& is empty and &$authentication_failed$& is set to
12301 &"0"&) and &"tried to authenticate but failed"& (&$sender_host_authenticated$&
12302 is empty and &$authentication_failed$& is set to &"1"&). Failure includes any
12303 negative response to an AUTH command, including (for example) an attempt to use
12304 an undefined mechanism.
12305
12306 .vitem &$av_failed$&
12307 .cindex "content scanning" "AV scanner failure"
12308 This variable is available when Exim is compiled with the content-scanning
12309 extension. It is set to &"0"& by default, but will be set to &"1"& if any
12310 problem occurs with the virus scanner (specified by &%av_scanner%&) during
12311 the ACL malware condition.
12312
12313 .vitem &$body_linecount$&
12314 .cindex "message body" "line count"
12315 .cindex "body of message" "line count"
12316 .vindex "&$body_linecount$&"
12317 When a message is being received or delivered, this variable contains the
12318 number of lines in the message's body. See also &$message_linecount$&.
12319
12320 .vitem &$body_zerocount$&
12321 .cindex "message body" "binary zero count"
12322 .cindex "body of message" "binary zero count"
12323 .cindex "binary zero" "in message body"
12324 .vindex "&$body_zerocount$&"
12325 When a message is being received or delivered, this variable contains the
12326 number of binary zero bytes (ASCII NULs) in the message's body.
12327
12328 .vitem &$bounce_recipient$&
12329 .vindex "&$bounce_recipient$&"
12330 This is set to the recipient address of a bounce message while Exim is creating
12331 it. It is useful if a customized bounce message text file is in use (see
12332 chapter &<<CHAPemsgcust>>&).
12333
12334 .vitem &$bounce_return_size_limit$&
12335 .vindex "&$bounce_return_size_limit$&"
12336 This contains the value set in the &%bounce_return_size_limit%& option, rounded
12337 up to a multiple of 1000. It is useful when a customized error message text
12338 file is in use (see chapter &<<CHAPemsgcust>>&).
12339
12340 .vitem &$caller_gid$&
12341 .cindex "gid (group id)" "caller"
12342 .vindex "&$caller_gid$&"
12343 The real group id under which the process that called Exim was running. This is
12344 not the same as the group id of the originator of a message (see
12345 &$originator_gid$&). If Exim re-execs itself, this variable in the new
12346 incarnation normally contains the Exim gid.
12347
12348 .vitem &$caller_uid$&
12349 .cindex "uid (user id)" "caller"
12350 .vindex "&$caller_uid$&"
12351 The real user id under which the process that called Exim was running. This is
12352 not the same as the user id of the originator of a message (see
12353 &$originator_uid$&). If Exim re-execs itself, this variable in the new
12354 incarnation normally contains the Exim uid.
12355
12356 .vitem &$callout_address$&
12357 .vindex "&$callout_address$&"
12358 After a callout for verification, spamd or malware daemon service, the
12359 address that was connected to.
12360
12361 .vitem &$compile_number$&
12362 .vindex "&$compile_number$&"
12363 The building process for Exim keeps a count of the number
12364 of times it has been compiled. This serves to distinguish different
12365 compilations of the same version of Exim.
12366
12367 .vitem &$config_dir$&
12368 .vindex "&$config_dir$&"
12369 The directory name of the main configuration file. That is, the content of
12370 &$config_file$& with the last component stripped. The value does not
12371 contain the trailing slash. If &$config_file$& does not contain a slash,
12372 &$config_dir$& is ".".
12373
12374 .vitem &$config_file$&
12375 .vindex "&$config_file$&"
12376 The name of the main configuration file Exim is using.
12377
12378 .vitem &$dkim_verify_status$&
12379 Results of DKIM verification.
12380 For details see section &<<SECDKIMVFY>>&.
12381
12382 .vitem &$dkim_cur_signer$& &&&
12383        &$dkim_verify_reason$& &&&
12384        &$dkim_domain$& &&&
12385        &$dkim_identity$& &&&
12386        &$dkim_selector$& &&&
12387        &$dkim_algo$& &&&
12388        &$dkim_canon_body$& &&&
12389        &$dkim_canon_headers$& &&&
12390        &$dkim_copiedheaders$& &&&
12391        &$dkim_bodylength$& &&&
12392        &$dkim_created$& &&&
12393        &$dkim_expires$& &&&
12394        &$dkim_headernames$& &&&
12395        &$dkim_key_testing$& &&&
12396        &$dkim_key_nosubdomains$& &&&
12397        &$dkim_key_srvtype$& &&&
12398        &$dkim_key_granularity$& &&&
12399        &$dkim_key_notes$& &&&
12400        &$dkim_key_length$&
12401 These variables are only available within the DKIM ACL.
12402 For details see section &<<SECDKIMVFY>>&.
12403
12404 .vitem &$dkim_signers$&
12405 .vindex &$dkim_signers$&
12406 When a message has been received this variable contains
12407 a colon-separated list of signer domains and identities for the message.
12408 For details see section &<<SECDKIMVFY>>&.
12409
12410 .vitem &$dmarc_domain_policy$& &&&
12411        &$dmarc_status$& &&&
12412        &$dmarc_status_text$& &&&
12413        &$dmarc_used_domains$&
12414 Results of DMARC verification.
12415 For details see section &<<SECDMARC>>&.
12416
12417 .vitem &$dnslist_domain$& &&&
12418        &$dnslist_matched$& &&&
12419        &$dnslist_text$& &&&
12420        &$dnslist_value$&
12421 .vindex "&$dnslist_domain$&"
12422 .vindex "&$dnslist_matched$&"
12423 .vindex "&$dnslist_text$&"
12424 .vindex "&$dnslist_value$&"
12425 .cindex "black list (DNS)"
12426 When a DNS (black) list lookup succeeds, these variables are set to contain
12427 the following data from the lookup: the list's domain name, the key that was
12428 looked up, the contents of any associated TXT record, and the value from the
12429 main A record. See section &<<SECID204>>& for more details.
12430
12431 .vitem &$domain$&
12432 .vindex "&$domain$&"
12433 When an address is being routed, or delivered on its own, this variable
12434 contains the domain. Uppercase letters in the domain are converted into lower
12435 case for &$domain$&.
12436
12437 Global address rewriting happens when a message is received, so the value of
12438 &$domain$& during routing and delivery is the value after rewriting. &$domain$&
12439 is set during user filtering, but not during system filtering, because a
12440 message may have many recipients and the system filter is called just once.
12441
12442 When more than one address is being delivered at once (for example, several
12443 RCPT commands in one SMTP delivery), &$domain$& is set only if they all
12444 have the same domain. Transports can be restricted to handling only one domain
12445 at a time if the value of &$domain$& is required at transport time &-- this is
12446 the default for local transports. For further details of the environment in
12447 which local transports are run, see chapter &<<CHAPenvironment>>&.
12448
12449 .oindex "&%delay_warning_condition%&"
12450 At the end of a delivery, if all deferred addresses have the same domain, it is
12451 set in &$domain$& during the expansion of &%delay_warning_condition%&.
12452
12453 The &$domain$& variable is also used in some other circumstances:
12454
12455 .ilist
12456 When an ACL is running for a RCPT command, &$domain$& contains the domain of
12457 the recipient address. The domain of the &'sender'& address is in
12458 &$sender_address_domain$& at both MAIL time and at RCPT time. &$domain$& is not
12459 normally set during the running of the MAIL ACL. However, if the sender address
12460 is verified with a callout during the MAIL ACL, the sender domain is placed in
12461 &$domain$& during the expansions of &%hosts%&, &%interface%&, and &%port%& in
12462 the &(smtp)& transport.
12463
12464 .next
12465 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
12466 &$domain$& contains the domain portion of the address that is being rewritten;
12467 it can be used in the expansion of the replacement address, for example, to
12468 rewrite domains by file lookup.
12469
12470 .next
12471 With one important exception, whenever a domain list is being scanned,
12472 &$domain$& contains the subject domain. &*Exception*&: When a domain list in
12473 a &%sender_domains%& condition in an ACL is being processed, the subject domain
12474 is in &$sender_address_domain$& and not in &$domain$&. It works this way so
12475 that, in a RCPT ACL, the sender domain list can be dependent on the
12476 recipient domain (which is what is in &$domain$& at this time).
12477
12478 .next
12479 .cindex "ETRN" "value of &$domain$&"
12480 .oindex "&%smtp_etrn_command%&"
12481 When the &%smtp_etrn_command%& option is being expanded, &$domain$& contains
12482 the complete argument of the ETRN command (see section &<<SECTETRN>>&).
12483 .endlist
12484
12485 .cindex "tainted data"
12486 If the origin of the data is an incoming message,
12487 the result of expanding this variable is tainted and may not
12488 be further expanded or used as a filename.
12489 When an untainted version is needed, one should be obtained from
12490 looking up the value in a local (therefore trusted) database.
12491 Often &$domain_data$& is usable in this role.
12492
12493
12494 .vitem &$domain_data$&
12495 .vindex "&$domain_data$&"
12496 When the &%domains%& condition on a router
12497 .new
12498 or an ACL
12499 matches a domain
12500 against a list, the match value is copied to &$domain_data$&.
12501 This is an enhancement over previous versions of Exim, when it only
12502 applied to the data read by a lookup.
12503 For details on match values see section &<<SECTlistresults>>& et. al.
12504 .wen
12505
12506 If the router routes the
12507 address to a transport, the value is available in that transport. If the
12508 transport is handling multiple addresses, the value from the first address is
12509 used.
12510
12511 &$domain_data$& set in an ACL is available during
12512 the rest of the ACL statement.
12513
12514 .vitem &$exim_gid$&
12515 .vindex "&$exim_gid$&"
12516 This variable contains the numerical value of the Exim group id.
12517
12518 .vitem &$exim_path$&
12519 .vindex "&$exim_path$&"
12520 This variable contains the path to the Exim binary.
12521
12522 .vitem &$exim_uid$&
12523 .vindex "&$exim_uid$&"
12524 This variable contains the numerical value of the Exim user id.
12525
12526 .vitem &$exim_version$&
12527 .vindex "&$exim_version$&"
12528 This variable contains the version string of the Exim build.
12529 The first character is a major version number, currently 4.
12530 Then after a dot, the next group of digits is a minor version number.
12531 There may be other characters following the minor version.
12532 This value may be overridden by the &%exim_version%& main config option.
12533
12534 .vitem &$header_$&<&'name'&>
12535 This is not strictly an expansion variable. It is expansion syntax for
12536 inserting the message header line with the given name. Note that the name must
12537 be terminated by colon or white space, because it may contain a wide variety of
12538 characters. Note also that braces must &'not'& be used.
12539 See the full description in section &<<SECTexpansionitems>>& above.
12540
12541 .vitem &$headers_added$&
12542 .vindex "&$headers_added$&"
12543 Within an ACL this variable contains the headers added so far by
12544 the ACL modifier add_header (section &<<SECTaddheadacl>>&).
12545 The headers are a newline-separated list.
12546
12547 .vitem &$home$&
12548 .vindex "&$home$&"
12549 When the &%check_local_user%& option is set for a router, the user's home
12550 directory is placed in &$home$& when the check succeeds. In particular, this
12551 means it is set during the running of users' filter files. A router may also
12552 explicitly set a home directory for use by a transport; this can be overridden
12553 by a setting on the transport itself.
12554
12555 When running a filter test via the &%-bf%& option, &$home$& is set to the value
12556 of the environment variable HOME, which is subject to the
12557 &%keep_environment%& and &%add_environment%& main config options.
12558
12559 .vitem &$host$&
12560 .vindex "&$host$&"
12561 If a router assigns an address to a transport (any transport), and passes a
12562 list of hosts with the address, the value of &$host$& when the transport starts
12563 to run is the name of the first host on the list. Note that this applies both
12564 to local and remote transports.
12565
12566 .cindex "transport" "filter"
12567 .cindex "filter" "transport filter"
12568 For the &(smtp)& transport, if there is more than one host, the value of
12569 &$host$& changes as the transport works its way through the list. In
12570 particular, when the &(smtp)& transport is expanding its options for encryption
12571 using TLS, or for specifying a transport filter (see chapter
12572 &<<CHAPtransportgeneric>>&), &$host$& contains the name of the host to which it
12573 is connected.
12574
12575 When used in the client part of an authenticator configuration (see chapter
12576 &<<CHAPSMTPAUTH>>&), &$host$& contains the name of the server to which the
12577 client is connected.
12578
12579
12580 .vitem &$host_address$&
12581 .vindex "&$host_address$&"
12582 This variable is set to the remote host's IP address whenever &$host$& is set
12583 for a remote connection. It is also set to the IP address that is being checked
12584 when the &%ignore_target_hosts%& option is being processed.
12585
12586 .vitem &$host_data$&
12587 .vindex "&$host_data$&"
12588 If a &%hosts%& condition in an ACL is satisfied by means of a lookup, the
12589 result of the lookup is made available in the &$host_data$& variable. This
12590 allows you, for example, to do things like this:
12591 .code
12592 deny  hosts = net-lsearch;/some/file
12593       message = $host_data
12594 .endd
12595 .vitem &$host_lookup_deferred$&
12596 .cindex "host name" "lookup, failure of"
12597 .vindex "&$host_lookup_deferred$&"
12598 This variable normally contains &"0"&, as does &$host_lookup_failed$&. When a
12599 message comes from a remote host and there is an attempt to look up the host's
12600 name from its IP address, and the attempt is not successful, one of these
12601 variables is set to &"1"&.
12602
12603 .ilist
12604 If the lookup receives a definite negative response (for example, a DNS lookup
12605 succeeded, but no records were found), &$host_lookup_failed$& is set to &"1"&.
12606
12607 .next
12608 If there is any kind of problem during the lookup, such that Exim cannot
12609 tell whether or not the host name is defined (for example, a timeout for a DNS
12610 lookup), &$host_lookup_deferred$& is set to &"1"&.
12611 .endlist ilist
12612
12613 Looking up a host's name from its IP address consists of more than just a
12614 single reverse lookup. Exim checks that a forward lookup of at least one of the
12615 names it receives from a reverse lookup yields the original IP address. If this
12616 is not the case, Exim does not accept the looked up name(s), and
12617 &$host_lookup_failed$& is set to &"1"&. Thus, being able to find a name from an
12618 IP address (for example, the existence of a PTR record in the DNS) is not
12619 sufficient on its own for the success of a host name lookup. If the reverse
12620 lookup succeeds, but there is a lookup problem such as a timeout when checking
12621 the result, the name is not accepted, and &$host_lookup_deferred$& is set to
12622 &"1"&. See also &$sender_host_name$&.
12623
12624 .cindex authentication "expansion item"
12625 Performing these checks sets up information used by the
12626 &%authresults%& expansion item.
12627
12628
12629 .vitem &$host_lookup_failed$&
12630 .vindex "&$host_lookup_failed$&"
12631 See &$host_lookup_deferred$&.
12632
12633 .vitem &$host_port$&
12634 .vindex "&$host_port$&"
12635 This variable is set to the remote host's TCP port whenever &$host$& is set
12636 for an outbound connection.
12637
12638 .vitem &$initial_cwd$&
12639 .vindex "&$initial_cwd$&
12640 This variable contains the full path name of the initial working
12641 directory of the current Exim process. This may differ from the current
12642 working directory, as Exim changes this to "/" during early startup, and
12643 to &$spool_directory$& later.
12644
12645 .vitem &$inode$&
12646 .vindex "&$inode$&"
12647 The only time this variable is set is while expanding the &%directory_file%&
12648 option in the &(appendfile)& transport. The variable contains the inode number
12649 of the temporary file which is about to be renamed. It can be used to construct
12650 a unique name for the file.
12651
12652 .vitem &$interface_address$&
12653 .vindex "&$interface_address$&"
12654 This is an obsolete name for &$received_ip_address$&.
12655
12656 .vitem &$interface_port$&
12657 .vindex "&$interface_port$&"
12658 This is an obsolete name for &$received_port$&.
12659
12660 .vitem &$item$&
12661 .vindex "&$item$&"
12662 This variable is used during the expansion of &*forall*& and &*forany*&
12663 conditions (see section &<<SECTexpcond>>&), and &*filter*&, &*map*&, and
12664 &*reduce*& items (see section &<<SECTexpcond>>&). In other circumstances, it is
12665 empty.
12666
12667 .vitem &$ldap_dn$&
12668 .vindex "&$ldap_dn$&"
12669 This variable, which is available only when Exim is compiled with LDAP support,
12670 contains the DN from the last entry in the most recently successful LDAP
12671 lookup.
12672
12673 .vitem &$load_average$&
12674 .vindex "&$load_average$&"
12675 This variable contains the system load average, multiplied by 1000 so that it
12676 is an integer. For example, if the load average is 0.21, the value of the
12677 variable is 210. The value is recomputed every time the variable is referenced.
12678
12679 .vitem &$local_part$&
12680 .vindex "&$local_part$&"
12681 When an address is being routed, or delivered on its own, this
12682 variable contains the local part. When a number of addresses are being
12683 delivered together (for example, multiple RCPT commands in an SMTP
12684 session), &$local_part$& is not set.
12685
12686 Global address rewriting happens when a message is received, so the value of
12687 &$local_part$& during routing and delivery is the value after rewriting.
12688 &$local_part$& is set during user filtering, but not during system filtering,
12689 because a message may have many recipients and the system filter is called just
12690 once.
12691
12692 .cindex "tainted data"
12693 If the origin of the data is an incoming message,
12694 the result of expanding this variable is tainted and
12695 may not be further expanded or used as a filename.
12696
12697 &*Warning*&: the content of this variable is usually provided by a potential
12698 attacker.
12699 Consider carefully the implications of using it unvalidated as a name
12700 for file access.
12701 This presents issues for users' &_.forward_& and filter files.
12702 For traditional full user accounts, use &%check_local_users%& and the
12703 &$local_part_data$& variable rather than this one.
12704 For virtual users, store a suitable pathname component in the database
12705 which is used for account name validation, and use that retrieved value
12706 rather than this variable.
12707 Often &$local_part_data$& is usable in this role.
12708 If needed, use a router &%address_data%& or &%set%& option for
12709 the retrieved data.
12710
12711 When a message is being delivered to a file, pipe, or autoreply transport as a
12712 result of aliasing or forwarding, &$local_part$& is set to the local part of
12713 the parent address, not to the filename or command (see &$address_file$& and
12714 &$address_pipe$&).
12715
12716 When an ACL is running for a RCPT command, &$local_part$& contains the
12717 local part of the recipient address.
12718
12719 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
12720 &$local_part$& contains the local part of the address that is being rewritten;
12721 it can be used in the expansion of the replacement address, for example.
12722
12723 In all cases, all quoting is removed from the local part. For example, for both
12724 the addresses
12725 .code
12726 "abc:xyz"@test.example
12727 abc\:xyz@test.example
12728 .endd
12729 the value of &$local_part$& is
12730 .code
12731 abc:xyz
12732 .endd
12733 If you use &$local_part$& to create another address, you should always wrap it
12734 inside a quoting operator. For example, in a &(redirect)& router you could
12735 have:
12736 .code
12737 data = ${quote_local_part:$local_part}@new.domain.example
12738 .endd
12739 &*Note*&: The value of &$local_part$& is normally lower cased. If you want
12740 to process local parts in a case-dependent manner in a router, you can set the
12741 &%caseful_local_part%& option (see chapter &<<CHAProutergeneric>>&).
12742
12743 .vitem &$local_part_data$&
12744 .vindex "&$local_part_data$&"
12745 When the &%local_parts%& condition on a router or ACL
12746 matches a local part list
12747 .new
12748 the match value is copied to &$local_part_data$&.
12749 This is an enhancement over previous versions of Exim, when it only
12750 applied to the data read by a lookup.
12751 For details on match values see section &<<SECTlistresults>>& et. al.
12752 .wen
12753
12754 The &%check_local_user%& router option also sets this variable.
12755
12756 .vindex &$local_part_prefix$& &&&
12757         &$local_part_prefix_v$& &&&
12758         &$local_part_suffix$& &&&
12759         &$local_part_suffix_v$&
12760 .cindex affix variables
12761 If a local part prefix or suffix has been recognized, it is not included in the
12762 value of &$local_part$& during routing and subsequent delivery. The values of
12763 any prefix or suffix are in &$local_part_prefix$& and
12764 &$local_part_suffix$&, respectively.
12765 .cindex "tainted data"
12766 If the specification did not include a wildcard then
12767 the affix variable value is not tainted.
12768
12769 If the affix specification included a wildcard then the portion of
12770 the affix matched by the wildcard is in
12771 &$local_part_prefix_v$& or &$local_part_suffix_v$& as appropriate,
12772 and both the whole and varying values are tainted.
12773
12774 .vitem &$local_scan_data$&
12775 .vindex "&$local_scan_data$&"
12776 This variable contains the text returned by the &[local_scan()]& function when
12777 a message is received. See chapter &<<CHAPlocalscan>>& for more details.
12778
12779 .vitem &$local_user_gid$&
12780 .vindex "&$local_user_gid$&"
12781 See &$local_user_uid$&.
12782
12783 .vitem &$local_user_uid$&
12784 .vindex "&$local_user_uid$&"
12785 This variable and &$local_user_gid$& are set to the uid and gid after the
12786 &%check_local_user%& router precondition succeeds. This means that their values
12787 are available for the remaining preconditions (&%senders%&, &%require_files%&,
12788 and &%condition%&), for the &%address_data%& expansion, and for any
12789 router-specific expansions. At all other times, the values in these variables
12790 are &`(uid_t)(-1)`& and &`(gid_t)(-1)`&, respectively.
12791
12792 .vitem &$localhost_number$&
12793 .vindex "&$localhost_number$&"
12794 This contains the expanded value of the
12795 &%localhost_number%& option. The expansion happens after the main options have
12796 been read.
12797
12798 .vitem &$log_inodes$&
12799 .vindex "&$log_inodes$&"
12800 The number of free inodes in the disk partition where Exim's
12801 log files are being written. The value is recalculated whenever the variable is
12802 referenced. If the relevant file system does not have the concept of inodes,
12803 the value of is -1. See also the &%check_log_inodes%& option.
12804
12805 .vitem &$log_space$&
12806 .vindex "&$log_space$&"
12807 The amount of free space (as a number of kilobytes) in the disk
12808 partition where Exim's log files are being written. The value is recalculated
12809 whenever the variable is referenced. If the operating system does not have the
12810 ability to find the amount of free space (only true for experimental systems),
12811 the space value is -1. See also the &%check_log_space%& option.
12812
12813
12814 .vitem &$lookup_dnssec_authenticated$&
12815 .vindex "&$lookup_dnssec_authenticated$&"
12816 This variable is set after a DNS lookup done by
12817 a dnsdb lookup expansion, dnslookup router or smtp transport.
12818 .cindex "DNS" "DNSSEC"
12819 It will be empty if &(DNSSEC)& was not requested,
12820 &"no"& if the result was not labelled as authenticated data
12821 and &"yes"& if it was.
12822 Results that are labelled as authoritative answer that match
12823 the &%dns_trust_aa%& configuration variable count also
12824 as authenticated data.
12825
12826 .vitem &$mailstore_basename$&
12827 .vindex "&$mailstore_basename$&"
12828 This variable is set only when doing deliveries in &"mailstore"& format in the
12829 &(appendfile)& transport. During the expansion of the &%mailstore_prefix%&,
12830 &%mailstore_suffix%&, &%message_prefix%&, and &%message_suffix%& options, it
12831 contains the basename of the files that are being written, that is, the name
12832 without the &".tmp"&, &".env"&, or &".msg"& suffix. At all other times, this
12833 variable is empty.
12834
12835 .vitem &$malware_name$&
12836 .vindex "&$malware_name$&"
12837 This variable is available when Exim is compiled with the
12838 content-scanning extension. It is set to the name of the virus that was found
12839 when the ACL &%malware%& condition is true (see section &<<SECTscanvirus>>&).
12840
12841 .vitem &$max_received_linelength$&
12842 .vindex "&$max_received_linelength$&"
12843 .cindex "maximum" "line length"
12844 .cindex "line length" "maximum"
12845 This variable contains the number of bytes in the longest line that was
12846 received as part of the message, not counting the line termination
12847 character(s).
12848 It is not valid if the &%spool_files_wireformat%& option is used.
12849
12850 .vitem &$message_age$&
12851 .cindex "message" "age of"
12852 .vindex "&$message_age$&"
12853 This variable is set at the start of a delivery attempt to contain the number
12854 of seconds since the message was received. It does not change during a single
12855 delivery attempt.
12856
12857 .vitem &$message_body$&
12858 .cindex "body of message" "expansion variable"
12859 .cindex "message body" "in expansion"
12860 .cindex "binary zero" "in message body"
12861 .vindex "&$message_body$&"
12862 .oindex "&%message_body_visible%&"
12863 This variable contains the initial portion of a message's body while it is
12864 being delivered, and is intended mainly for use in filter files. The maximum
12865 number of characters of the body that are put into the variable is set by the
12866 &%message_body_visible%& configuration option; the default is 500.
12867
12868 .oindex "&%message_body_newlines%&"
12869 By default, newlines are converted into spaces in &$message_body$&, to make it
12870 easier to search for phrases that might be split over a line break. However,
12871 this can be disabled by setting &%message_body_newlines%& to be true. Binary
12872 zeros are always converted into spaces.
12873
12874 .vitem &$message_body_end$&
12875 .cindex "body of message" "expansion variable"
12876 .cindex "message body" "in expansion"
12877 .vindex "&$message_body_end$&"
12878 This variable contains the final portion of a message's
12879 body while it is being delivered. The format and maximum size are as for
12880 &$message_body$&.
12881
12882 .vitem &$message_body_size$&
12883 .cindex "body of message" "size"
12884 .cindex "message body" "size"
12885 .vindex "&$message_body_size$&"
12886 When a message is being delivered, this variable contains the size of the body
12887 in bytes. The count starts from the character after the blank line that
12888 separates the body from the header. Newlines are included in the count. See
12889 also &$message_size$&, &$body_linecount$&, and &$body_zerocount$&.
12890
12891 If the spool file is wireformat
12892 (see the &%spool_files_wireformat%& main option)
12893 the CRLF line-terminators are included in the count.
12894
12895 .vitem &$message_exim_id$&
12896 .vindex "&$message_exim_id$&"
12897 When a message is being received or delivered, this variable contains the
12898 unique message id that is generated and used by Exim to identify the message.
12899 An id is not created for a message until after its header has been successfully
12900 received. &*Note*&: This is &'not'& the contents of the &'Message-ID:'& header
12901 line; it is the local id that Exim assigns to the message, for example:
12902 &`1BXTIK-0001yO-VA`&.
12903
12904 .vitem &$message_headers$&
12905 .vindex &$message_headers$&
12906 This variable contains a concatenation of all the header lines when a message
12907 is being processed, except for lines added by routers or transports. The header
12908 lines are separated by newline characters. Their contents are decoded in the
12909 same way as a header line that is inserted by &%bheader%&.
12910
12911 .vitem &$message_headers_raw$&
12912 .vindex &$message_headers_raw$&
12913 This variable is like &$message_headers$& except that no processing of the
12914 contents of header lines is done.
12915
12916 .vitem &$message_id$&
12917 This is an old name for &$message_exim_id$&. It is now deprecated.
12918
12919 .vitem &$message_linecount$&
12920 .vindex "&$message_linecount$&"
12921 This variable contains the total number of lines in the header and body of the
12922 message. Compare &$body_linecount$&, which is the count for the body only.
12923 During the DATA and content-scanning ACLs, &$message_linecount$& contains the
12924 number of lines received. Before delivery happens (that is, before filters,
12925 routers, and transports run) the count is increased to include the
12926 &'Received:'& header line that Exim standardly adds, and also any other header
12927 lines that are added by ACLs. The blank line that separates the message header
12928 from the body is not counted.
12929
12930 As with the special case of &$message_size$&, during the expansion of the
12931 appendfile transport's maildir_tag option in maildir format, the value of
12932 &$message_linecount$& is the precise size of the number of newlines in the
12933 file that has been written (minus one for the blank line between the
12934 header and the body).
12935
12936 Here is an example of the use of this variable in a DATA ACL:
12937 .code
12938 deny condition = \
12939       ${if <{250}{${eval:$message_linecount - $body_linecount}}}
12940      message   = Too many lines in message header
12941 .endd
12942 In the MAIL and RCPT ACLs, the value is zero because at that stage the
12943 message has not yet been received.
12944
12945 This variable is not valid if the &%spool_files_wireformat%& option is used.
12946
12947 .vitem &$message_size$&
12948 .cindex "size" "of message"
12949 .cindex "message" "size"
12950 .vindex "&$message_size$&"
12951 When a message is being processed, this variable contains its size in bytes. In
12952 most cases, the size includes those headers that were received with the
12953 message, but not those (such as &'Envelope-to:'&) that are added to individual
12954 deliveries as they are written. However, there is one special case: during the
12955 expansion of the &%maildir_tag%& option in the &(appendfile)& transport while
12956 doing a delivery in maildir format, the value of &$message_size$& is the
12957 precise size of the file that has been written. See also
12958 &$message_body_size$&, &$body_linecount$&, and &$body_zerocount$&.
12959
12960 .cindex "RCPT" "value of &$message_size$&"
12961 While running a per message ACL (mail/rcpt/predata), &$message_size$&
12962 contains the size supplied on the MAIL command, or -1 if no size was given. The
12963 value may not, of course, be truthful.
12964
12965 .vitem &$mime_$&&'xxx'&
12966 A number of variables whose names start with &$mime$& are
12967 available when Exim is compiled with the content-scanning extension. For
12968 details, see section &<<SECTscanmimepart>>&.
12969
12970 .vitem "&$n0$& &-- &$n9$&"
12971 These variables are counters that can be incremented by means
12972 of the &%add%& command in filter files.
12973
12974 .vitem &$original_domain$&
12975 .vindex "&$domain$&"
12976 .vindex "&$original_domain$&"
12977 When a top-level address is being processed for delivery, this contains the
12978 same value as &$domain$&. However, if a &"child"& address (for example,
12979 generated by an alias, forward, or filter file) is being processed, this
12980 variable contains the domain of the original address (lower cased). This
12981 differs from &$parent_domain$& only when there is more than one level of
12982 aliasing or forwarding. When more than one address is being delivered in a
12983 single transport run, &$original_domain$& is not set.
12984
12985 If a new address is created by means of a &%deliver%& command in a system
12986 filter, it is set up with an artificial &"parent"& address. This has the local
12987 part &'system-filter'& and the default qualify domain.
12988
12989 .vitem &$original_local_part$&
12990 .vindex "&$local_part$&"
12991 .vindex "&$original_local_part$&"
12992 When a top-level address is being processed for delivery, this contains the
12993 same value as &$local_part$&, unless a prefix or suffix was removed from the
12994 local part, because &$original_local_part$& always contains the full local
12995 part. When a &"child"& address (for example, generated by an alias, forward, or
12996 filter file) is being processed, this variable contains the full local part of
12997 the original address.
12998
12999 If the router that did the redirection processed the local part
13000 case-insensitively, the value in &$original_local_part$& is in lower case.
13001 This variable differs from &$parent_local_part$& only when there is more than
13002 one level of aliasing or forwarding. When more than one address is being
13003 delivered in a single transport run, &$original_local_part$& is not set.
13004
13005 If a new address is created by means of a &%deliver%& command in a system
13006 filter, it is set up with an artificial &"parent"& address. This has the local
13007 part &'system-filter'& and the default qualify domain.
13008
13009 .vitem &$originator_gid$&
13010 .cindex "gid (group id)" "of originating user"
13011 .cindex "sender" "gid"
13012 .vindex "&$caller_gid$&"
13013 .vindex "&$originator_gid$&"
13014 This variable contains the value of &$caller_gid$& that was set when the
13015 message was received. For messages received via the command line, this is the
13016 gid of the sending user. For messages received by SMTP over TCP/IP, this is
13017 normally the gid of the Exim user.
13018
13019 .vitem &$originator_uid$&
13020 .cindex "uid (user id)" "of originating user"
13021 .cindex "sender" "uid"
13022 .vindex "&$caller_uid$&"
13023 .vindex "&$originator_uid$&"
13024 The value of &$caller_uid$& that was set when the message was received. For
13025 messages received via the command line, this is the uid of the sending user.
13026 For messages received by SMTP over TCP/IP, this is normally the uid of the Exim
13027 user.
13028
13029 .vitem &$parent_domain$&
13030 .vindex "&$parent_domain$&"
13031 This variable is similar to &$original_domain$& (see
13032 above), except that it refers to the immediately preceding parent address.
13033
13034 .vitem &$parent_local_part$&
13035 .vindex "&$parent_local_part$&"
13036 This variable is similar to &$original_local_part$&
13037 (see above), except that it refers to the immediately preceding parent address.
13038
13039 .vitem &$pid$&
13040 .cindex "pid (process id)" "of current process"
13041 .vindex "&$pid$&"
13042 This variable contains the current process id.
13043
13044 .vitem &$pipe_addresses$&
13045 .cindex "filter" "transport filter"
13046 .cindex "transport" "filter"
13047 .vindex "&$pipe_addresses$&"
13048 This is not an expansion variable, but is mentioned here because the string
13049 &`$pipe_addresses`& is handled specially in the command specification for the
13050 &(pipe)& transport (chapter &<<CHAPpipetransport>>&) and in transport filters
13051 (described under &%transport_filter%& in chapter &<<CHAPtransportgeneric>>&).
13052 It cannot be used in general expansion strings, and provokes an &"unknown
13053 variable"& error if encountered.
13054
13055 .vitem &$primary_hostname$&
13056 .vindex "&$primary_hostname$&"
13057 This variable contains the value set by &%primary_hostname%& in the
13058 configuration file, or read by the &[uname()]& function. If &[uname()]& returns
13059 a single-component name, Exim calls &[gethostbyname()]& (or
13060 &[getipnodebyname()]& where available) in an attempt to acquire a fully
13061 qualified host name. See also &$smtp_active_hostname$&.
13062
13063
13064 .vitem &$proxy_external_address$& &&&
13065        &$proxy_external_port$& &&&
13066        &$proxy_local_address$& &&&
13067        &$proxy_local_port$& &&&
13068        &$proxy_session$&
13069 These variables are only available when built with Proxy Protocol
13070 or SOCKS5 support.
13071 For details see chapter &<<SECTproxyInbound>>&.
13072
13073 .vitem &$prdr_requested$&
13074 .cindex "PRDR" "variable for"
13075 This variable is set to &"yes"& if PRDR was requested by the client for the
13076 current message, otherwise &"no"&.
13077
13078 .vitem &$prvscheck_address$&
13079 This variable is used in conjunction with the &%prvscheck%& expansion item,
13080 which is described in sections &<<SECTexpansionitems>>& and
13081 &<<SECTverifyPRVS>>&.
13082
13083 .vitem &$prvscheck_keynum$&
13084 This variable is used in conjunction with the &%prvscheck%& expansion item,
13085 which is described in sections &<<SECTexpansionitems>>& and
13086 &<<SECTverifyPRVS>>&.
13087
13088 .vitem &$prvscheck_result$&
13089 This variable is used in conjunction with the &%prvscheck%& expansion item,
13090 which is described in sections &<<SECTexpansionitems>>& and
13091 &<<SECTverifyPRVS>>&.
13092
13093 .vitem &$qualify_domain$&
13094 .vindex "&$qualify_domain$&"
13095 The value set for the &%qualify_domain%& option in the configuration file.
13096
13097 .vitem &$qualify_recipient$&
13098 .vindex "&$qualify_recipient$&"
13099 The value set for the &%qualify_recipient%& option in the configuration file,
13100 or if not set, the value of &$qualify_domain$&.
13101
13102 .vitem &$queue_name$&
13103 .vindex &$queue_name$&
13104 .cindex "named queues" variable
13105 .cindex queues named
13106 The name of the spool queue in use; empty for the default queue.
13107
13108 .vitem &$queue_size$&
13109 .vindex "&$queue_size$&"
13110 .cindex "queue" "size of"
13111 .cindex "spool" "number of messages"
13112 This variable contains the number of messages queued.
13113 It is evaluated on demand, but no more often than once every minute.
13114
13115 .vitem &$r_...$&
13116 .vindex &$r_...$&
13117 .cindex router variables
13118 Values can be placed in these variables by the &%set%& option of a router.
13119 They can be given any name that starts with &$r_$&.
13120 The values persist for the address being handled through subsequent routers
13121 and the eventual transport.
13122
13123 .vitem &$rcpt_count$&
13124 .vindex "&$rcpt_count$&"
13125 When a message is being received by SMTP, this variable contains the number of
13126 RCPT commands received for the current message. If this variable is used in a
13127 RCPT ACL, its value includes the current command.
13128
13129 .vitem &$rcpt_defer_count$&
13130 .vindex "&$rcpt_defer_count$&"
13131 .cindex "4&'xx'& responses" "count of"
13132 When a message is being received by SMTP, this variable contains the number of
13133 RCPT commands in the current message that have previously been rejected with a
13134 temporary (4&'xx'&) response.
13135
13136 .vitem &$rcpt_fail_count$&
13137 .vindex "&$rcpt_fail_count$&"
13138 When a message is being received by SMTP, this variable contains the number of
13139 RCPT commands in the current message that have previously been rejected with a
13140 permanent (5&'xx'&) response.
13141
13142 .vitem &$received_count$&
13143 .vindex "&$received_count$&"
13144 This variable contains the number of &'Received:'& header lines in the message,
13145 including the one added by Exim (so its value is always greater than zero). It
13146 is available in the DATA ACL, the non-SMTP ACL, and while routing and
13147 delivering.
13148
13149 .vitem &$received_for$&
13150 .vindex "&$received_for$&"
13151 If there is only a single recipient address in an incoming message, this
13152 variable contains that address when the &'Received:'& header line is being
13153 built. The value is copied after recipient rewriting has happened, but before
13154 the &[local_scan()]& function is run.
13155
13156 .vitem &$received_ip_address$&
13157 .vindex "&$received_ip_address$&"
13158 As soon as an Exim server starts processing an incoming TCP/IP connection, this
13159 variable is set to the address of the local IP interface, and &$received_port$&
13160 is set to the local port number. (The remote IP address and port are in
13161 &$sender_host_address$& and &$sender_host_port$&.) When testing with &%-bh%&,
13162 the port value is -1 unless it has been set using the &%-oMi%& command line
13163 option.
13164
13165 As well as being useful in ACLs (including the &"connect"& ACL), these variable
13166 could be used, for example, to make the filename for a TLS certificate depend
13167 on which interface and/or port is being used for the incoming connection. The
13168 values of &$received_ip_address$& and &$received_port$& are saved with any
13169 messages that are received, thus making these variables available at delivery
13170 time.
13171 For outbound connections see &$sending_ip_address$&.
13172
13173 .vitem &$received_port$&
13174 .vindex "&$received_port$&"
13175 See &$received_ip_address$&.
13176
13177 .vitem &$received_protocol$&
13178 .vindex "&$received_protocol$&"
13179 When a message is being processed, this variable contains the name of the
13180 protocol by which it was received. Most of the names used by Exim are defined
13181 by RFCs 821, 2821, and 3848. They start with &"smtp"& (the client used HELO) or
13182 &"esmtp"& (the client used EHLO). This can be followed by &"s"& for secure
13183 (encrypted) and/or &"a"& for authenticated. Thus, for example, if the protocol
13184 is set to &"esmtpsa"&, the message was received over an encrypted SMTP
13185 connection and the client was successfully authenticated.
13186
13187 Exim uses the protocol name &"smtps"& for the case when encryption is
13188 automatically set up on connection without the use of STARTTLS (see
13189 &%tls_on_connect_ports%&), and the client uses HELO to initiate the
13190 encrypted SMTP session. The name &"smtps"& is also used for the rare situation
13191 where the client initially uses EHLO, sets up an encrypted connection using
13192 STARTTLS, and then uses HELO afterwards.
13193
13194 The &%-oMr%& option provides a way of specifying a custom protocol name for
13195 messages that are injected locally by trusted callers. This is commonly used to
13196 identify messages that are being re-injected after some kind of scanning.
13197
13198 .vitem &$received_time$&
13199 .vindex "&$received_time$&"
13200 This variable contains the date and time when the current message was received,
13201 as a number of seconds since the start of the Unix epoch.
13202
13203 .vitem &$recipient_data$&
13204 .vindex "&$recipient_data$&"
13205 This variable is set after an indexing lookup success in an ACL &%recipients%&
13206 condition. It contains the data from the lookup, and the value remains set
13207 until the next &%recipients%& test. Thus, you can do things like this:
13208 .display
13209 &`require recipients  = cdb*@;/some/file`&
13210 &`deny    `&&'some further test involving'& &`$recipient_data`&
13211 .endd
13212 &*Warning*&: This variable is set only when a lookup is used as an indexing
13213 method in the address list, using the semicolon syntax as in the example above.
13214 The variable is not set for a lookup that is used as part of the string
13215 expansion that all such lists undergo before being interpreted.
13216
13217 .vitem &$recipient_verify_failure$&
13218 .vindex "&$recipient_verify_failure$&"
13219 In an ACL, when a recipient verification fails, this variable contains
13220 information about the failure. It is set to one of the following words:
13221
13222 .ilist
13223 &"qualify"&: The address was unqualified (no domain), and the message
13224 was neither local nor came from an exempted host.
13225
13226 .next
13227 &"route"&: Routing failed.
13228
13229 .next
13230 &"mail"&: Routing succeeded, and a callout was attempted; rejection occurred at
13231 or before the MAIL command (that is, on initial connection, HELO, or
13232 MAIL).
13233
13234 .next
13235 &"recipient"&: The RCPT command in a callout was rejected.
13236 .next
13237
13238 &"postmaster"&: The postmaster check in a callout was rejected.
13239 .endlist
13240
13241 The main use of this variable is expected to be to distinguish between
13242 rejections of MAIL and rejections of RCPT.
13243
13244 .vitem &$recipients$&
13245 .vindex "&$recipients$&"
13246 This variable contains a list of envelope recipients for a message. A comma and
13247 a space separate the addresses in the replacement text. However, the variable
13248 is not generally available, to prevent exposure of Bcc recipients in
13249 unprivileged users' filter files. You can use &$recipients$& only in these
13250 cases:
13251
13252 .olist
13253 In a system filter file.
13254 .next
13255 In the ACLs associated with the DATA command and with non-SMTP messages, that
13256 is, the ACLs defined by &%acl_smtp_predata%&, &%acl_smtp_data%&,
13257 &%acl_smtp_mime%&, &%acl_not_smtp_start%&, &%acl_not_smtp%&, and
13258 &%acl_not_smtp_mime%&.
13259 .next
13260 From within a &[local_scan()]& function.
13261 .endlist
13262
13263
13264 .vitem &$recipients_count$&
13265 .vindex "&$recipients_count$&"
13266 When a message is being processed, this variable contains the number of
13267 envelope recipients that came with the message. Duplicates are not excluded
13268 from the count. While a message is being received over SMTP, the number
13269 increases for each accepted recipient. It can be referenced in an ACL.
13270
13271
13272 .vitem &$regex_match_string$&
13273 .vindex "&$regex_match_string$&"
13274 This variable is set to contain the matching regular expression after a
13275 &%regex%& ACL condition has matched (see section &<<SECTscanregex>>&).
13276
13277 .vitem "&$regex1$&, &$regex2$&, etc"
13278 .cindex "regex submatch variables (&$1regex$& &$2regex$& etc)"
13279 When a &%regex%& or &%mime_regex%& ACL condition succeeds,
13280 these variables contain the
13281 captured substrings identified by the regular expression.
13282
13283
13284 .vitem &$reply_address$&
13285 .vindex "&$reply_address$&"
13286 When a message is being processed, this variable contains the contents of the
13287 &'Reply-To:'& header line if one exists and it is not empty, or otherwise the
13288 contents of the &'From:'& header line. Apart from the removal of leading
13289 white space, the value is not processed in any way. In particular, no RFC 2047
13290 decoding or character code translation takes place.
13291
13292 .vitem &$return_path$&
13293 .vindex "&$return_path$&"
13294 When a message is being delivered, this variable contains the return path &--
13295 the sender field that will be sent as part of the envelope. It is not enclosed
13296 in <> characters. At the start of routing an address, &$return_path$& has the
13297 same value as &$sender_address$&, but if, for example, an incoming message to a
13298 mailing list has been expanded by a router which specifies a different address
13299 for bounce messages, &$return_path$& subsequently contains the new bounce
13300 address, whereas &$sender_address$& always contains the original sender address
13301 that was received with the message. In other words, &$sender_address$& contains
13302 the incoming envelope sender, and &$return_path$& contains the outgoing
13303 envelope sender.
13304
13305 .vitem &$return_size_limit$&
13306 .vindex "&$return_size_limit$&"
13307 This is an obsolete name for &$bounce_return_size_limit$&.
13308
13309 .vitem &$router_name$&
13310 .cindex "router" "name"
13311 .cindex "name" "of router"
13312 .vindex "&$router_name$&"
13313 During the running of a router this variable contains its name.
13314
13315 .vitem &$runrc$&
13316 .cindex "return code" "from &%run%& expansion"
13317 .vindex "&$runrc$&"
13318 This variable contains the return code from a command that is run by the
13319 &%${run...}%& expansion item. &*Warning*&: In a router or transport, you cannot
13320 assume the order in which option values are expanded, except for those
13321 preconditions whose order of testing is documented. Therefore, you cannot
13322 reliably expect to set &$runrc$& by the expansion of one option, and use it in
13323 another.
13324
13325 .vitem &$self_hostname$&
13326 .oindex "&%self%&" "value of host name"
13327 .vindex "&$self_hostname$&"
13328 When an address is routed to a supposedly remote host that turns out to be the
13329 local host, what happens is controlled by the &%self%& generic router option.
13330 One of its values causes the address to be passed to another router. When this
13331 happens, &$self_hostname$& is set to the name of the local host that the
13332 original router encountered. In other circumstances its contents are null.
13333
13334 .vitem &$sender_address$&
13335 .vindex "&$sender_address$&"
13336 When a message is being processed, this variable contains the sender's address
13337 that was received in the message's envelope. The case of letters in the address
13338 is retained, in both the local part and the domain. For bounce messages, the
13339 value of this variable is the empty string. See also &$return_path$&.
13340
13341 .vitem &$sender_address_data$&
13342 .vindex "&$address_data$&"
13343 .vindex "&$sender_address_data$&"
13344 If &$address_data$& is set when the routers are called from an ACL to verify a
13345 sender address, the final value is preserved in &$sender_address_data$&, to
13346 distinguish it from data from a recipient address. The value does not persist
13347 after the end of the current ACL statement. If you want to preserve it for
13348 longer, you can save it in an ACL variable.
13349
13350 .vitem &$sender_address_domain$&
13351 .vindex "&$sender_address_domain$&"
13352 The domain portion of &$sender_address$&.
13353
13354 .vitem &$sender_address_local_part$&
13355 .vindex "&$sender_address_local_part$&"
13356 The local part portion of &$sender_address$&.
13357
13358 .vitem &$sender_data$&
13359 .vindex "&$sender_data$&"
13360 This variable is set after a lookup success in an ACL &%senders%& condition or
13361 in a router &%senders%& option. It contains the data from the lookup, and the
13362 value remains set until the next &%senders%& test. Thus, you can do things like
13363 this:
13364 .display
13365 &`require senders      = cdb*@;/some/file`&
13366 &`deny    `&&'some further test involving'& &`$sender_data`&
13367 .endd
13368 &*Warning*&: This variable is set only when a lookup is used as an indexing
13369 method in the address list, using the semicolon syntax as in the example above.
13370 The variable is not set for a lookup that is used as part of the string
13371 expansion that all such lists undergo before being interpreted.
13372
13373 .vitem &$sender_fullhost$&
13374 .vindex "&$sender_fullhost$&"
13375 When a message is received from a remote host, this variable contains the host
13376 name and IP address in a single string. It ends with the IP address in square
13377 brackets, followed by a colon and a port number if the logging of ports is
13378 enabled. The format of the rest of the string depends on whether the host
13379 issued a HELO or EHLO SMTP command, and whether the host name was verified by
13380 looking up its IP address. (Looking up the IP address can be forced by the
13381 &%host_lookup%& option, independent of verification.) A plain host name at the
13382 start of the string is a verified host name; if this is not present,
13383 verification either failed or was not requested. A host name in parentheses is
13384 the argument of a HELO or EHLO command. This is omitted if it is identical to
13385 the verified host name or to the host's IP address in square brackets.
13386
13387 .vitem &$sender_helo_dnssec$&
13388 .vindex "&$sender_helo_dnssec$&"
13389 This boolean variable is true if a successful HELO verification was
13390 .cindex "DNS" "DNSSEC"
13391 done using DNS information the resolver library stated was authenticated data.
13392
13393 .vitem &$sender_helo_name$&
13394 .vindex "&$sender_helo_name$&"
13395 When a message is received from a remote host that has issued a HELO or EHLO
13396 command, the argument of that command is placed in this variable. It is also
13397 set if HELO or EHLO is used when a message is received using SMTP locally via
13398 the &%-bs%& or &%-bS%& options.
13399
13400 .vitem &$sender_host_address$&
13401 .vindex "&$sender_host_address$&"
13402 When a message is received from a remote host using SMTP,
13403 this variable contains that
13404 host's IP address. For locally non-SMTP submitted messages, it is empty.
13405
13406 .vitem &$sender_host_authenticated$&
13407 .vindex "&$sender_host_authenticated$&"
13408 This variable contains the name (not the public name) of the authenticator
13409 driver that successfully authenticated the client from which the message was
13410 received. It is empty if there was no successful authentication. See also
13411 &$authenticated_id$&.
13412
13413 .vitem &$sender_host_dnssec$&
13414 .vindex "&$sender_host_dnssec$&"
13415 If an attempt to populate &$sender_host_name$& has been made
13416 (by reference, &%hosts_lookup%& or
13417 otherwise) then this boolean will have been set true if, and only if, the
13418 resolver library states that both
13419 the reverse and forward DNS were authenticated data.  At all
13420 other times, this variable is false.
13421
13422 .cindex "DNS" "DNSSEC"
13423 It is likely that you will need to coerce DNSSEC support on in the resolver
13424 library, by setting:
13425 .code
13426 dns_dnssec_ok = 1
13427 .endd
13428
13429 In addition, on Linux with glibc 2.31 or newer the resolver library will
13430 default to stripping out a successful validation status.
13431 This will break a previously working Exim installation.
13432 Provided that you do trust the resolver (ie, is on localhost) you can tell
13433 glibc to pass through any successful validation with a new option in
13434 &_/etc/resolv.conf_&:
13435 .code
13436 options trust-ad
13437 .endd
13438
13439 Exim does not perform DNSSEC validation itself, instead leaving that to a
13440 validating resolver (e.g. unbound, or bind with suitable configuration).
13441
13442 If you have changed &%host_lookup_order%& so that &`bydns`& is not the first
13443 mechanism in the list, then this variable will be false.
13444
13445 This requires that your system resolver library support EDNS0 (and that
13446 DNSSEC flags exist in the system headers).  If the resolver silently drops
13447 all EDNS0 options, then this will have no effect.  OpenBSD's asr resolver
13448 is known to currently ignore EDNS0, documented in CAVEATS of asr_run(3).
13449
13450
13451 .vitem &$sender_host_name$&
13452 .vindex "&$sender_host_name$&"
13453 When a message is received from a remote host, this variable contains the
13454 host's name as obtained by looking up its IP address. For messages received by
13455 other means, this variable is empty.
13456
13457 .vindex "&$host_lookup_failed$&"
13458 If the host name has not previously been looked up, a reference to
13459 &$sender_host_name$& triggers a lookup (for messages from remote hosts).
13460 A looked up name is accepted only if it leads back to the original IP address
13461 via a forward lookup. If either the reverse or the forward lookup fails to find
13462 any data, or if the forward lookup does not yield the original IP address,
13463 &$sender_host_name$& remains empty, and &$host_lookup_failed$& is set to &"1"&.
13464
13465 .vindex "&$host_lookup_deferred$&"
13466 However, if either of the lookups cannot be completed (for example, there is a
13467 DNS timeout), &$host_lookup_deferred$& is set to &"1"&, and
13468 &$host_lookup_failed$& remains set to &"0"&.
13469
13470 Once &$host_lookup_failed$& is set to &"1"&, Exim does not try to look up the
13471 host name again if there is a subsequent reference to &$sender_host_name$&
13472 in the same Exim process, but it does try again if &$host_lookup_deferred$&
13473 is set to &"1"&.
13474
13475 Exim does not automatically look up every calling host's name. If you want
13476 maximum efficiency, you should arrange your configuration so that it avoids
13477 these lookups altogether. The lookup happens only if one or more of the
13478 following are true:
13479
13480 .ilist
13481 A string containing &$sender_host_name$& is expanded.
13482 .next
13483 The calling host matches the list in &%host_lookup%&. In the default
13484 configuration, this option is set to *, so it must be changed if lookups are
13485 to be avoided. (In the code, the default for &%host_lookup%& is unset.)
13486 .next
13487 Exim needs the host name in order to test an item in a host list. The items
13488 that require this are described in sections &<<SECThoslispatnam>>& and
13489 &<<SECThoslispatnamsk>>&.
13490 .next
13491 The calling host matches &%helo_try_verify_hosts%& or &%helo_verify_hosts%&.
13492 In this case, the host name is required to compare with the name quoted in any
13493 EHLO or HELO commands that the client issues.
13494 .next
13495 The remote host issues a EHLO or HELO command that quotes one of the
13496 domains in &%helo_lookup_domains%&. The default value of this option is
13497 . ==== As this is a nested list, any displays it contains must be indented
13498 . ==== as otherwise they are too far to the left.
13499 .code
13500   helo_lookup_domains = @ : @[]
13501 .endd
13502 which causes a lookup if a remote host (incorrectly) gives the server's name or
13503 IP address in an EHLO or HELO command.
13504 .endlist
13505
13506
13507 .vitem &$sender_host_port$&
13508 .vindex "&$sender_host_port$&"
13509 When a message is received from a remote host, this variable contains the port
13510 number that was used on the remote host.
13511
13512 .vitem &$sender_ident$&
13513 .vindex "&$sender_ident$&"
13514 When a message is received from a remote host, this variable contains the
13515 identification received in response to an RFC 1413 request. When a message has
13516 been received locally, this variable contains the login name of the user that
13517 called Exim.
13518
13519 .vitem &$sender_rate_$&&'xxx'&
13520 A number of variables whose names begin &$sender_rate_$& are set as part of the
13521 &%ratelimit%& ACL condition. Details are given in section
13522 &<<SECTratelimiting>>&.
13523
13524 .vitem &$sender_rcvhost$&
13525 .cindex "DNS" "reverse lookup"
13526 .cindex "reverse DNS lookup"
13527 .vindex "&$sender_rcvhost$&"
13528 This is provided specifically for use in &'Received:'& headers. It starts with
13529 either the verified host name (as obtained from a reverse DNS lookup) or, if
13530 there is no verified host name, the IP address in square brackets. After that
13531 there may be text in parentheses. When the first item is a verified host name,
13532 the first thing in the parentheses is the IP address in square brackets,
13533 followed by a colon and a port number if port logging is enabled. When the
13534 first item is an IP address, the port is recorded as &"port=&'xxxx'&"& inside
13535 the parentheses.
13536
13537 There may also be items of the form &"helo=&'xxxx'&"& if HELO or EHLO
13538 was used and its argument was not identical to the real host name or IP
13539 address, and &"ident=&'xxxx'&"& if an RFC 1413 ident string is available. If
13540 all three items are present in the parentheses, a newline and tab are inserted
13541 into the string, to improve the formatting of the &'Received:'& header.
13542
13543 .vitem &$sender_verify_failure$&
13544 .vindex "&$sender_verify_failure$&"
13545 In an ACL, when a sender verification fails, this variable contains information
13546 about the failure. The details are the same as for
13547 &$recipient_verify_failure$&.
13548
13549 .vitem &$sending_ip_address$&
13550 .vindex "&$sending_ip_address$&"
13551 This variable is set whenever an outgoing SMTP connection to another host has
13552 been set up. It contains the IP address of the local interface that is being
13553 used. This is useful if a host that has more than one IP address wants to take
13554 on different personalities depending on which one is being used. For incoming
13555 connections, see &$received_ip_address$&.
13556
13557 .vitem &$sending_port$&
13558 .vindex "&$sending_port$&"
13559 This variable is set whenever an outgoing SMTP connection to another host has
13560 been set up. It contains the local port that is being used. For incoming
13561 connections, see &$received_port$&.
13562
13563 .vitem &$smtp_active_hostname$&
13564 .vindex "&$smtp_active_hostname$&"
13565 During an incoming SMTP session, this variable contains the value of the active
13566 host name, as specified by the &%smtp_active_hostname%& option. The value of
13567 &$smtp_active_hostname$& is saved with any message that is received, so its
13568 value can be consulted during routing and delivery.
13569
13570 .vitem &$smtp_command$&
13571 .vindex "&$smtp_command$&"
13572 During the processing of an incoming SMTP command, this variable contains the
13573 entire command. This makes it possible to distinguish between HELO and EHLO in
13574 the HELO ACL, and also to distinguish between commands such as these:
13575 .code
13576 MAIL FROM:<>
13577 MAIL FROM: <>
13578 .endd
13579 For a MAIL command, extra parameters such as SIZE can be inspected. For a RCPT
13580 command, the address in &$smtp_command$& is the original address before any
13581 rewriting, whereas the values in &$local_part$& and &$domain$& are taken from
13582 the address after SMTP-time rewriting.
13583
13584 .vitem &$smtp_command_argument$&
13585 .cindex "SMTP" "command, argument for"
13586 .vindex "&$smtp_command_argument$&"
13587 While an ACL is running to check an SMTP command, this variable contains the
13588 argument, that is, the text that follows the command name, with leading white
13589 space removed. Following the introduction of &$smtp_command$&, this variable is
13590 somewhat redundant, but is retained for backwards compatibility.
13591
13592 .vitem &$smtp_command_history$&
13593 .cindex SMTP "command history"
13594 .vindex "&$smtp_command_history$&"
13595 A comma-separated list (with no whitespace) of the most-recent SMTP commands
13596 received, in time-order left to right.  Only a limited number of commands
13597 are remembered.
13598
13599 .vitem &$smtp_count_at_connection_start$&
13600 .vindex "&$smtp_count_at_connection_start$&"
13601 This variable is set greater than zero only in processes spawned by the Exim
13602 daemon for handling incoming SMTP connections. The name is deliberately long,
13603 in order to emphasize what the contents are. When the daemon accepts a new
13604 connection, it increments this variable. A copy of the variable is passed to
13605 the child process that handles the connection, but its value is fixed, and
13606 never changes. It is only an approximation of how many incoming connections
13607 there actually are, because many other connections may come and go while a
13608 single connection is being processed. When a child process terminates, the
13609 daemon decrements its copy of the variable.
13610
13611 .vitem "&$sn0$& &-- &$sn9$&"
13612 These variables are copies of the values of the &$n0$& &-- &$n9$& accumulators
13613 that were current at the end of the system filter file. This allows a system
13614 filter file to set values that can be tested in users' filter files. For
13615 example, a system filter could set a value indicating how likely it is that a
13616 message is junk mail.
13617
13618 .vitem &$spam_$&&'xxx'&
13619 A number of variables whose names start with &$spam$& are available when Exim
13620 is compiled with the content-scanning extension. For details, see section
13621 &<<SECTscanspamass>>&.
13622
13623 .vitem &$spf_header_comment$& &&&
13624        &$spf_received$& &&&
13625        &$spf_result$& &&&
13626        &$spf_result_guessed$& &&&
13627        &$spf_smtp_comment$&
13628 These variables are only available if Exim is built with SPF support.
13629 For details see section &<<SECSPF>>&.
13630
13631 .vitem &$spool_directory$&
13632 .vindex "&$spool_directory$&"
13633 The name of Exim's spool directory.
13634
13635 .vitem &$spool_inodes$&
13636 .vindex "&$spool_inodes$&"
13637 The number of free inodes in the disk partition where Exim's spool files are
13638 being written. The value is recalculated whenever the variable is referenced.
13639 If the relevant file system does not have the concept of inodes, the value of
13640 is -1. See also the &%check_spool_inodes%& option.
13641
13642 .vitem &$spool_space$&
13643 .vindex "&$spool_space$&"
13644 The amount of free space (as a number of kilobytes) in the disk partition where
13645 Exim's spool files are being written. The value is recalculated whenever the
13646 variable is referenced. If the operating system does not have the ability to
13647 find the amount of free space (only true for experimental systems), the space
13648 value is -1. For example, to check in an ACL that there is at least 50
13649 megabytes free on the spool, you could write:
13650 .code
13651 condition = ${if > {$spool_space}{50000}}
13652 .endd
13653 See also the &%check_spool_space%& option.
13654
13655
13656 .vitem &$thisaddress$&
13657 .vindex "&$thisaddress$&"
13658 This variable is set only during the processing of the &%foranyaddress%&
13659 command in a filter file. Its use is explained in the description of that
13660 command, which can be found in the separate document entitled &'Exim's
13661 interfaces to mail filtering'&.
13662
13663 .vitem &$tls_in_bits$&
13664 .vindex "&$tls_in_bits$&"
13665 Contains an approximation of the TLS cipher's bit-strength
13666 on the inbound connection; the meaning of
13667 this depends upon the TLS implementation used.
13668 If TLS has not been negotiated, the value will be 0.
13669 The value of this is automatically fed into the Cyrus SASL authenticator
13670 when acting as a server, to specify the "external SSF" (a SASL term).
13671
13672 The deprecated &$tls_bits$& variable refers to the inbound side
13673 except when used in the context of an outbound SMTP delivery, when it refers to
13674 the outbound.
13675
13676 .vitem &$tls_out_bits$&
13677 .vindex "&$tls_out_bits$&"
13678 Contains an approximation of the TLS cipher's bit-strength
13679 on an outbound SMTP connection; the meaning of
13680 this depends upon the TLS implementation used.
13681 If TLS has not been negotiated, the value will be 0.
13682
13683 .vitem &$tls_in_ourcert$&
13684 .vindex "&$tls_in_ourcert$&"
13685 .cindex certificate variables
13686 This variable refers to the certificate presented to the peer of an
13687 inbound connection when the message was received.
13688 It is only useful as the argument of a
13689 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13690 or a &%def%& condition.
13691
13692 &*Note*&: Under versions of OpenSSL preceding 1.1.1,
13693 when a list of more than one
13694 file is used for &%tls_certificate%&, this variable is not reliable.
13695 The macro "_TLS_BAD_MULTICERT_IN_OURCERT" will be defined for those versions.
13696
13697 .vitem &$tls_in_peercert$&
13698 .vindex "&$tls_in_peercert$&"
13699 This variable refers to the certificate presented by the peer of an
13700 inbound connection when the message was received.
13701 It is only useful as the argument of a
13702 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13703 or a &%def%& condition.
13704 If certificate verification fails it may refer to a failing chain element
13705 which is not the leaf.
13706
13707 .vitem &$tls_out_ourcert$&
13708 .vindex "&$tls_out_ourcert$&"
13709 This variable refers to the certificate presented to the peer of an
13710 outbound connection.  It is only useful as the argument of a
13711 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13712 or a &%def%& condition.
13713
13714 .vitem &$tls_out_peercert$&
13715 .vindex "&$tls_out_peercert$&"
13716 This variable refers to the certificate presented by the peer of an
13717 outbound connection.  It is only useful as the argument of a
13718 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13719 or a &%def%& condition.
13720 If certificate verification fails it may refer to a failing chain element
13721 which is not the leaf.
13722
13723 .vitem &$tls_in_certificate_verified$&
13724 .vindex "&$tls_in_certificate_verified$&"
13725 This variable is set to &"1"& if a TLS certificate was verified when the
13726 message was received, and &"0"& otherwise.
13727
13728 The deprecated &$tls_certificate_verified$& variable refers to the inbound side
13729 except when used in the context of an outbound SMTP delivery, when it refers to
13730 the outbound.
13731
13732 .vitem &$tls_out_certificate_verified$&
13733 .vindex "&$tls_out_certificate_verified$&"
13734 This variable is set to &"1"& if a TLS certificate was verified when an
13735 outbound SMTP connection was made,
13736 and &"0"& otherwise.
13737
13738 .vitem &$tls_in_cipher$&
13739 .vindex "&$tls_in_cipher$&"
13740 .vindex "&$tls_cipher$&"
13741 When a message is received from a remote host over an encrypted SMTP
13742 connection, this variable is set to the cipher suite that was negotiated, for
13743 example DES-CBC3-SHA. In other circumstances, in particular, for message
13744 received over unencrypted connections, the variable is empty. Testing
13745 &$tls_in_cipher$& for emptiness is one way of distinguishing between encrypted and
13746 non-encrypted connections during ACL processing.
13747
13748 The deprecated &$tls_cipher$& variable is the same as &$tls_in_cipher$& during message reception,
13749 but in the context of an outward SMTP delivery taking place via the &(smtp)& transport
13750 becomes the same as &$tls_out_cipher$&.
13751
13752 .vitem &$tls_in_cipher_std$&
13753 .vindex "&$tls_in_cipher_std$&"
13754 As above, but returning the RFC standard name for the cipher suite.
13755
13756 .vitem &$tls_out_cipher$&
13757 .vindex "&$tls_out_cipher$&"
13758 This variable is
13759 cleared before any outgoing SMTP connection is made,
13760 and then set to the outgoing cipher suite if one is negotiated. See chapter
13761 &<<CHAPTLS>>& for details of TLS support and chapter &<<CHAPsmtptrans>>& for
13762 details of the &(smtp)& transport.
13763
13764 .vitem &$tls_out_cipher_std$&
13765 .vindex "&$tls_out_cipher_std$&"
13766 As above, but returning the RFC standard name for the cipher suite.
13767
13768 .vitem &$tls_out_dane$&
13769 .vindex &$tls_out_dane$&
13770 DANE active status.  See section &<<SECDANE>>&.
13771
13772 .vitem &$tls_in_ocsp$&
13773 .vindex "&$tls_in_ocsp$&"
13774 When a message is received from a remote client connection
13775 the result of any OCSP request from the client is encoded in this variable:
13776 .code
13777 0 OCSP proof was not requested (default value)
13778 1 No response to request
13779 2 Response not verified
13780 3 Verification failed
13781 4 Verification succeeded
13782 .endd
13783
13784 .vitem &$tls_out_ocsp$&
13785 .vindex "&$tls_out_ocsp$&"
13786 When a message is sent to a remote host connection
13787 the result of any OCSP request made is encoded in this variable.
13788 See &$tls_in_ocsp$& for values.
13789
13790 .vitem &$tls_in_peerdn$&
13791 .vindex "&$tls_in_peerdn$&"
13792 .vindex "&$tls_peerdn$&"
13793 .cindex certificate "extracting fields"
13794 When a message is received from a remote host over an encrypted SMTP
13795 connection, and Exim is configured to request a certificate from the client,
13796 the value of the Distinguished Name of the certificate is made available in the
13797 &$tls_in_peerdn$& during subsequent processing.
13798 If certificate verification fails it may refer to a failing chain element
13799 which is not the leaf.
13800
13801 The deprecated &$tls_peerdn$& variable refers to the inbound side
13802 except when used in the context of an outbound SMTP delivery, when it refers to
13803 the outbound.
13804
13805 .vitem &$tls_out_peerdn$&
13806 .vindex "&$tls_out_peerdn$&"
13807 When a message is being delivered to a remote host over an encrypted SMTP
13808 connection, and Exim is configured to request a certificate from the server,
13809 the value of the Distinguished Name of the certificate is made available in the
13810 &$tls_out_peerdn$& during subsequent processing.
13811 If certificate verification fails it may refer to a failing chain element
13812 which is not the leaf.
13813
13814
13815 .new
13816 .vitem &$tls_in_resumption$& &&&
13817        &$tls_out_resumption$&
13818 .vindex &$tls_in_resumption$&
13819 .vindex &$tls_out_resumption$&
13820 .cindex TLS resumption
13821 Observability for TLS session resumption.  See &<<SECTresumption>>& for details.
13822 .wen
13823
13824
13825 .vitem &$tls_in_sni$&
13826 .vindex "&$tls_in_sni$&"
13827 .vindex "&$tls_sni$&"
13828 .cindex "TLS" "Server Name Indication"
13829 .cindex "TLS" SNI
13830 .cindex SNI "observability on server"
13831 When a TLS session is being established, if the client sends the Server
13832 Name Indication extension, the value will be placed in this variable.
13833 If the variable appears in &%tls_certificate%& then this option and
13834 some others, described in &<<SECTtlssni>>&,
13835 will be re-expanded early in the TLS session, to permit
13836 a different certificate to be presented (and optionally a different key to be
13837 used) to the client, based upon the value of the SNI extension.
13838
13839 The deprecated &$tls_sni$& variable refers to the inbound side
13840 except when used in the context of an outbound SMTP delivery, when it refers to
13841 the outbound.
13842
13843 .vitem &$tls_out_sni$&
13844 .vindex "&$tls_out_sni$&"
13845 .cindex "TLS" "Server Name Indication"
13846 .cindex "TLS" SNI
13847 .cindex SNI "observability in client"
13848 During outbound
13849 SMTP deliveries, this variable reflects the value of the &%tls_sni%& option on
13850 the transport.
13851
13852 .vitem &$tls_out_tlsa_usage$&
13853 .vindex &$tls_out_tlsa_usage$&
13854 Bitfield of TLSA record types found.  See section &<<SECDANE>>&.
13855
13856 .vitem &$tls_in_ver$&
13857 .vindex "&$tls_in_ver$&"
13858 When a message is received from a remote host over an encrypted SMTP connection
13859 this variable is set to the protocol version, eg &'TLS1.2'&.
13860
13861 .vitem &$tls_out_ver$&
13862 .vindex "&$tls_out_ver$&"
13863 When a message is being delivered to a remote host over an encrypted SMTP connection
13864 this variable is set to the protocol version.
13865
13866
13867 .vitem &$tod_bsdinbox$&
13868 .vindex "&$tod_bsdinbox$&"
13869 The time of day and the date, in the format required for BSD-style mailbox
13870 files, for example: Thu Oct 17 17:14:09 1995.
13871
13872 .vitem &$tod_epoch$&
13873 .vindex "&$tod_epoch$&"
13874 The time and date as a number of seconds since the start of the Unix epoch.
13875
13876 .vitem &$tod_epoch_l$&
13877 .vindex "&$tod_epoch_l$&"
13878 The time and date as a number of microseconds since the start of the Unix epoch.
13879
13880 .vitem &$tod_full$&
13881 .vindex "&$tod_full$&"
13882 A full version of the time and date, for example: Wed, 16 Oct 1995 09:51:40
13883 +0100. The timezone is always given as a numerical offset from UTC, with
13884 positive values used for timezones that are ahead (east) of UTC, and negative
13885 values for those that are behind (west).
13886
13887 .vitem &$tod_log$&
13888 .vindex "&$tod_log$&"
13889 The time and date in the format used for writing Exim's log files, for example:
13890 1995-10-12 15:32:29, but without a timezone.
13891
13892 .vitem &$tod_logfile$&
13893 .vindex "&$tod_logfile$&"
13894 This variable contains the date in the format yyyymmdd. This is the format that
13895 is used for datestamping log files when &%log_file_path%& contains the &`%D`&
13896 flag.
13897
13898 .vitem &$tod_zone$&
13899 .vindex "&$tod_zone$&"
13900 This variable contains the numerical value of the local timezone, for example:
13901 -0500.
13902
13903 .vitem &$tod_zulu$&
13904 .vindex "&$tod_zulu$&"
13905 This variable contains the UTC date and time in &"Zulu"& format, as specified
13906 by ISO 8601, for example: 20030221154023Z.
13907
13908 .vitem &$transport_name$&
13909 .cindex "transport" "name"
13910 .cindex "name" "of transport"
13911 .vindex "&$transport_name$&"
13912 During the running of a transport, this variable contains its name.
13913
13914 .vitem &$value$&
13915 .vindex "&$value$&"
13916 This variable contains the result of an expansion lookup, extraction operation,
13917 or external command, as described above. It is also used during a
13918 &*reduce*& expansion.
13919
13920 .vitem &$verify_mode$&
13921 .vindex "&$verify_mode$&"
13922 While a router or transport is being run in verify mode or for cutthrough delivery,
13923 contains "S" for sender-verification or "R" for recipient-verification.
13924 Otherwise, empty.
13925
13926 .vitem &$version_number$&
13927 .vindex "&$version_number$&"
13928 The version number of Exim. Same as &$exim_version$&, may be overridden
13929 by the &%exim_version%& main config option.
13930
13931 .vitem &$warn_message_delay$&
13932 .vindex "&$warn_message_delay$&"
13933 This variable is set only during the creation of a message warning about a
13934 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
13935
13936 .vitem &$warn_message_recipients$&
13937 .vindex "&$warn_message_recipients$&"
13938 This variable is set only during the creation of a message warning about a
13939 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
13940 .endlist
13941 .ecindex IIDstrexp
13942
13943
13944
13945 . ////////////////////////////////////////////////////////////////////////////
13946 . ////////////////////////////////////////////////////////////////////////////
13947
13948 .chapter "Embedded Perl" "CHAPperl"
13949 .scindex IIDperl "Perl" "calling from Exim"
13950 Exim can be built to include an embedded Perl interpreter. When this is done,
13951 Perl subroutines can be called as part of the string expansion process. To make
13952 use of the Perl support, you need version 5.004 or later of Perl installed on
13953 your system. To include the embedded interpreter in the Exim binary, include
13954 the line
13955 .code
13956 EXIM_PERL = perl.o
13957 .endd
13958 in your &_Local/Makefile_& and then build Exim in the normal way.
13959
13960
13961 .section "Setting up so Perl can be used" "SECID85"
13962 .oindex "&%perl_startup%&"
13963 Access to Perl subroutines is via a global configuration option called
13964 &%perl_startup%& and an expansion string operator &%${perl ...}%&. If there is
13965 no &%perl_startup%& option in the Exim configuration file then no Perl
13966 interpreter is started and there is almost no overhead for Exim (since none of
13967 the Perl library will be paged in unless used). If there is a &%perl_startup%&
13968 option then the associated value is taken to be Perl code which is executed in
13969 a newly created Perl interpreter.
13970
13971 The value of &%perl_startup%& is not expanded in the Exim sense, so you do not
13972 need backslashes before any characters to escape special meanings. The option
13973 should usually be something like
13974 .code
13975 perl_startup = do '/etc/exim.pl'
13976 .endd
13977 where &_/etc/exim.pl_& is Perl code which defines any subroutines you want to
13978 use from Exim. Exim can be configured either to start up a Perl interpreter as
13979 soon as it is entered, or to wait until the first time it is needed. Starting
13980 the interpreter at the beginning ensures that it is done while Exim still has
13981 its setuid privilege, but can impose an unnecessary overhead if Perl is not in
13982 fact used in a particular run. Also, note that this does not mean that Exim is
13983 necessarily running as root when Perl is called at a later time. By default,
13984 the interpreter is started only when it is needed, but this can be changed in
13985 two ways:
13986
13987 .ilist
13988 .oindex "&%perl_at_start%&"
13989 Setting &%perl_at_start%& (a boolean option) in the configuration requests
13990 a startup when Exim is entered.
13991 .next
13992 The command line option &%-ps%& also requests a startup when Exim is entered,
13993 overriding the setting of &%perl_at_start%&.
13994 .endlist
13995
13996 There is also a command line option &%-pd%& (for delay) which suppresses the
13997 initial startup, even if &%perl_at_start%& is set.
13998
13999 .ilist
14000 .oindex "&%perl_taintmode%&"
14001 .cindex "Perl" "taintmode"
14002 To provide more security executing Perl code via the embedded Perl
14003 interpreter, the &%perl_taintmode%& option can be set. This enables the
14004 taint mode of the Perl interpreter. You are encouraged to set this
14005 option to a true value. To avoid breaking existing installations, it
14006 defaults to false.
14007
14008
14009 .section "Calling Perl subroutines" "SECID86"
14010 When the configuration file includes a &%perl_startup%& option you can make use
14011 of the string expansion item to call the Perl subroutines that are defined
14012 by the &%perl_startup%& code. The operator is used in any of the following
14013 forms:
14014 .code
14015 ${perl{foo}}
14016 ${perl{foo}{argument}}
14017 ${perl{foo}{argument1}{argument2} ... }
14018 .endd
14019 which calls the subroutine &%foo%& with the given arguments. A maximum of eight
14020 arguments may be passed. Passing more than this results in an expansion failure
14021 with an error message of the form
14022 .code
14023 Too many arguments passed to Perl subroutine "foo" (max is 8)
14024 .endd
14025 The return value of the Perl subroutine is evaluated in a scalar context before
14026 it is passed back to Exim to be inserted into the expanded string. If the
14027 return value is &'undef'&, the expansion is forced to fail in the same way as
14028 an explicit &"fail"& on an &%if%& or &%lookup%& item. If the subroutine aborts
14029 by obeying Perl's &%die%& function, the expansion fails with the error message
14030 that was passed to &%die%&.
14031
14032
14033 .section "Calling Exim functions from Perl" "SECID87"
14034 Within any Perl code called from Exim, the function &'Exim::expand_string()'&
14035 is available to call back into Exim's string expansion function. For example,
14036 the Perl code
14037 .code
14038 my $lp = Exim::expand_string('$local_part');
14039 .endd
14040 makes the current Exim &$local_part$& available in the Perl variable &$lp$&.
14041 Note those are single quotes and not double quotes to protect against
14042 &$local_part$& being interpolated as a Perl variable.
14043
14044 If the string expansion is forced to fail by a &"fail"& item, the result of
14045 &'Exim::expand_string()'& is &%undef%&. If there is a syntax error in the
14046 expansion string, the Perl call from the original expansion string fails with
14047 an appropriate error message, in the same way as if &%die%& were used.
14048
14049 .cindex "debugging" "from embedded Perl"
14050 .cindex "log" "writing from embedded Perl"
14051 Two other Exim functions are available for use from within Perl code.
14052 &'Exim::debug_write()'& writes a string to the standard error stream if Exim's
14053 debugging is enabled. If you want a newline at the end, you must supply it.
14054 &'Exim::log_write()'& writes a string to Exim's main log, adding a leading
14055 timestamp. In this case, you should not supply a terminating newline.
14056
14057
14058 .section "Use of standard output and error by Perl" "SECID88"
14059 .cindex "Perl" "standard output and error"
14060 You should not write to the standard error or output streams from within your
14061 Perl code, as it is not defined how these are set up. In versions of Exim
14062 before 4.50, it is possible for the standard output or error to refer to the
14063 SMTP connection during message reception via the daemon. Writing to this stream
14064 is certain to cause chaos. From Exim 4.50 onwards, the standard output and
14065 error streams are connected to &_/dev/null_& in the daemon. The chaos is
14066 avoided, but the output is lost.
14067
14068 .cindex "Perl" "use of &%warn%&"
14069 The Perl &%warn%& statement writes to the standard error stream by default.
14070 Calls to &%warn%& may be embedded in Perl modules that you use, but over which
14071 you have no control. When Exim starts up the Perl interpreter, it arranges for
14072 output from the &%warn%& statement to be written to the Exim main log. You can
14073 change this by including appropriate Perl magic somewhere in your Perl code.
14074 For example, to discard &%warn%& output completely, you need this:
14075 .code
14076 $SIG{__WARN__} = sub { };
14077 .endd
14078 Whenever a &%warn%& is obeyed, the anonymous subroutine is called. In this
14079 example, the code for the subroutine is empty, so it does nothing, but you can
14080 include any Perl code that you like. The text of the &%warn%& message is passed
14081 as the first subroutine argument.
14082 .ecindex IIDperl
14083
14084
14085 . ////////////////////////////////////////////////////////////////////////////
14086 . ////////////////////////////////////////////////////////////////////////////
14087
14088 .chapter "Starting the daemon and the use of network interfaces" &&&
14089          "CHAPinterfaces" &&&
14090          "Starting the daemon"
14091 .cindex "daemon" "starting"
14092 .cindex "interface" "listening"
14093 .cindex "network interface"
14094 .cindex "interface" "network"
14095 .cindex "IP address" "for listening"
14096 .cindex "daemon" "listening IP addresses"
14097 .cindex "TCP/IP" "setting listening interfaces"
14098 .cindex "TCP/IP" "setting listening ports"
14099 A host that is connected to a TCP/IP network may have one or more physical
14100 hardware network interfaces. Each of these interfaces may be configured as one
14101 or more &"logical"& interfaces, which are the entities that a program actually
14102 works with. Each of these logical interfaces is associated with an IP address.
14103 In addition, TCP/IP software supports &"loopback"& interfaces (127.0.0.1 in
14104 IPv4 and ::1 in IPv6), which do not use any physical hardware. Exim requires
14105 knowledge about the host's interfaces for use in three different circumstances:
14106
14107 .olist
14108 When a listening daemon is started, Exim needs to know which interfaces
14109 and ports to listen on.
14110 .next
14111 When Exim is routing an address, it needs to know which IP addresses
14112 are associated with local interfaces. This is required for the correct
14113 processing of MX lists by removing the local host and others with the
14114 same or higher priority values. Also, Exim needs to detect cases
14115 when an address is routed to an IP address that in fact belongs to the
14116 local host. Unless the &%self%& router option or the &%allow_localhost%&
14117 option of the smtp transport is set (as appropriate), this is treated
14118 as an error situation.
14119 .next
14120 When Exim connects to a remote host, it may need to know which interface to use
14121 for the outgoing connection.
14122 .endlist
14123
14124
14125 Exim's default behaviour is likely to be appropriate in the vast majority
14126 of cases. If your host has only one interface, and you want all its IP
14127 addresses to be treated in the same way, and you are using only the
14128 standard SMTP port, you should not need to take any special action. The
14129 rest of this chapter does not apply to you.
14130
14131 In a more complicated situation you may want to listen only on certain
14132 interfaces, or on different ports, and for this reason there are a number of
14133 options that can be used to influence Exim's behaviour. The rest of this
14134 chapter describes how they operate.
14135
14136 When a message is received over TCP/IP, the interface and port that were
14137 actually used are set in &$received_ip_address$& and &$received_port$&.
14138
14139
14140
14141 .section "Starting a listening daemon" "SECID89"
14142 When a listening daemon is started (by means of the &%-bd%& command line
14143 option), the interfaces and ports on which it listens are controlled by the
14144 following options:
14145
14146 .ilist
14147 &%daemon_smtp_ports%& contains a list of default ports
14148 or service names.
14149 (For backward compatibility, this option can also be specified in the singular.)
14150 .next
14151 &%local_interfaces%& contains list of interface IP addresses on which to
14152 listen. Each item may optionally also specify a port.
14153 .endlist
14154
14155 The default list separator in both cases is a colon, but this can be changed as
14156 described in section &<<SECTlistsepchange>>&. When IPv6 addresses are involved,
14157 it is usually best to change the separator to avoid having to double all the
14158 colons. For example:
14159 .code
14160 local_interfaces = <; 127.0.0.1 ; \
14161                       192.168.23.65 ; \
14162                       ::1 ; \
14163                       3ffe:ffff:836f::fe86:a061
14164 .endd
14165 There are two different formats for specifying a port along with an IP address
14166 in &%local_interfaces%&:
14167
14168 .olist
14169 The port is added onto the address with a dot separator. For example, to listen
14170 on port 1234 on two different IP addresses:
14171 .code
14172 local_interfaces = <; 192.168.23.65.1234 ; \
14173                       3ffe:ffff:836f::fe86:a061.1234
14174 .endd
14175 .next
14176 The IP address is enclosed in square brackets, and the port is added
14177 with a colon separator, for example:
14178 .code
14179 local_interfaces = <; [192.168.23.65]:1234 ; \
14180                       [3ffe:ffff:836f::fe86:a061]:1234
14181 .endd
14182 .endlist
14183
14184 When a port is not specified, the value of &%daemon_smtp_ports%& is used. The
14185 default setting contains just one port:
14186 .code
14187 daemon_smtp_ports = smtp
14188 .endd
14189 If more than one port is listed, each interface that does not have its own port
14190 specified listens on all of them. Ports that are listed in
14191 &%daemon_smtp_ports%& can be identified either by name (defined in
14192 &_/etc/services_&) or by number. However, when ports are given with individual
14193 IP addresses in &%local_interfaces%&, only numbers (not names) can be used.
14194
14195
14196
14197 .section "Special IP listening addresses" "SECID90"
14198 The addresses 0.0.0.0 and ::0 are treated specially. They are interpreted
14199 as &"all IPv4 interfaces"& and &"all IPv6 interfaces"&, respectively. In each
14200 case, Exim tells the TCP/IP stack to &"listen on all IPv&'x'& interfaces"&
14201 instead of setting up separate listening sockets for each interface. The
14202 default value of &%local_interfaces%& is
14203 .code
14204 local_interfaces = 0.0.0.0
14205 .endd
14206 when Exim is built without IPv6 support; otherwise it is:
14207 .code
14208 local_interfaces = <; ::0 ; 0.0.0.0
14209 .endd
14210 Thus, by default, Exim listens on all available interfaces, on the SMTP port.
14211
14212
14213
14214 .section "Overriding local_interfaces and daemon_smtp_ports" "SECID91"
14215 The &%-oX%& command line option can be used to override the values of
14216 &%daemon_smtp_ports%& and/or &%local_interfaces%& for a particular daemon
14217 instance. Another way of doing this would be to use macros and the &%-D%&
14218 option. However, &%-oX%& can be used by any admin user, whereas modification of
14219 the runtime configuration by &%-D%& is allowed only when the caller is root or
14220 exim.
14221
14222 The value of &%-oX%& is a list of items. The default colon separator can be
14223 changed in the usual way (&<<SECTlistsepchange>>&) if required.
14224 If there are any items that do not
14225 contain dots or colons (that is, are not IP addresses), the value of
14226 &%daemon_smtp_ports%& is replaced by the list of those items. If there are any
14227 items that do contain dots or colons, the value of &%local_interfaces%& is
14228 replaced by those items. Thus, for example,
14229 .code
14230 -oX 1225
14231 .endd
14232 overrides &%daemon_smtp_ports%&, but leaves &%local_interfaces%& unchanged,
14233 whereas
14234 .code
14235 -oX 192.168.34.5.1125
14236 .endd
14237 overrides &%local_interfaces%&, leaving &%daemon_smtp_ports%& unchanged.
14238 (However, since &%local_interfaces%& now contains no items without ports, the
14239 value of &%daemon_smtp_ports%& is no longer relevant in this example.)
14240
14241
14242
14243 .section "Support for the submissions (aka SSMTP or SMTPS) protocol" "SECTsupobssmt"
14244 .cindex "submissions protocol"
14245 .cindex "ssmtp protocol"
14246 .cindex "smtps protocol"
14247 .cindex "SMTP" "ssmtp protocol"
14248 .cindex "SMTP" "smtps protocol"
14249 Exim supports the use of TLS-on-connect, used by mail clients in the
14250 &"submissions"& protocol, historically also known as SMTPS or SSMTP.
14251 For some years, IETF Standards Track documents only blessed the
14252 STARTTLS-based Submission service (port 587) while common practice was to support
14253 the same feature set on port 465, but using TLS-on-connect.
14254 If your installation needs to provide service to mail clients
14255 (Mail User Agents, MUAs) then you should provide service on both the 587 and
14256 the 465 TCP ports.
14257
14258 If the &%tls_on_connect_ports%& option is set to a list of port numbers or
14259 service names, connections to those ports must first establish TLS, before
14260 proceeding to the application layer use of the SMTP protocol.
14261
14262 The common use of this option is expected to be
14263 .code
14264 tls_on_connect_ports = 465
14265 .endd
14266 per RFC 8314.
14267 There is also a command line option &%-tls-on-connect%&, which forces all ports
14268 to behave in this way when a daemon is started.
14269
14270 &*Warning*&: Setting &%tls_on_connect_ports%& does not of itself cause the
14271 daemon to listen on those ports. You must still specify them in
14272 &%daemon_smtp_ports%&, &%local_interfaces%&, or the &%-oX%& option. (This is
14273 because &%tls_on_connect_ports%& applies to &%inetd%& connections as well as to
14274 connections via the daemon.)
14275
14276
14277
14278
14279 .section "IPv6 address scopes" "SECID92"
14280 .cindex "IPv6" "address scopes"
14281 IPv6 addresses have &"scopes"&, and a host with multiple hardware interfaces
14282 can, in principle, have the same link-local IPv6 address on different
14283 interfaces. Thus, additional information is needed, over and above the IP
14284 address, to distinguish individual interfaces. A convention of using a
14285 percent sign followed by something (often the interface name) has been
14286 adopted in some cases, leading to addresses like this:
14287 .code
14288 fe80::202:b3ff:fe03:45c1%eth0
14289 .endd
14290 To accommodate this usage, a percent sign followed by an arbitrary string is
14291 allowed at the end of an IPv6 address. By default, Exim calls &[getaddrinfo()]&
14292 to convert a textual IPv6 address for actual use. This function recognizes the
14293 percent convention in operating systems that support it, and it processes the
14294 address appropriately. Unfortunately, some older libraries have problems with
14295 &[getaddrinfo()]&. If
14296 .code
14297 IPV6_USE_INET_PTON=yes
14298 .endd
14299 is set in &_Local/Makefile_& (or an OS-dependent Makefile) when Exim is built,
14300 Exim uses &'inet_pton()'& to convert a textual IPv6 address for actual use,
14301 instead of &[getaddrinfo()]&. (Before version 4.14, it always used this
14302 function.) Of course, this means that the additional functionality of
14303 &[getaddrinfo()]& &-- recognizing scoped addresses &-- is lost.
14304
14305 .section "Disabling IPv6" "SECID93"
14306 .cindex "IPv6" "disabling"
14307 Sometimes it happens that an Exim binary that was compiled with IPv6 support is
14308 run on a host whose kernel does not support IPv6. The binary will fall back to
14309 using IPv4, but it may waste resources looking up AAAA records, and trying to
14310 connect to IPv6 addresses, causing delays to mail delivery. If you set the
14311 .oindex "&%disable_ipv6%&"
14312 &%disable_ipv6%& option true, even if the Exim binary has IPv6 support, no IPv6
14313 activities take place. AAAA records are never looked up, and any IPv6 addresses
14314 that are listed in &%local_interfaces%&, data for the &(manualroute)& router,
14315 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
14316 to handle IPv6 literal addresses.
14317
14318 On the other hand, when IPv6 is in use, there may be times when you want to
14319 disable it for certain hosts or domains. You can use the &%dns_ipv4_lookup%&
14320 option to globally suppress the lookup of AAAA records for specified domains,
14321 and you can use the &%ignore_target_hosts%& generic router option to ignore
14322 IPv6 addresses in an individual router.
14323
14324
14325
14326 .section "Examples of starting a listening daemon" "SECID94"
14327 The default case in an IPv6 environment is
14328 .code
14329 daemon_smtp_ports = smtp
14330 local_interfaces = <; ::0 ; 0.0.0.0
14331 .endd
14332 This specifies listening on the smtp port on all IPv6 and IPv4 interfaces.
14333 Either one or two sockets may be used, depending on the characteristics of
14334 the TCP/IP stack. (This is complicated and messy; for more information,
14335 read the comments in the &_daemon.c_& source file.)
14336
14337 To specify listening on ports 25 and 26 on all interfaces:
14338 .code
14339 daemon_smtp_ports = 25 : 26
14340 .endd
14341 (leaving &%local_interfaces%& at the default setting) or, more explicitly:
14342 .code
14343 local_interfaces = <; ::0.25     ; ::0.26 \
14344                       0.0.0.0.25 ; 0.0.0.0.26
14345 .endd
14346 To listen on the default port on all IPv4 interfaces, and on port 26 on the
14347 IPv4 loopback address only:
14348 .code
14349 local_interfaces = 0.0.0.0 : 127.0.0.1.26
14350 .endd
14351 To specify listening on the default port on specific interfaces only:
14352 .code
14353 local_interfaces = 10.0.0.67 : 192.168.34.67
14354 .endd
14355 &*Warning*&: Such a setting excludes listening on the loopback interfaces.
14356
14357
14358
14359 .section "Recognizing the local host" "SECTreclocipadd"
14360 The &%local_interfaces%& option is also used when Exim needs to determine
14361 whether or not an IP address refers to the local host. That is, the IP
14362 addresses of all the interfaces on which a daemon is listening are always
14363 treated as local.
14364
14365 For this usage, port numbers in &%local_interfaces%& are ignored. If either of
14366 the items 0.0.0.0 or ::0 are encountered, Exim gets a complete list of
14367 available interfaces from the operating system, and extracts the relevant
14368 (that is, IPv4 or IPv6) addresses to use for checking.
14369
14370 Some systems set up large numbers of virtual interfaces in order to provide
14371 many virtual web servers. In this situation, you may want to listen for
14372 email on only a few of the available interfaces, but nevertheless treat all
14373 interfaces as local when routing. You can do this by setting
14374 &%extra_local_interfaces%& to a list of IP addresses, possibly including the
14375 &"all"& wildcard values. These addresses are recognized as local, but are not
14376 used for listening. Consider this example:
14377 .code
14378 local_interfaces = <; 127.0.0.1 ; ::1 ; \
14379                       192.168.53.235 ; \
14380                       3ffe:2101:12:1:a00:20ff:fe86:a061
14381
14382 extra_local_interfaces = <; ::0 ; 0.0.0.0
14383 .endd
14384 The daemon listens on the loopback interfaces and just one IPv4 and one IPv6
14385 address, but all available interface addresses are treated as local when
14386 Exim is routing.
14387
14388 In some environments the local host name may be in an MX list, but with an IP
14389 address that is not assigned to any local interface. In other cases it may be
14390 desirable to treat other host names as if they referred to the local host. Both
14391 these cases can be handled by setting the &%hosts_treat_as_local%& option.
14392 This contains host names rather than IP addresses. When a host is referenced
14393 during routing, either via an MX record or directly, it is treated as the local
14394 host if its name matches &%hosts_treat_as_local%&, or if any of its IP
14395 addresses match &%local_interfaces%& or &%extra_local_interfaces%&.
14396
14397
14398
14399 .section "Delivering to a remote host" "SECID95"
14400 Delivery to a remote host is handled by the smtp transport. By default, it
14401 allows the system's TCP/IP functions to choose which interface to use (if
14402 there is more than one) when connecting to a remote host. However, the
14403 &%interface%& option can be set to specify which interface is used. See the
14404 description of the smtp transport in chapter &<<CHAPsmtptrans>>& for more
14405 details.
14406
14407
14408
14409
14410 . ////////////////////////////////////////////////////////////////////////////
14411 . ////////////////////////////////////////////////////////////////////////////
14412
14413 .chapter "Main configuration" "CHAPmainconfig"
14414 .scindex IIDconfima "configuration file" "main section"
14415 .scindex IIDmaiconf "main configuration"
14416 The first part of the runtime configuration file contains three types of item:
14417
14418 .ilist
14419 Macro definitions: These lines start with an upper case letter. See section
14420 &<<SECTmacrodefs>>& for details of macro processing.
14421 .next
14422 Named list definitions: These lines start with one of the words &"domainlist"&,
14423 &"hostlist"&, &"addresslist"&, or &"localpartlist"&. Their use is described in
14424 section &<<SECTnamedlists>>&.
14425 .next
14426 Main configuration settings: Each setting occupies one line of the file
14427 (with possible continuations). If any setting is preceded by the word
14428 &"hide"&, the &%-bP%& command line option displays its value to admin users
14429 only. See section &<<SECTcos>>& for a description of the syntax of these option
14430 settings.
14431 .endlist
14432
14433 This chapter specifies all the main configuration options, along with their
14434 types and default values. For ease of finding a particular option, they appear
14435 in alphabetical order in section &<<SECTalomo>>& below. However, because there
14436 are now so many options, they are first listed briefly in functional groups, as
14437 an aid to finding the name of the option you are looking for. Some options are
14438 listed in more than one group.
14439
14440 .section "Miscellaneous" "SECID96"
14441 .table2
14442 .row &%bi_command%&                  "to run for &%-bi%& command line option"
14443 .row &%debug_store%&                 "do extra internal checks"
14444 .row &%disable_ipv6%&                "do no IPv6 processing"
14445 .row &%keep_malformed%&              "for broken files &-- should not happen"
14446 .row &%localhost_number%&            "for unique message ids in clusters"
14447 .row &%message_body_newlines%&       "retain newlines in &$message_body$&"
14448 .row &%message_body_visible%&        "how much to show in &$message_body$&"
14449 .row &%mua_wrapper%&                 "run in &""MUA wrapper""& mode"
14450 .row &%print_topbitchars%&           "top-bit characters are printing"
14451 .row &%spool_wireformat%&            "use wire-format spool data files when possible"
14452 .row &%timezone%&                    "force time zone"
14453 .endtable
14454
14455
14456 .section "Exim parameters" "SECID97"
14457 .table2
14458 .row &%exim_group%&                  "override compiled-in value"
14459 .row &%exim_path%&                   "override compiled-in value"
14460 .row &%exim_user%&                   "override compiled-in value"
14461 .row &%primary_hostname%&            "default from &[uname()]&"
14462 .row &%split_spool_directory%&       "use multiple directories"
14463 .row &%spool_directory%&             "override compiled-in value"
14464 .endtable
14465
14466
14467
14468 .section "Privilege controls" "SECID98"
14469 .table2
14470 .row &%admin_groups%&                "groups that are Exim admin users"
14471 .row &%commandline_checks_require_admin%& "require admin for various checks"
14472 .row &%deliver_drop_privilege%&      "drop root for delivery processes"
14473 .row &%local_from_check%&            "insert &'Sender:'& if necessary"
14474 .row &%local_from_prefix%&           "for testing &'From:'& for local sender"
14475 .row &%local_from_suffix%&           "for testing &'From:'& for local sender"
14476 .row &%local_sender_retain%&         "keep &'Sender:'& from untrusted user"
14477 .row &%never_users%&                 "do not run deliveries as these"
14478 .row &%prod_requires_admin%&         "forced delivery requires admin user"
14479 .row &%queue_list_requires_admin%&   "queue listing requires admin user"
14480 .row &%trusted_groups%&              "groups that are trusted"
14481 .row &%trusted_users%&               "users that are trusted"
14482 .endtable
14483
14484
14485
14486 .section "Logging" "SECID99"
14487 .table2
14488 .row &%event_action%&                "custom logging"
14489 .row &%hosts_connection_nolog%&      "exemption from connect logging"
14490 .row &%log_file_path%&               "override compiled-in value"
14491 .row &%log_selector%&                "set/unset optional logging"
14492 .row &%log_timezone%&                "add timezone to log lines"
14493 .row &%message_logs%&                "create per-message logs"
14494 .row &%preserve_message_logs%&       "after message completion"
14495 .row &%process_log_path%&            "for SIGUSR1 and &'exiwhat'&"
14496 .row &%slow_lookup_log%&             "control logging of slow DNS lookups"
14497 .row &%syslog_duplication%&          "controls duplicate log lines on syslog"
14498 .row &%syslog_facility%&             "set syslog &""facility""& field"
14499 .row &%syslog_pid%&                  "pid in syslog lines"
14500 .row &%syslog_processname%&          "set syslog &""ident""& field"
14501 .row &%syslog_timestamp%&            "timestamp syslog lines"
14502 .row &%write_rejectlog%&             "control use of message log"
14503 .endtable
14504
14505
14506
14507 .section "Frozen messages" "SECID100"
14508 .table2
14509 .row &%auto_thaw%&                   "sets time for retrying frozen messages"
14510 .row &%freeze_tell%&                 "send message when freezing"
14511 .row &%move_frozen_messages%&        "to another directory"
14512 .row &%timeout_frozen_after%&        "keep frozen messages only so long"
14513 .endtable
14514
14515
14516
14517 .section "Data lookups" "SECID101"
14518 .table2
14519 .row &%ibase_servers%&               "InterBase servers"
14520 .row &%ldap_ca_cert_dir%&            "dir of CA certs to verify LDAP server's"
14521 .row &%ldap_ca_cert_file%&           "file of CA certs to verify LDAP server's"
14522 .row &%ldap_cert_file%&              "client cert file for LDAP"
14523 .row &%ldap_cert_key%&               "client key file for LDAP"
14524 .row &%ldap_cipher_suite%&           "TLS negotiation preference control"
14525 .row &%ldap_default_servers%&        "used if no server in query"
14526 .row &%ldap_require_cert%&           "action to take without LDAP server cert"
14527 .row &%ldap_start_tls%&              "require TLS within LDAP"
14528 .row &%ldap_version%&                "set protocol version"
14529 .row &%lookup_open_max%&             "lookup files held open"
14530 .row &%mysql_servers%&               "default MySQL servers"
14531 .row &%oracle_servers%&              "Oracle servers"
14532 .row &%pgsql_servers%&               "default PostgreSQL servers"
14533 .row &%sqlite_lock_timeout%&         "as it says"
14534 .endtable
14535
14536
14537
14538 .section "Message ids" "SECID102"
14539 .table2
14540 .row &%message_id_header_domain%&    "used to build &'Message-ID:'& header"
14541 .row &%message_id_header_text%&      "ditto"
14542 .endtable
14543
14544
14545
14546 .section "Embedded Perl Startup" "SECID103"
14547 .table2
14548 .row &%perl_at_start%&               "always start the interpreter"
14549 .row &%perl_startup%&                "code to obey when starting Perl"
14550 .row &%perl_taintmode%&              "enable taint mode in Perl"
14551 .endtable
14552
14553
14554
14555 .section "Daemon" "SECID104"
14556 .table2
14557 .row &%daemon_smtp_ports%&           "default ports"
14558 .row &%daemon_startup_retries%&      "number of times to retry"
14559 .row &%daemon_startup_sleep%&        "time to sleep between tries"
14560 .row &%extra_local_interfaces%&      "not necessarily listened on"
14561 .row &%local_interfaces%&            "on which to listen, with optional ports"
14562 .row &%notifier_socket%&             "override compiled-in value"
14563 .row &%pid_file_path%&               "override compiled-in value"
14564 .row &%queue_run_max%&               "maximum simultaneous queue runners"
14565 .endtable
14566
14567
14568
14569 .section "Resource control" "SECID105"
14570 .table2
14571 .row &%check_log_inodes%&            "before accepting a message"
14572 .row &%check_log_space%&             "before accepting a message"
14573 .row &%check_spool_inodes%&          "before accepting a message"
14574 .row &%check_spool_space%&           "before accepting a message"
14575 .row &%deliver_queue_load_max%&      "no queue deliveries if load high"
14576 .row &%queue_only_load%&             "queue incoming if load high"
14577 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
14578 .row &%queue_run_max%&               "maximum simultaneous queue runners"
14579 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
14580 .row &%smtp_accept_max%&             "simultaneous incoming connections"
14581 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
14582 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
14583 .row &%smtp_accept_max_per_connection%& "messages per connection"
14584 .row &%smtp_accept_max_per_host%&    "connections from one host"
14585 .row &%smtp_accept_queue%&           "queue mail if more connections"
14586 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
14587                                            connection"
14588 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
14589 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
14590 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
14591 .row &%smtp_load_reserve%&           "SMTP from reserved hosts if load high"
14592 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
14593 .endtable
14594
14595
14596
14597 .section "Policy controls" "SECID106"
14598 .table2
14599 .row &%acl_not_smtp%&                "ACL for non-SMTP messages"
14600 .row &%acl_not_smtp_mime%&           "ACL for non-SMTP MIME parts"
14601 .row &%acl_not_smtp_start%&          "ACL for start of non-SMTP message"
14602 .row &%acl_smtp_auth%&               "ACL for AUTH"
14603 .row &%acl_smtp_connect%&            "ACL for connection"
14604 .row &%acl_smtp_data%&               "ACL for DATA"
14605 .row &%acl_smtp_data_prdr%&          "ACL for DATA, per-recipient"
14606 .row &%acl_smtp_dkim%&               "ACL for DKIM verification"
14607 .row &%acl_smtp_etrn%&               "ACL for ETRN"
14608 .row &%acl_smtp_expn%&               "ACL for EXPN"
14609 .row &%acl_smtp_helo%&               "ACL for EHLO or HELO"
14610 .row &%acl_smtp_mail%&               "ACL for MAIL"
14611 .row &%acl_smtp_mailauth%&           "ACL for AUTH on MAIL command"
14612 .row &%acl_smtp_mime%&               "ACL for MIME parts"
14613 .row &%acl_smtp_notquit%&            "ACL for non-QUIT terminations"
14614 .row &%acl_smtp_predata%&            "ACL for start of data"
14615 .row &%acl_smtp_quit%&               "ACL for QUIT"
14616 .row &%acl_smtp_rcpt%&               "ACL for RCPT"
14617 .row &%acl_smtp_starttls%&           "ACL for STARTTLS"
14618 .row &%acl_smtp_vrfy%&               "ACL for VRFY"
14619 .row &%av_scanner%&                  "specify virus scanner"
14620 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
14621                                       words""&"
14622 .row &%dns_cname_loops%&             "follow CNAMEs returned by resolver"
14623 .row &%dns_csa_search_limit%&        "control CSA parent search depth"
14624 .row &%dns_csa_use_reverse%&         "en/disable CSA IP reverse search"
14625 .row &%header_maxsize%&              "total size of message header"
14626 .row &%header_line_maxsize%&         "individual header line limit"
14627 .row &%helo_accept_junk_hosts%&      "allow syntactic junk from these hosts"
14628 .row &%helo_allow_chars%&            "allow illegal chars in HELO names"
14629 .row &%helo_lookup_domains%&         "lookup hostname for these HELO names"
14630 .row &%helo_try_verify_hosts%&       "HELO soft-checked for these hosts"
14631 .row &%helo_verify_hosts%&           "HELO hard-checked for these hosts"
14632 .row &%host_lookup%&                 "host name looked up for these hosts"
14633 .row &%host_lookup_order%&           "order of DNS and local name lookups"
14634 .row &%hosts_proxy%&                 "use proxy protocol for these hosts"
14635 .row &%host_reject_connection%&      "reject connection from these hosts"
14636 .row &%hosts_treat_as_local%&        "useful in some cluster configurations"
14637 .row &%local_scan_timeout%&          "timeout for &[local_scan()]&"
14638 .row &%message_size_limit%&          "for all messages"
14639 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
14640 .row &%spamd_address%&               "set interface to SpamAssassin"
14641 .row &%strict_acl_vars%&             "object to unset ACL variables"
14642 .row &%spf_smtp_comment_template%&   "template for &$spf_smtp_comment$&"
14643 .endtable
14644
14645
14646
14647 .section "Callout cache" "SECID107"
14648 .table2
14649 .row &%callout_domain_negative_expire%& "timeout for negative domain cache &&&
14650                                          item"
14651 .row &%callout_domain_positive_expire%& "timeout for positive domain cache &&&
14652                                          item"
14653 .row &%callout_negative_expire%&     "timeout for negative address cache item"
14654 .row &%callout_positive_expire%&     "timeout for positive address cache item"
14655 .row &%callout_random_local_part%&   "string to use for &""random""& testing"
14656 .endtable
14657
14658
14659
14660 .section "TLS" "SECID108"
14661 .table2
14662 .row &%gnutls_compat_mode%&          "use GnuTLS compatibility mode"
14663 .row &%gnutls_allow_auto_pkcs11%&    "allow GnuTLS to autoload PKCS11 modules"
14664 .row &%openssl_options%&             "adjust OpenSSL compatibility options"
14665 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
14666 .row &%tls_certificate%&             "location of server certificate"
14667 .row &%tls_crl%&                     "certificate revocation list"
14668 .row &%tls_dh_max_bits%&             "clamp D-H bit count suggestion"
14669 .row &%tls_dhparam%&                 "DH parameters for server"
14670 .row &%tls_eccurve%&                 "EC curve selection for server"
14671 .row &%tls_ocsp_file%&               "location of server certificate status proof"
14672 .row &%tls_on_connect_ports%&        "specify SSMTP (SMTPS) ports"
14673 .row &%tls_privatekey%&              "location of server private key"
14674 .row &%tls_remember_esmtp%&          "don't reset after starting TLS"
14675 .row &%tls_require_ciphers%&         "specify acceptable ciphers"
14676 .row &%tls_try_verify_hosts%&        "try to verify client certificate"
14677 .row &%tls_verify_certificates%&     "expected client certificates"
14678 .row &%tls_verify_hosts%&            "insist on client certificate verify"
14679 .endtable
14680
14681
14682
14683 .section "Local user handling" "SECID109"
14684 .table2
14685 .row &%finduser_retries%&            "useful in NIS environments"
14686 .row &%gecos_name%&                  "used when creating &'Sender:'&"
14687 .row &%gecos_pattern%&               "ditto"
14688 .row &%max_username_length%&         "for systems that truncate"
14689 .row &%unknown_login%&               "used when no login name found"
14690 .row &%unknown_username%&            "ditto"
14691 .row &%uucp_from_pattern%&           "for recognizing &""From ""& lines"
14692 .row &%uucp_from_sender%&            "ditto"
14693 .endtable
14694
14695
14696
14697 .section "All incoming messages (SMTP and non-SMTP)" "SECID110"
14698 .table2
14699 .row &%header_maxsize%&              "total size of message header"
14700 .row &%header_line_maxsize%&         "individual header line limit"
14701 .row &%message_size_limit%&          "applies to all messages"
14702 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
14703 .row &%received_header_text%&        "expanded to make &'Received:'&"
14704 .row &%received_headers_max%&        "for mail loop detection"
14705 .row &%recipients_max%&              "limit per message"
14706 .row &%recipients_max_reject%&       "permanently reject excess recipients"
14707 .endtable
14708
14709
14710
14711
14712 .section "Non-SMTP incoming messages" "SECID111"
14713 .table2
14714 .row &%receive_timeout%&             "for non-SMTP messages"
14715 .endtable
14716
14717
14718
14719
14720
14721 .section "Incoming SMTP messages" "SECID112"
14722 See also the &'Policy controls'& section above.
14723
14724 .table2
14725 .row &%dkim_verify_hashes%&          "DKIM hash methods accepted for signatures"
14726 .row &%dkim_verify_keytypes%&        "DKIM key types accepted for signatures"
14727 .row &%dkim_verify_min_keysizes%&    "DKIM key sizes accepted for signatures"
14728 .row &%dkim_verify_signers%&         "DKIM domains for which DKIM ACL is run"
14729 .row &%dmarc_forensic_sender%&       "DMARC sender for report messages"
14730 .row &%dmarc_history_file%&          "DMARC results log"
14731 .row &%dmarc_tld_file%&              "DMARC toplevel domains file"
14732 .row &%host_lookup%&                 "host name looked up for these hosts"
14733 .row &%host_lookup_order%&           "order of DNS and local name lookups"
14734 .row &%recipient_unqualified_hosts%& "may send unqualified recipients"
14735 .row &%rfc1413_hosts%&               "make ident calls to these hosts"
14736 .row &%rfc1413_query_timeout%&       "zero disables ident calls"
14737 .row &%sender_unqualified_hosts%&    "may send unqualified senders"
14738 .row &%smtp_accept_keepalive%&       "some TCP/IP magic"
14739 .row &%smtp_accept_max%&             "simultaneous incoming connections"
14740 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
14741 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
14742 .row &%smtp_accept_max_per_connection%& "messages per connection"
14743 .row &%smtp_accept_max_per_host%&    "connections from one host"
14744 .row &%smtp_accept_queue%&           "queue mail if more connections"
14745 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
14746                                            connection"
14747 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
14748 .row &%smtp_active_hostname%&        "host name to use in messages"
14749 .row &%smtp_banner%&                 "text for welcome banner"
14750 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
14751 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
14752 .row &%smtp_enforce_sync%&           "of SMTP command/responses"
14753 .row &%smtp_etrn_command%&           "what to run for ETRN"
14754 .row &%smtp_etrn_serialize%&         "only one at once"
14755 .row &%smtp_load_reserve%&           "only reserve hosts if this load"
14756 .row &%smtp_max_unknown_commands%&   "before dropping connection"
14757 .row &%smtp_ratelimit_hosts%&        "apply ratelimiting to these hosts"
14758 .row &%smtp_ratelimit_mail%&         "ratelimit for MAIL commands"
14759 .row &%smtp_ratelimit_rcpt%&         "ratelimit for RCPT commands"
14760 .row &%smtp_receive_timeout%&        "per command or data line"
14761 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
14762 .row &%smtp_return_error_details%&   "give detail on rejections"
14763 .endtable
14764
14765
14766
14767 .section "SMTP extensions" "SECID113"
14768 .table2
14769 .row &%accept_8bitmime%&             "advertise 8BITMIME"
14770 .row &%auth_advertise_hosts%&        "advertise AUTH to these hosts"
14771 .row &%chunking_advertise_hosts%&    "advertise CHUNKING to these hosts"
14772 .row &%dsn_advertise_hosts%&         "advertise DSN extensions to these hosts"
14773 .row &%ignore_fromline_hosts%&       "allow &""From ""& from these hosts"
14774 .row &%ignore_fromline_local%&       "allow &""From ""& from local SMTP"
14775 .row &%pipelining_advertise_hosts%&  "advertise pipelining to these hosts"
14776 .row &%pipelining_connect_advertise_hosts%& "advertise pipelining to these hosts"
14777 .row &%prdr_enable%&                 "advertise PRDR to all hosts"
14778 .row &%smtputf8_advertise_hosts%&    "advertise SMTPUTF8 to these hosts"
14779 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
14780 .endtable
14781
14782
14783
14784 .section "Processing messages" "SECID114"
14785 .table2
14786 .row &%allow_domain_literals%&       "recognize domain literal syntax"
14787 .row &%allow_mx_to_ip%&              "allow MX to point to IP address"
14788 .row &%allow_utf8_domains%&          "in addresses"
14789 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
14790                                       words""&"
14791 .row &%delivery_date_remove%&        "from incoming messages"
14792 .row &%envelope_to_remove%&          "from incoming messages"
14793 .row &%extract_addresses_remove_arguments%& "affects &%-t%& processing"
14794 .row &%headers_charset%&             "default for translations"
14795 .row &%qualify_domain%&              "default for senders"
14796 .row &%qualify_recipient%&           "default for recipients"
14797 .row &%return_path_remove%&          "from incoming messages"
14798 .row &%strip_excess_angle_brackets%& "in addresses"
14799 .row &%strip_trailing_dot%&          "at end of addresses"
14800 .row &%untrusted_set_sender%&        "untrusted can set envelope sender"
14801 .endtable
14802
14803
14804
14805 .section "System filter" "SECID115"
14806 .table2
14807 .row &%system_filter%&               "locate system filter"
14808 .row &%system_filter_directory_transport%& "transport for delivery to a &&&
14809                                             directory"
14810 .row &%system_filter_file_transport%& "transport for delivery to a file"
14811 .row &%system_filter_group%&         "group for filter running"
14812 .row &%system_filter_pipe_transport%& "transport for delivery to a pipe"
14813 .row &%system_filter_reply_transport%& "transport for autoreply delivery"
14814 .row &%system_filter_user%&          "user for filter running"
14815 .endtable
14816
14817
14818
14819 .section "Routing and delivery" "SECID116"
14820 .table2
14821 .row &%disable_ipv6%&                "do no IPv6 processing"
14822 .row &%dns_again_means_nonexist%&    "for broken domains"
14823 .row &%dns_check_names_pattern%&     "pre-DNS syntax check"
14824 .row &%dns_dnssec_ok%&               "parameter for resolver"
14825 .row &%dns_ipv4_lookup%&             "only v4 lookup for these domains"
14826 .row &%dns_retrans%&                 "parameter for resolver"
14827 .row &%dns_retry%&                   "parameter for resolver"
14828 .row &%dns_trust_aa%&                "DNS zones trusted as authentic"
14829 .row &%dns_use_edns0%&               "parameter for resolver"
14830 .row &%hold_domains%&                "hold delivery for these domains"
14831 .row &%local_interfaces%&            "for routing checks"
14832 .row &%queue_domains%&               "no immediate delivery for these"
14833 .row &%queue_fast_ramp%&             "parallel delivery with 2-phase queue run"
14834 .row &%queue_only%&                  "no immediate delivery at all"
14835 .row &%queue_only_file%&             "no immediate delivery if file exists"
14836 .row &%queue_only_load%&             "no immediate delivery if load is high"
14837 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
14838 .row &%queue_only_override%&         "allow command line to override"
14839 .row &%queue_run_in_order%&          "order of arrival"
14840 .row &%queue_run_max%&               "of simultaneous queue runners"
14841 .row &%queue_smtp_domains%&          "no immediate SMTP delivery for these"
14842 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
14843 .row &%remote_sort_domains%&         "order of remote deliveries"
14844 .row &%retry_data_expire%&           "timeout for retry data"
14845 .row &%retry_interval_max%&          "safety net for retry rules"
14846 .endtable
14847
14848
14849
14850 .section "Bounce and warning messages" "SECID117"
14851 .table2
14852 .row &%bounce_message_file%&         "content of bounce"
14853 .row &%bounce_message_text%&         "content of bounce"
14854 .row &%bounce_return_body%&          "include body if returning message"
14855 .row &%bounce_return_linesize_limit%& "limit on returned message line length"
14856 .row &%bounce_return_message%&       "include original message in bounce"
14857 .row &%bounce_return_size_limit%&    "limit on returned message"
14858 .row &%bounce_sender_authentication%& "send authenticated sender with bounce"
14859 .row &%dsn_from%&                    "set &'From:'& contents in bounces"
14860 .row &%errors_copy%&                 "copy bounce messages"
14861 .row &%errors_reply_to%&             "&'Reply-to:'& in bounces"
14862 .row &%delay_warning%&               "time schedule"
14863 .row &%delay_warning_condition%&     "condition for warning messages"
14864 .row &%ignore_bounce_errors_after%&  "discard undeliverable bounces"
14865 .row &%smtp_return_error_details%&   "give detail on rejections"
14866 .row &%warn_message_file%&           "content of warning message"
14867 .endtable
14868
14869
14870
14871 .section "Alphabetical list of main options" "SECTalomo"
14872 Those options that undergo string expansion before use are marked with
14873 &dagger;.
14874
14875 .option accept_8bitmime main boolean true
14876 .cindex "8BITMIME"
14877 .cindex "8-bit characters"
14878 .cindex "log" "selectors"
14879 .cindex "log" "8BITMIME"
14880 .cindex "ESMTP extensions" 8BITMIME
14881 This option causes Exim to send 8BITMIME in its response to an SMTP
14882 EHLO command, and to accept the BODY= parameter on MAIL commands.
14883 However, though Exim is 8-bit clean, it is not a protocol converter, and it
14884 takes no steps to do anything special with messages received by this route.
14885
14886 Historically Exim kept this option off by default, but the maintainers
14887 feel that in today's Internet, this causes more problems than it solves.
14888 It now defaults to true.
14889 A more detailed analysis of the issues is provided by Dan Bernstein:
14890 .display
14891 &url(https://cr.yp.to/smtp/8bitmime.html)
14892 .endd
14893
14894 To log received 8BITMIME status use
14895 .code
14896 log_selector = +8bitmime
14897 .endd
14898
14899 .option acl_not_smtp main string&!! unset
14900 .cindex "&ACL;" "for non-SMTP messages"
14901 .cindex "non-SMTP messages" "ACLs for"
14902 This option defines the ACL that is run when a non-SMTP message has been
14903 read and is on the point of being accepted. See chapter &<<CHAPACL>>& for
14904 further details.
14905
14906 .option acl_not_smtp_mime main string&!! unset
14907 This option defines the ACL that is run for individual MIME parts of non-SMTP
14908 messages. It operates in exactly the same way as &%acl_smtp_mime%& operates for
14909 SMTP messages.
14910
14911 .option acl_not_smtp_start main string&!! unset
14912 .cindex "&ACL;" "at start of non-SMTP message"
14913 .cindex "non-SMTP messages" "ACLs for"
14914 This option defines the ACL that is run before Exim starts reading a
14915 non-SMTP message. See chapter &<<CHAPACL>>& for further details.
14916
14917 .option acl_smtp_auth main string&!! unset
14918 .cindex "&ACL;" "setting up for SMTP commands"
14919 .cindex "AUTH" "ACL for"
14920 This option defines the ACL that is run when an SMTP AUTH command is
14921 received. See chapter &<<CHAPACL>>& for further details.
14922
14923 .option acl_smtp_connect main string&!! unset
14924 .cindex "&ACL;" "on SMTP connection"
14925 This option defines the ACL that is run when an SMTP connection is received.
14926 See chapter &<<CHAPACL>>& for further details.
14927
14928 .option acl_smtp_data main string&!! unset
14929 .cindex "DATA" "ACL for"
14930 This option defines the ACL that is run after an SMTP DATA command has been
14931 processed and the message itself has been received, but before the final
14932 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
14933
14934 .option acl_smtp_data_prdr main string&!! accept
14935 .cindex "PRDR" "ACL for"
14936 .cindex "DATA" "PRDR ACL for"
14937 .cindex "&ACL;" "PRDR-related"
14938 .cindex "&ACL;" "per-user data processing"
14939 This option defines the ACL that,
14940 if the PRDR feature has been negotiated,
14941 is run for each recipient after an SMTP DATA command has been
14942 processed and the message itself has been received, but before the
14943 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
14944
14945 .option acl_smtp_dkim main string&!! unset
14946 .cindex DKIM "ACL for"
14947 This option defines the ACL that is run for each DKIM signature
14948 (by default, or as specified in the dkim_verify_signers option)
14949 of a received message.
14950 See section &<<SECDKIMVFY>>& for further details.
14951
14952 .option acl_smtp_etrn main string&!! unset
14953 .cindex "ETRN" "ACL for"
14954 This option defines the ACL that is run when an SMTP ETRN command is
14955 received. See chapter &<<CHAPACL>>& for further details.
14956
14957 .option acl_smtp_expn main string&!! unset
14958 .cindex "EXPN" "ACL for"
14959 This option defines the ACL that is run when an SMTP EXPN command is
14960 received. See chapter &<<CHAPACL>>& for further details.
14961
14962 .option acl_smtp_helo main string&!! unset
14963 .cindex "EHLO" "ACL for"
14964 .cindex "HELO" "ACL for"
14965 This option defines the ACL that is run when an SMTP EHLO or HELO
14966 command is received. See chapter &<<CHAPACL>>& for further details.
14967
14968
14969 .option acl_smtp_mail main string&!! unset
14970 .cindex "MAIL" "ACL for"
14971 This option defines the ACL that is run when an SMTP MAIL command is
14972 received. See chapter &<<CHAPACL>>& for further details.
14973
14974 .option acl_smtp_mailauth main string&!! unset
14975 .cindex "AUTH" "on MAIL command"
14976 This option defines the ACL that is run when there is an AUTH parameter on
14977 a MAIL command. See chapter &<<CHAPACL>>& for details of ACLs, and chapter
14978 &<<CHAPSMTPAUTH>>& for details of authentication.
14979
14980 .option acl_smtp_mime main string&!! unset
14981 .cindex "MIME content scanning" "ACL for"
14982 This option is available when Exim is built with the content-scanning
14983 extension. It defines the ACL that is run for each MIME part in a message. See
14984 section &<<SECTscanmimepart>>& for details.
14985
14986 .option acl_smtp_notquit main string&!! unset
14987 .cindex "not-QUIT, ACL for"
14988 This option defines the ACL that is run when an SMTP session
14989 ends without a QUIT command being received.
14990 See chapter &<<CHAPACL>>& for further details.
14991
14992 .option acl_smtp_predata main string&!! unset
14993 This option defines the ACL that is run when an SMTP DATA command is
14994 received, before the message itself is received. See chapter &<<CHAPACL>>& for
14995 further details.
14996
14997 .option acl_smtp_quit main string&!! unset
14998 .cindex "QUIT, ACL for"
14999 This option defines the ACL that is run when an SMTP QUIT command is
15000 received. See chapter &<<CHAPACL>>& for further details.
15001
15002 .option acl_smtp_rcpt main string&!! unset
15003 .cindex "RCPT" "ACL for"
15004 This option defines the ACL that is run when an SMTP RCPT command is
15005 received. See chapter &<<CHAPACL>>& for further details.
15006
15007 .option acl_smtp_starttls main string&!! unset
15008 .cindex "STARTTLS, ACL for"
15009 This option defines the ACL that is run when an SMTP STARTTLS command is
15010 received. See chapter &<<CHAPACL>>& for further details.
15011
15012 .option acl_smtp_vrfy main string&!! unset
15013 .cindex "VRFY" "ACL for"
15014 This option defines the ACL that is run when an SMTP VRFY command is
15015 received. See chapter &<<CHAPACL>>& for further details.
15016
15017 .option add_environment main "string list" empty
15018 .cindex "environment" "set values"
15019 This option adds individual environment variables that the
15020 currently linked libraries and programs in child processes may use.
15021 Each list element should be of the form &"name=value"&.
15022
15023 See &<<SECTpipeenv>>& for the environment of &(pipe)& transports.
15024
15025 .option admin_groups main "string list&!!" unset
15026 .cindex "admin user"
15027 This option is expanded just once, at the start of Exim's processing. If the
15028 current group or any of the supplementary groups of an Exim caller is in this
15029 colon-separated list, the caller has admin privileges. If all your system
15030 programmers are in a specific group, for example, you can give them all Exim
15031 admin privileges by putting that group in &%admin_groups%&. However, this does
15032 not permit them to read Exim's spool files (whose group owner is the Exim gid).
15033 To permit this, you have to add individuals to the Exim group.
15034
15035 .option allow_domain_literals main boolean false
15036 .cindex "domain literal"
15037 If this option is set, the RFC 2822 domain literal format is permitted in
15038 email addresses. The option is not set by default, because the domain literal
15039 format is not normally required these days, and few people know about it. It
15040 has, however, been exploited by mail abusers.
15041
15042 Unfortunately, it seems that some DNS black list maintainers are using this
15043 format to report black listing to postmasters. If you want to accept messages
15044 addressed to your hosts by IP address, you need to set
15045 &%allow_domain_literals%& true, and also to add &`@[]`& to the list of local
15046 domains (defined in the named domain list &%local_domains%& in the default
15047 configuration). This &"magic string"& matches the domain literal form of all
15048 the local host's IP addresses.
15049
15050
15051 .option allow_mx_to_ip main boolean false
15052 .cindex "MX record" "pointing to IP address"
15053 It appears that more and more DNS zone administrators are breaking the rules
15054 and putting domain names that look like IP addresses on the right hand side of
15055 MX records. Exim follows the rules and rejects this, giving an error message
15056 that explains the misconfiguration. However, some other MTAs support this
15057 practice, so to avoid &"Why can't Exim do this?"& complaints,
15058 &%allow_mx_to_ip%& exists, in order to enable this heinous activity. It is not
15059 recommended, except when you have no other choice.
15060
15061 .option allow_utf8_domains main boolean false
15062 .cindex "domain" "UTF-8 characters in"
15063 .cindex "UTF-8" "in domain name"
15064 Lots of discussion is going on about internationalized domain names. One
15065 camp is strongly in favour of just using UTF-8 characters, and it seems
15066 that at least two other MTAs permit this.
15067 This option allows Exim users to experiment if they wish.
15068
15069 If it is set true, Exim's domain parsing function allows valid
15070 UTF-8 multicharacters to appear in domain name components, in addition to
15071 letters, digits, and hyphens.
15072
15073 If Exim is built with internationalization support
15074 and the SMTPUTF8 ESMTP option is in use (see chapter &<<CHAPi18n>>&)
15075 this option can be left as default.
15076 Without that,
15077 if you want to look up such domain names in the DNS, you must also
15078 adjust the value of &%dns_check_names_pattern%& to match the extended form. A
15079 suitable setting is:
15080 .code
15081 dns_check_names_pattern = (?i)^(?>(?(1)\.|())[a-z0-9\xc0-\xff]\
15082   (?>[-a-z0-9\x80-\xff]*[a-z0-9\x80-\xbf])?)+$
15083 .endd
15084 Alternatively, you can just disable this feature by setting
15085 .code
15086 dns_check_names_pattern =
15087 .endd
15088 That is, set the option to an empty string so that no check is done.
15089
15090
15091 .option auth_advertise_hosts main "host list&!!" *
15092 .cindex "authentication" "advertising"
15093 .cindex "AUTH" "advertising"
15094 .cindex "ESMTP extensions" AUTH
15095 If any server authentication mechanisms are configured, Exim advertises them in
15096 response to an EHLO command only if the calling host matches this list.
15097 Otherwise, Exim does not advertise AUTH.
15098 Exim does not accept AUTH commands from clients to which it has not
15099 advertised the availability of AUTH. The advertising of individual
15100 authentication mechanisms can be controlled by the use of the
15101 &%server_advertise_condition%& generic authenticator option on the individual
15102 authenticators. See chapter &<<CHAPSMTPAUTH>>& for further details.
15103
15104 Certain mail clients (for example, Netscape) require the user to provide a name
15105 and password for authentication if AUTH is advertised, even though it may
15106 not be needed (the host may accept messages from hosts on its local LAN without
15107 authentication, for example). The &%auth_advertise_hosts%& option can be used
15108 to make these clients more friendly by excluding them from the set of hosts to
15109 which Exim advertises AUTH.
15110
15111 .cindex "AUTH" "advertising when encrypted"
15112 If you want to advertise the availability of AUTH only when the connection
15113 is encrypted using TLS, you can make use of the fact that the value of this
15114 option is expanded, with a setting like this:
15115 .code
15116 auth_advertise_hosts = ${if eq{$tls_in_cipher}{}{}{*}}
15117 .endd
15118 .vindex "&$tls_in_cipher$&"
15119 If &$tls_in_cipher$& is empty, the session is not encrypted, and the result of
15120 the expansion is empty, thus matching no hosts. Otherwise, the result of the
15121 expansion is *, which matches all hosts.
15122
15123
15124 .option auto_thaw main time 0s
15125 .cindex "thawing messages"
15126 .cindex "unfreezing messages"
15127 If this option is set to a time greater than zero, a queue runner will try a
15128 new delivery attempt on any frozen message, other than a bounce message, if
15129 this much time has passed since it was frozen. This may result in the message
15130 being re-frozen if nothing has changed since the last attempt. It is a way of
15131 saying &"keep on trying, even though there are big problems"&.
15132
15133 &*Note*&: This is an old option, which predates &%timeout_frozen_after%& and
15134 &%ignore_bounce_errors_after%&. It is retained for compatibility, but it is not
15135 thought to be very useful any more, and its use should probably be avoided.
15136
15137
15138 .option av_scanner main string "see below"
15139 This option is available if Exim is built with the content-scanning extension.
15140 It specifies which anti-virus scanner to use. The default value is:
15141 .code
15142 sophie:/var/run/sophie
15143 .endd
15144 If the value of &%av_scanner%& starts with a dollar character, it is expanded
15145 before use. See section &<<SECTscanvirus>>& for further details.
15146
15147
15148 .option bi_command main string unset
15149 .oindex "&%-bi%&"
15150 This option supplies the name of a command that is run when Exim is called with
15151 the &%-bi%& option (see chapter &<<CHAPcommandline>>&). The string value is
15152 just the command name, it is not a complete command line. If an argument is
15153 required, it must come from the &%-oA%& command line option.
15154
15155
15156 .option bounce_message_file main string&!! unset
15157 .cindex "bounce message" "customizing"
15158 .cindex "customizing" "bounce message"
15159 This option defines a template file containing paragraphs of text to be used
15160 for constructing bounce messages.  Details of the file's contents are given in
15161 chapter &<<CHAPemsgcust>>&.
15162 .cindex bounce_message_file "tainted data"
15163 The option is expanded to give the file path, which must be
15164 absolute and untainted.
15165 See also &%warn_message_file%&.
15166
15167
15168 .option bounce_message_text main string unset
15169 When this option is set, its contents are included in the default bounce
15170 message immediately after &"This message was created automatically by mail
15171 delivery software."& It is not used if &%bounce_message_file%& is set.
15172
15173 .option bounce_return_body main boolean true
15174 .cindex "bounce message" "including body"
15175 This option controls whether the body of an incoming message is included in a
15176 bounce message when &%bounce_return_message%& is true. The default setting
15177 causes the entire message, both header and body, to be returned (subject to the
15178 value of &%bounce_return_size_limit%&). If this option is false, only the
15179 message header is included. In the case of a non-SMTP message containing an
15180 error that is detected during reception, only those header lines preceding the
15181 point at which the error was detected are returned.
15182 .cindex "bounce message" "including original"
15183
15184 .option bounce_return_linesize_limit main integer 998
15185 .cindex "size" "of bounce lines, limit"
15186 .cindex "bounce message" "line length limit"
15187 .cindex "limit" "bounce message line length"
15188 This option sets a limit in bytes on the line length of messages
15189 that are returned to senders due to delivery problems,
15190 when &%bounce_return_message%& is true.
15191 The default value corresponds to RFC limits.
15192 If the message being returned has lines longer than this value it is
15193 treated as if the &%bounce_return_size_limit%& (below) restriction was exceeded.
15194
15195 The option also applies to bounces returned when an error is detected
15196 during reception of a message.
15197 In this case lines from the original are truncated.
15198
15199 The option does not apply to messages generated by an &(autoreply)& transport.
15200
15201
15202 .option bounce_return_message main boolean true
15203 If this option is set false, none of the original message is included in
15204 bounce messages generated by Exim. See also &%bounce_return_size_limit%& and
15205 &%bounce_return_body%&.
15206
15207
15208 .option bounce_return_size_limit main integer 100K
15209 .cindex "size" "of bounce, limit"
15210 .cindex "bounce message" "size limit"
15211 .cindex "limit" "bounce message size"
15212 This option sets a limit in bytes on the size of messages that are returned to
15213 senders as part of bounce messages when &%bounce_return_message%& is true. The
15214 limit should be less than the value of the global &%message_size_limit%& and of
15215 any &%message_size_limit%& settings on transports, to allow for the bounce text
15216 that Exim generates. If this option is set to zero there is no limit.
15217
15218 When the body of any message that is to be included in a bounce message is
15219 greater than the limit, it is truncated, and a comment pointing this out is
15220 added at the top. The actual cutoff may be greater than the value given, owing
15221 to the use of buffering for transferring the message in chunks (typically 8K in
15222 size). The idea is to save bandwidth on those undeliverable 15-megabyte
15223 messages.
15224
15225 .option bounce_sender_authentication main string unset
15226 .cindex "bounce message" "sender authentication"
15227 .cindex "authentication" "bounce message"
15228 .cindex "AUTH" "on bounce message"
15229 This option provides an authenticated sender address that is sent with any
15230 bounce messages generated by Exim that are sent over an authenticated SMTP
15231 connection. A typical setting might be:
15232 .code
15233 bounce_sender_authentication = mailer-daemon@my.domain.example
15234 .endd
15235 which would cause bounce messages to be sent using the SMTP command:
15236 .code
15237 MAIL FROM:<> AUTH=mailer-daemon@my.domain.example
15238 .endd
15239 The value of &%bounce_sender_authentication%& must always be a complete email
15240 address.
15241
15242 .option callout_domain_negative_expire main time 3h
15243 .cindex "caching" "callout timeouts"
15244 .cindex "callout" "caching timeouts"
15245 This option specifies the expiry time for negative callout cache data for a
15246 domain. See section &<<SECTcallver>>& for details of callout verification, and
15247 section &<<SECTcallvercache>>& for details of the caching.
15248
15249
15250 .option callout_domain_positive_expire main time 7d
15251 This option specifies the expiry time for positive callout cache data for a
15252 domain. See section &<<SECTcallver>>& for details of callout verification, and
15253 section &<<SECTcallvercache>>& for details of the caching.
15254
15255
15256 .option callout_negative_expire main time 2h
15257 This option specifies the expiry time for negative callout cache data for an
15258 address. See section &<<SECTcallver>>& for details of callout verification, and
15259 section &<<SECTcallvercache>>& for details of the caching.
15260
15261
15262 .option callout_positive_expire main time 24h
15263 This option specifies the expiry time for positive callout cache data for an
15264 address. See section &<<SECTcallver>>& for details of callout verification, and
15265 section &<<SECTcallvercache>>& for details of the caching.
15266
15267
15268 .option callout_random_local_part main string&!! "see below"
15269 This option defines the &"random"& local part that can be used as part of
15270 callout verification. The default value is
15271 .code
15272 $primary_hostname-$tod_epoch-testing
15273 .endd
15274 See section &<<CALLaddparcall>>& for details of how this value is used.
15275
15276
15277 .option check_log_inodes main integer 100
15278 See &%check_spool_space%& below.
15279
15280
15281 .option check_log_space main integer 10M
15282 See &%check_spool_space%& below.
15283
15284 .oindex "&%check_rfc2047_length%&"
15285 .cindex "RFC 2047" "disabling length check"
15286 .option check_rfc2047_length main boolean true
15287 RFC 2047 defines a way of encoding non-ASCII characters in headers using a
15288 system of &"encoded words"&. The RFC specifies a maximum length for an encoded
15289 word; strings to be encoded that exceed this length are supposed to use
15290 multiple encoded words. By default, Exim does not recognize encoded words that
15291 exceed the maximum length. However, it seems that some software, in violation
15292 of the RFC, generates overlong encoded words. If &%check_rfc2047_length%& is
15293 set false, Exim recognizes encoded words of any length.
15294
15295
15296 .option check_spool_inodes main integer 100
15297 See &%check_spool_space%& below.
15298
15299
15300 .option check_spool_space main integer 10M
15301 .cindex "checking disk space"
15302 .cindex "disk space, checking"
15303 .cindex "spool directory" "checking space"
15304 The four &%check_...%& options allow for checking of disk resources before a
15305 message is accepted.
15306
15307 .vindex "&$log_inodes$&"
15308 .vindex "&$log_space$&"
15309 .vindex "&$spool_inodes$&"
15310 .vindex "&$spool_space$&"
15311 When any of these options are nonzero, they apply to all incoming messages. If you
15312 want to apply different checks to different kinds of message, you can do so by
15313 testing the variables &$log_inodes$&, &$log_space$&, &$spool_inodes$&, and
15314 &$spool_space$& in an ACL with appropriate additional conditions.
15315
15316
15317 &%check_spool_space%& and &%check_spool_inodes%& check the spool partition if
15318 either value is greater than zero, for example:
15319 .code
15320 check_spool_space = 100M
15321 check_spool_inodes = 100
15322 .endd
15323 The spool partition is the one that contains the directory defined by
15324 SPOOL_DIRECTORY in &_Local/Makefile_&. It is used for holding messages in
15325 transit.
15326
15327 &%check_log_space%& and &%check_log_inodes%&  check the partition in which log
15328 files are written if either is greater than zero. These should be set only if
15329 &%log_file_path%& and &%spool_directory%& refer to different partitions.
15330
15331 If there is less space or fewer inodes than requested, Exim refuses to accept
15332 incoming mail. In the case of SMTP input this is done by giving a 452 temporary
15333 error response to the MAIL command. If ESMTP is in use and there was a
15334 SIZE parameter on the MAIL command, its value is added to the
15335 &%check_spool_space%& value, and the check is performed even if
15336 &%check_spool_space%& is zero, unless &%no_smtp_check_spool_space%& is set.
15337
15338 The values for &%check_spool_space%& and &%check_log_space%& are held as a
15339 number of kilobytes (though specified in bytes).
15340 If a non-multiple of 1024 is specified, it is rounded up.
15341
15342 For non-SMTP input and for batched SMTP input, the test is done at start-up; on
15343 failure a message is written to stderr and Exim exits with a non-zero code, as
15344 it obviously cannot send an error message of any kind.
15345
15346 There is a slight performance penalty for these checks.
15347 Versions of Exim preceding 4.88 had these disabled by default;
15348 high-rate installations confident they will never run out of resources
15349 may wish to deliberately disable them.
15350
15351 .option chunking_advertise_hosts main "host list&!!" *
15352 .cindex CHUNKING advertisement
15353 .cindex "RFC 3030" "CHUNKING"
15354 .cindex "ESMTP extensions" CHUNKING
15355 The CHUNKING extension (RFC3030) will be advertised in the EHLO message to
15356 these hosts.
15357 Hosts may use the BDAT command as an alternate to DATA.
15358
15359 .option commandline_checks_require_admin main boolean &`false`&
15360 .cindex "restricting access to features"
15361 This option restricts various basic checking features to require an
15362 administrative user.
15363 This affects most of the &%-b*%& options, such as &%-be%&.
15364
15365 .option debug_store main boolean &`false`&
15366 .cindex debugging "memory corruption"
15367 .cindex memory debugging
15368 This option, when true, enables extra checking in Exim's internal memory
15369 management.  For use when a memory corruption issue is being investigated,
15370 it should normally be left as default.
15371
15372 .option daemon_smtp_ports main string &`smtp`&
15373 .cindex "port" "for daemon"
15374 .cindex "TCP/IP" "setting listening ports"
15375 This option specifies one or more default SMTP ports on which the Exim daemon
15376 listens. See chapter &<<CHAPinterfaces>>& for details of how it is used. For
15377 backward compatibility, &%daemon_smtp_port%& (singular) is a synonym.
15378
15379 .option daemon_startup_retries main integer 9
15380 .cindex "daemon startup, retrying"
15381 This option, along with &%daemon_startup_sleep%&, controls the retrying done by
15382 the daemon at startup when it cannot immediately bind a listening socket
15383 (typically because the socket is already in use): &%daemon_startup_retries%&
15384 defines the number of retries after the first failure, and
15385 &%daemon_startup_sleep%& defines the length of time to wait between retries.
15386
15387 .option daemon_startup_sleep main time 30s
15388 See &%daemon_startup_retries%&.
15389
15390 .option delay_warning main "time list" 24h
15391 .cindex "warning of delay"
15392 .cindex "delay warning, specifying"
15393 .cindex "queue" "delay warning"
15394 When a message is delayed, Exim sends a warning message to the sender at
15395 intervals specified by this option. The data is a colon-separated list of times
15396 after which to send warning messages. If the value of the option is an empty
15397 string or a zero time, no warnings are sent. Up to 10 times may be given. If a
15398 message has been in the queue for longer than the last time, the last interval
15399 between the times is used to compute subsequent warning times. For example,
15400 with
15401 .code
15402 delay_warning = 4h:8h:24h
15403 .endd
15404 the first message is sent after 4 hours, the second after 8 hours, and
15405 the third one after 24 hours. After that, messages are sent every 16 hours,
15406 because that is the interval between the last two times on the list. If you set
15407 just one time, it specifies the repeat interval. For example, with:
15408 .code
15409 delay_warning = 6h
15410 .endd
15411 messages are repeated every six hours. To stop warnings after a given time, set
15412 a very large time at the end of the list. For example:
15413 .code
15414 delay_warning = 2h:12h:99d
15415 .endd
15416 Note that the option is only evaluated at the time a delivery attempt fails,
15417 which depends on retry and queue-runner configuration.
15418 Typically retries will be configured more frequently than warning messages.
15419
15420 .option delay_warning_condition main string&!! "see below"
15421 .vindex "&$domain$&"
15422 The string is expanded at the time a warning message might be sent. If all the
15423 deferred addresses have the same domain, it is set in &$domain$& during the
15424 expansion. Otherwise &$domain$& is empty. If the result of the expansion is a
15425 forced failure, an empty string, or a string matching any of &"0"&, &"no"& or
15426 &"false"& (the comparison being done caselessly) then the warning message is
15427 not sent. The default is:
15428 .code
15429 delay_warning_condition = ${if or {\
15430   { !eq{$h_list-id:$h_list-post:$h_list-subscribe:}{} }\
15431   { match{$h_precedence:}{(?i)bulk|list|junk} }\
15432   { match{$h_auto-submitted:}{(?i)auto-generated|auto-replied} }\
15433   } {no}{yes}}
15434 .endd
15435 This suppresses the sending of warnings for messages that contain &'List-ID:'&,
15436 &'List-Post:'&, or &'List-Subscribe:'& headers, or have &"bulk"&, &"list"& or
15437 &"junk"& in a &'Precedence:'& header, or have &"auto-generated"& or
15438 &"auto-replied"& in an &'Auto-Submitted:'& header.
15439
15440 .option deliver_drop_privilege main boolean false
15441 .cindex "unprivileged delivery"
15442 .cindex "delivery" "unprivileged"
15443 If this option is set true, Exim drops its root privilege at the start of a
15444 delivery process, and runs as the Exim user throughout. This severely restricts
15445 the kinds of local delivery that are possible, but is viable in certain types
15446 of configuration. There is a discussion about the use of root privilege in
15447 chapter &<<CHAPsecurity>>&.
15448
15449 .option deliver_queue_load_max main fixed-point unset
15450 .cindex "load average"
15451 .cindex "queue runner" "abandoning"
15452 When this option is set, a queue run is abandoned if the system load average
15453 becomes greater than the value of the option. The option has no effect on
15454 ancient operating systems on which Exim cannot determine the load average.
15455 See also &%queue_only_load%& and &%smtp_load_reserve%&.
15456
15457
15458 .option delivery_date_remove main boolean true
15459 .cindex "&'Delivery-date:'& header line"
15460 Exim's transports have an option for adding a &'Delivery-date:'& header to a
15461 message when it is delivered, in exactly the same way as &'Return-path:'& is
15462 handled. &'Delivery-date:'& records the actual time of delivery. Such headers
15463 should not be present in incoming messages, and this option causes them to be
15464 removed at the time the message is received, to avoid any problems that might
15465 occur when a delivered message is subsequently sent on to some other recipient.
15466
15467 .option disable_fsync main boolean false
15468 .cindex "&[fsync()]&, disabling"
15469 This option is available only if Exim was built with the compile-time option
15470 ENABLE_DISABLE_FSYNC. When this is not set, a reference to &%disable_fsync%& in
15471 a runtime configuration generates an &"unknown option"& error. You should not
15472 build Exim with ENABLE_DISABLE_FSYNC or set &%disable_fsync%& unless you
15473 really, really, really understand what you are doing. &'No pre-compiled
15474 distributions of Exim should ever make this option available.'&
15475
15476 When &%disable_fsync%& is set true, Exim no longer calls &[fsync()]& to force
15477 updated files' data to be written to disc before continuing. Unexpected events
15478 such as crashes and power outages may cause data to be lost or scrambled.
15479 Here be Dragons. &*Beware.*&
15480
15481
15482 .option disable_ipv6 main boolean false
15483 .cindex "IPv6" "disabling"
15484 If this option is set true, even if the Exim binary has IPv6 support, no IPv6
15485 activities take place. AAAA records are never looked up, and any IPv6 addresses
15486 that are listed in &%local_interfaces%&, data for the &%manualroute%& router,
15487 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
15488 to handle IPv6 literal addresses.
15489
15490
15491 .option dkim_verify_hashes main "string list" "sha256 : sha512"
15492 .cindex DKIM "selecting signature algorithms"
15493 This option gives a list of hash types which are acceptable in signatures,
15494 and an order of processing.
15495 Signatures with algorithms not in the list will be ignored.
15496
15497 Acceptable values include:
15498 .code
15499 sha1
15500 sha256
15501 sha512
15502 .endd
15503
15504 Note that the acceptance of sha1 violates RFC 8301.
15505
15506 .option dkim_verify_keytypes main "string list" "ed25519 : rsa"
15507 This option gives a list of key types which are acceptable in signatures,
15508 and an order of processing.
15509 Signatures with algorithms not in the list will be ignored.
15510
15511
15512 .option dkim_verify_min_keysizes main "string list" "rsa=1024 ed25519=250"
15513 This option gives a list of key sizes which are acceptable in signatures.
15514 The list is keyed by the algorithm type for the key; the values are in bits.
15515 Signatures with keys smaller than given by this option will fail verification.
15516
15517 The default enforces the RFC 8301 minimum key size for RSA signatures.
15518
15519 .option dkim_verify_minimal main boolean false
15520 If set to true, verification of signatures will terminate after the
15521 first success.
15522
15523 .option dkim_verify_signers main "domain list&!!" $dkim_signers
15524 .cindex DKIM "controlling calls to the ACL"
15525 This option gives a list of DKIM domains for which the DKIM ACL is run.
15526 It is expanded after the message is received; by default it runs
15527 the ACL once for each signature in the message.
15528 See section &<<SECDKIMVFY>>&.
15529
15530
15531 .option dmarc_forensic_sender main string&!! unset
15532 .option dmarc_history_file main string unset
15533 .option dmarc_tld_file main string unset
15534 .cindex DMARC "main section options"
15535 These options control DMARC processing.
15536 See section &<<SECDMARC>>& for details.
15537
15538
15539 .option dns_again_means_nonexist main "domain list&!!" unset
15540 .cindex "DNS" "&""try again""& response; overriding"
15541 DNS lookups give a &"try again"& response for the DNS errors
15542 &"non-authoritative host not found"& and &"SERVERFAIL"&. This can cause Exim to
15543 keep trying to deliver a message, or to give repeated temporary errors to
15544 incoming mail. Sometimes the effect is caused by a badly set up name server and
15545 may persist for a long time. If a domain which exhibits this problem matches
15546 anything in &%dns_again_means_nonexist%&, it is treated as if it did not exist.
15547 This option should be used with care. You can make it apply to reverse lookups
15548 by a setting such as this:
15549 .code
15550 dns_again_means_nonexist = *.in-addr.arpa
15551 .endd
15552 This option applies to all DNS lookups that Exim does. It also applies when the
15553 &[gethostbyname()]& or &[getipnodebyname()]& functions give temporary errors,
15554 since these are most likely to be caused by DNS lookup problems. The
15555 &(dnslookup)& router has some options of its own for controlling what happens
15556 when lookups for MX or SRV records give temporary errors. These more specific
15557 options are applied after this global option.
15558
15559 .option dns_check_names_pattern main string "see below"
15560 .cindex "DNS" "pre-check of name syntax"
15561 When this option is set to a non-empty string, it causes Exim to check domain
15562 names for characters that are not allowed in host names before handing them to
15563 the DNS resolver, because some resolvers give temporary errors for names that
15564 contain unusual characters. If a domain name contains any unwanted characters,
15565 a &"not found"& result is forced, and the resolver is not called. The check is
15566 done by matching the domain name against a regular expression, which is the
15567 value of this option. The default pattern is
15568 .code
15569 dns_check_names_pattern = \
15570   (?i)^(?>(?(1)\.|())[^\W_](?>[a-z0-9/-]*[^\W_])?)+$
15571 .endd
15572 which permits only letters, digits, slashes, and hyphens in components, but
15573 they must start and end with a letter or digit. Slashes are not, in fact,
15574 permitted in host names, but they are found in certain NS records (which can be
15575 accessed in Exim by using a &%dnsdb%& lookup). If you set
15576 &%allow_utf8_domains%&, you must modify this pattern, or set the option to an
15577 empty string.
15578
15579 .option dns_csa_search_limit main integer 5
15580 This option controls the depth of parental searching for CSA SRV records in the
15581 DNS, as described in more detail in section &<<SECTverifyCSA>>&.
15582
15583 .option dns_csa_use_reverse main boolean true
15584 This option controls whether or not an IP address, given as a CSA domain, is
15585 reversed and looked up in the reverse DNS, as described in more detail in
15586 section &<<SECTverifyCSA>>&.
15587
15588 .option dns_cname_loops main integer 1
15589 .cindex DNS "CNAME following"
15590 This option controls the following of CNAME chains, needed if the resolver does
15591 not do it internally.
15592 As of 2018 most should, and the default can be left.
15593 If you have an ancient one, a value of 10 is likely needed.
15594
15595 The default value of one CNAME-follow is needed
15596 thanks to the observed return for an MX request,
15597 given no MX presence but a CNAME to an A, of the CNAME.
15598
15599
15600 .option dns_dnssec_ok main integer -1
15601 .cindex "DNS" "resolver options"
15602 .cindex "DNS" "DNSSEC"
15603 If this option is set to a non-negative number then Exim will initialise the
15604 DNS resolver library to either use or not use DNSSEC, overriding the system
15605 default. A value of 0 coerces DNSSEC off, a value of 1 coerces DNSSEC on.
15606
15607 If the resolver library does not support DNSSEC then this option has no effect.
15608
15609 On Linux with glibc 2.31 or newer this is insufficient, the resolver library
15610 will default to stripping out a successful validation status.
15611 This will break a previously working Exim installation.
15612 Provided that you do trust the resolver (ie, is on localhost) you can tell
15613 glibc to pass through any successful validation with a new option in
15614 &_/etc/resolv.conf_&:
15615 .code
15616 options trust-ad
15617 .endd
15618
15619
15620 .option dns_ipv4_lookup main "domain list&!!" unset
15621 .cindex "IPv6" "DNS lookup for AAAA records"
15622 .cindex "DNS" "IPv6 lookup for AAAA records"
15623 .cindex DNS "IPv6 disabling"
15624 When Exim is compiled with IPv6 support and &%disable_ipv6%& is not set, it
15625 looks for IPv6 address records (AAAA records) as well as IPv4 address records
15626 (A records) when trying to find IP addresses for hosts, unless the host's
15627 domain matches this list.
15628
15629 This is a fudge to help with name servers that give big delays or otherwise do
15630 not work for the AAAA record type. In due course, when the world's name
15631 servers have all been upgraded, there should be no need for this option.
15632 Note that all lookups, including those done for verification, are affected;
15633 this will result in verify failure for IPv6 connections or ones using names
15634 only valid for IPv6 addresses.
15635
15636
15637 .option dns_retrans main time 0s
15638 .cindex "DNS" "resolver options"
15639 .cindex timeout "dns lookup"
15640 .cindex "DNS" timeout
15641 The options &%dns_retrans%& and &%dns_retry%& can be used to set the
15642 retransmission and retry parameters for DNS lookups. Values of zero (the
15643 defaults) leave the system default settings unchanged. The first value is the
15644 time between retries, and the second is the number of retries. It isn't
15645 totally clear exactly how these settings affect the total time a DNS lookup may
15646 take. I haven't found any documentation about timeouts on DNS lookups; these
15647 parameter values are available in the external resolver interface structure,
15648 but nowhere does it seem to describe how they are used or what you might want
15649 to set in them.
15650 See also the &%slow_lookup_log%& option.
15651
15652
15653 .option dns_retry main integer 0
15654 See &%dns_retrans%& above.
15655
15656
15657 .option dns_trust_aa main "domain list&!!" unset
15658 .cindex "DNS" "resolver options"
15659 .cindex "DNS" "DNSSEC"
15660 If this option is set then lookup results marked with the AA bit
15661 (Authoritative Answer) are trusted the same way as if they were
15662 DNSSEC-verified. The authority section's name of the answer must
15663 match with this expanded domain list.
15664
15665 Use this option only if you talk directly to a resolver that is
15666 authoritative for some zones and does not set the AD (Authentic Data)
15667 bit in the answer. Some DNS servers may have an configuration option to
15668 mark the answers from their own zones as verified (they set the AD bit).
15669 Others do not have this option. It is considered as poor practice using
15670 a resolver that is an authoritative server for some zones.
15671
15672 Use this option only if you really have to (e.g. if you want
15673 to use DANE for remote delivery to a server that is listed in the DNS
15674 zones that your resolver is authoritative for).
15675
15676 If the DNS answer packet has the AA bit set and contains resource record
15677 in the answer section, the name of the first NS record appearing in the
15678 authority section is compared against the list. If the answer packet is
15679 authoritative but the answer section is empty, the name of the first SOA
15680 record in the authoritative section is used instead.
15681
15682 .cindex "DNS" "resolver options"
15683 .option dns_use_edns0 main integer -1
15684 .cindex "DNS" "resolver options"
15685 .cindex "DNS" "EDNS0"
15686 .cindex "DNS" "OpenBSD
15687 If this option is set to a non-negative number then Exim will initialise the
15688 DNS resolver library to either use or not use EDNS0 extensions, overriding
15689 the system default. A value of 0 coerces EDNS0 off, a value of 1 coerces EDNS0
15690 on.
15691
15692 If the resolver library does not support EDNS0 then this option has no effect.
15693
15694 OpenBSD's asr resolver routines are known to ignore the EDNS0 option; this
15695 means that DNSSEC will not work with Exim on that platform either, unless Exim
15696 is linked against an alternative DNS client library.
15697
15698
15699 .option drop_cr main boolean false
15700 This is an obsolete option that is now a no-op. It used to affect the way Exim
15701 handled CR and LF characters in incoming messages. What happens now is
15702 described in section &<<SECTlineendings>>&.
15703
15704 .option dsn_advertise_hosts main "host list&!!" unset
15705 .cindex "bounce messages" "success"
15706 .cindex "DSN" "success"
15707 .cindex "Delivery Status Notification" "success"
15708 .cindex "ESMTP extensions" DSN
15709 DSN extensions (RFC3461) will be advertised in the EHLO message to,
15710 and accepted from, these hosts.
15711 Hosts may use the NOTIFY and ENVID options on RCPT TO commands,
15712 and RET and ORCPT options on MAIL FROM commands.
15713 A NOTIFY=SUCCESS option requests success-DSN messages.
15714 A NOTIFY= option with no argument requests that no delay or failure DSNs
15715 are sent.
15716 &*Note*&: Supplying success-DSN messages has been criticised
15717 on privacy grounds; it can leak details of internal forwarding.
15718
15719 .option dsn_from main "string&!!" "see below"
15720 .cindex "&'From:'& header line" "in bounces"
15721 .cindex "bounce messages" "&'From:'& line, specifying"
15722 This option can be used to vary the contents of &'From:'& header lines in
15723 bounces and other automatically generated messages (&"Delivery Status
15724 Notifications"& &-- hence the name of the option). The default setting is:
15725 .code
15726 dsn_from = Mail Delivery System <Mailer-Daemon@$qualify_domain>
15727 .endd
15728 The value is expanded every time it is needed. If the expansion fails, a
15729 panic is logged, and the default value is used.
15730
15731 .option envelope_to_remove main boolean true
15732 .cindex "&'Envelope-to:'& header line"
15733 Exim's transports have an option for adding an &'Envelope-to:'& header to a
15734 message when it is delivered, in exactly the same way as &'Return-path:'& is
15735 handled. &'Envelope-to:'& records the original recipient address from the
15736 message's envelope that caused the delivery to happen. Such headers should not
15737 be present in incoming messages, and this option causes them to be removed at
15738 the time the message is received, to avoid any problems that might occur when a
15739 delivered message is subsequently sent on to some other recipient.
15740
15741
15742 .option errors_copy main "string list&!!" unset
15743 .cindex "bounce message" "copy to other address"
15744 .cindex "copy of bounce message"
15745 Setting this option causes Exim to send bcc copies of bounce messages that it
15746 generates to other addresses. &*Note*&: This does not apply to bounce messages
15747 coming from elsewhere. The value of the option is a colon-separated list of
15748 items. Each item consists of a pattern, terminated by white space, followed by
15749 a comma-separated list of email addresses. If a pattern contains spaces, it
15750 must be enclosed in double quotes.
15751
15752 Each pattern is processed in the same way as a single item in an address list
15753 (see section &<<SECTaddresslist>>&). When a pattern matches the recipient of
15754 the bounce message, the message is copied to the addresses on the list. The
15755 items are scanned in order, and once a matching one is found, no further items
15756 are examined. For example:
15757 .code
15758 errors_copy = spqr@mydomain   postmaster@mydomain.example :\
15759               rqps@mydomain   hostmaster@mydomain.example,\
15760                               postmaster@mydomain.example
15761 .endd
15762 .vindex "&$domain$&"
15763 .vindex "&$local_part$&"
15764 The address list is expanded before use. The expansion variables &$local_part$&
15765 and &$domain$& are set from the original recipient of the error message, and if
15766 there was any wildcard matching in the pattern, the expansion
15767 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%errors_copy%&"
15768 variables &$0$&, &$1$&, etc. are set in the normal way.
15769
15770
15771 .option errors_reply_to main string unset
15772 .cindex "bounce message" "&'Reply-to:'& in"
15773 By default, Exim's bounce and delivery warning messages contain the header line
15774 .display
15775 &`From: Mail Delivery System <Mailer-Daemon@`&&'qualify-domain'&&`>`&
15776 .endd
15777 .oindex &%quota_warn_message%&
15778 where &'qualify-domain'& is the value of the &%qualify_domain%& option.
15779 A warning message that is generated by the &%quota_warn_message%& option in an
15780 &(appendfile)& transport may contain its own &'From:'& header line that
15781 overrides the default.
15782
15783 Experience shows that people reply to bounce messages. If the
15784 &%errors_reply_to%& option is set, a &'Reply-To:'& header is added to bounce
15785 and warning messages. For example:
15786 .code
15787 errors_reply_to = postmaster@my.domain.example
15788 .endd
15789 The value of the option is not expanded. It must specify a valid RFC 2822
15790 address. However, if a warning message that is generated by the
15791 &%quota_warn_message%& option in an &(appendfile)& transport contain its
15792 own &'Reply-To:'& header line, the value of the &%errors_reply_to%& option is
15793 not used.
15794
15795
15796 .option event_action main string&!! unset
15797 .cindex events
15798 This option declares a string to be expanded for Exim's events mechanism.
15799 For details see chapter &<<CHAPevents>>&.
15800
15801
15802 .option exim_group main string "compile-time configured"
15803 .cindex "gid (group id)" "Exim's own"
15804 .cindex "Exim group"
15805 This option changes the gid under which Exim runs when it gives up root
15806 privilege. The default value is compiled into the binary. The value of this
15807 option is used only when &%exim_user%& is also set. Unless it consists entirely
15808 of digits, the string is looked up using &[getgrnam()]&, and failure causes a
15809 configuration error. See chapter &<<CHAPsecurity>>& for a discussion of
15810 security issues.
15811
15812
15813 .option exim_path main string "see below"
15814 .cindex "Exim binary, path name"
15815 This option specifies the path name of the Exim binary, which is used when Exim
15816 needs to re-exec itself. The default is set up to point to the file &'exim'& in
15817 the directory configured at compile time by the BIN_DIRECTORY setting. It
15818 is necessary to change &%exim_path%& if, exceptionally, Exim is run from some
15819 other place.
15820 &*Warning*&: Do not use a macro to define the value of this option, because
15821 you will break those Exim utilities that scan the configuration file to find
15822 where the binary is. (They then use the &%-bP%& option to extract option
15823 settings such as the value of &%spool_directory%&.)
15824
15825
15826 .option exim_user main string "compile-time configured"
15827 .cindex "uid (user id)" "Exim's own"
15828 .cindex "Exim user"
15829 This option changes the uid under which Exim runs when it gives up root
15830 privilege. The default value is compiled into the binary. Ownership of the run
15831 time configuration file and the use of the &%-C%& and &%-D%& command line
15832 options is checked against the values in the binary, not what is set here.
15833
15834 Unless it consists entirely of digits, the string is looked up using
15835 &[getpwnam()]&, and failure causes a configuration error. If &%exim_group%& is
15836 not also supplied, the gid is taken from the result of &[getpwnam()]& if it is
15837 used. See chapter &<<CHAPsecurity>>& for a discussion of security issues.
15838
15839
15840 .option exim_version main string "current version"
15841 .cindex "Exim version"
15842 .cindex customizing "version number"
15843 .cindex "version number of Exim" override
15844 This option overrides the &$version_number$&/&$exim_version$& that Exim reports in
15845 various places.  Use with care; this may fool stupid security scanners.
15846
15847
15848 .option extra_local_interfaces main "string list" unset
15849 This option defines network interfaces that are to be considered local when
15850 routing, but which are not used for listening by the daemon. See section
15851 &<<SECTreclocipadd>>& for details.
15852
15853
15854 . Allow this long option name to split; give it unsplit as a fifth argument
15855 . for the automatic .oindex that is generated by .option.
15856
15857 .option "extract_addresses_remove_arguments" main boolean true &&&
15858          extract_addresses_remove_arguments
15859 .oindex "&%-t%&"
15860 .cindex "command line" "addresses with &%-t%&"
15861 .cindex "Sendmail compatibility" "&%-t%& option"
15862 According to some Sendmail documentation (Sun, IRIX, HP-UX), if any addresses
15863 are present on the command line when the &%-t%& option is used to build an
15864 envelope from a message's &'To:'&, &'Cc:'& and &'Bcc:'& headers, the command
15865 line addresses are removed from the recipients list. This is also how Smail
15866 behaves. However, other Sendmail documentation (the O'Reilly book) states that
15867 command line addresses are added to those obtained from the header lines. When
15868 &%extract_addresses_remove_arguments%& is true (the default), Exim subtracts
15869 argument headers. If it is set false, Exim adds rather than removes argument
15870 addresses.
15871
15872
15873 .option finduser_retries main integer 0
15874 .cindex "NIS, retrying user lookups"
15875 On systems running NIS or other schemes in which user and group information is
15876 distributed from a remote system, there can be times when &[getpwnam()]& and
15877 related functions fail, even when given valid data, because things time out.
15878 Unfortunately these failures cannot be distinguished from genuine &"not found"&
15879 errors. If &%finduser_retries%& is set greater than zero, Exim will try that
15880 many extra times to find a user or a group, waiting for one second between
15881 retries.
15882
15883 .cindex "&_/etc/passwd_&" "multiple reading of"
15884 You should not set this option greater than zero if your user information is in
15885 a traditional &_/etc/passwd_& file, because it will cause Exim needlessly to
15886 search the file multiple times for non-existent users, and also cause delay.
15887
15888
15889
15890 .option freeze_tell main "string list, comma separated" unset
15891 .cindex "freezing messages" "sending a message when freezing"
15892 On encountering certain errors, or when configured to do so in a system filter,
15893 ACL, or special router, Exim freezes a message. This means that no further
15894 delivery attempts take place until an administrator thaws the message, or the
15895 &%auto_thaw%&, &%ignore_bounce_errors_after%&, or &%timeout_frozen_after%&
15896 feature cause it to be processed. If &%freeze_tell%& is set, Exim generates a
15897 warning message whenever it freezes something, unless the message it is
15898 freezing is a locally-generated bounce message. (Without this exception there
15899 is the possibility of looping.) The warning message is sent to the addresses
15900 supplied as the comma-separated value of this option. If several of the
15901 message's addresses cause freezing, only a single message is sent. If the
15902 freezing was automatic, the reason(s) for freezing can be found in the message
15903 log. If you configure freezing in a filter or ACL, you must arrange for any
15904 logging that you require.
15905
15906
15907 .option gecos_name main string&!! unset
15908 .cindex "HP-UX"
15909 .cindex "&""gecos""& field, parsing"
15910 Some operating systems, notably HP-UX, use the &"gecos"& field in the system
15911 password file to hold other information in addition to users' real names. Exim
15912 looks up this field for use when it is creating &'Sender:'& or &'From:'&
15913 headers. If either &%gecos_pattern%& or &%gecos_name%& are unset, the contents
15914 of the field are used unchanged, except that, if an ampersand is encountered,
15915 it is replaced by the user's login name with the first character forced to
15916 upper case, since this is a convention that is observed on many systems.
15917
15918 When these options are set, &%gecos_pattern%& is treated as a regular
15919 expression that is to be applied to the field (again with && replaced by the
15920 login name), and if it matches, &%gecos_name%& is expanded and used as the
15921 user's name.
15922
15923 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%gecos_name%&"
15924 Numeric variables such as &$1$&, &$2$&, etc. can be used in the expansion to
15925 pick up sub-fields that were matched by the pattern. In HP-UX, where the user's
15926 name terminates at the first comma, the following can be used:
15927 .code
15928 gecos_pattern = ([^,]*)
15929 gecos_name = $1
15930 .endd
15931
15932 .option gecos_pattern main string unset
15933 See &%gecos_name%& above.
15934
15935
15936 .option gnutls_compat_mode main boolean unset
15937 This option controls whether GnuTLS is used in compatibility mode in an Exim
15938 server. This reduces security slightly, but improves interworking with older
15939 implementations of TLS.
15940
15941
15942 .option gnutls_allow_auto_pkcs11 main boolean unset
15943 This option will let GnuTLS (2.12.0 or later) autoload PKCS11 modules with
15944 the p11-kit configuration files in &_/etc/pkcs11/modules/_&.
15945
15946 See
15947 &url(https://www.gnutls.org/manual/gnutls.html#Smart-cards-and-HSMs)
15948 for documentation.
15949
15950
15951
15952 .option headers_charset main string "see below"
15953 This option sets a default character set for translating from encoded MIME
15954 &"words"& in header lines, when referenced by an &$h_xxx$& expansion item. The
15955 default is the value of HEADERS_CHARSET in &_Local/Makefile_&. The
15956 ultimate default is ISO-8859-1. For more details see the description of header
15957 insertions in section &<<SECTexpansionitems>>&.
15958
15959
15960
15961 .option header_maxsize main integer "see below"
15962 .cindex "header section" "maximum size of"
15963 .cindex "limit" "size of message header section"
15964 This option controls the overall maximum size of a message's header
15965 section. The default is the value of HEADER_MAXSIZE in
15966 &_Local/Makefile_&; the default for that is 1M. Messages with larger header
15967 sections are rejected.
15968
15969
15970 .option header_line_maxsize main integer 0
15971 .cindex "header lines" "maximum size of"
15972 .cindex "limit" "size of one header line"
15973 This option limits the length of any individual header line in a message, after
15974 all the continuations have been joined together. Messages with individual
15975 header lines that are longer than the limit are rejected. The default value of
15976 zero means &"no limit"&.
15977
15978
15979
15980
15981 .option helo_accept_junk_hosts main "host list&!!" unset
15982 .cindex "HELO" "accepting junk data"
15983 .cindex "EHLO" "accepting junk data"
15984 Exim checks the syntax of HELO and EHLO commands for incoming SMTP
15985 mail, and gives an error response for invalid data. Unfortunately, there are
15986 some SMTP clients that send syntactic junk. They can be accommodated by setting
15987 this option. Note that this is a syntax check only. See &%helo_verify_hosts%&
15988 if you want to do semantic checking.
15989 See also &%helo_allow_chars%& for a way of extending the permitted character
15990 set.
15991
15992
15993 .option helo_allow_chars main string unset
15994 .cindex "HELO" "underscores in"
15995 .cindex "EHLO" "underscores in"
15996 .cindex "underscore in EHLO/HELO"
15997 This option can be set to a string of rogue characters that are permitted in
15998 all EHLO and HELO names in addition to the standard letters, digits,
15999 hyphens, and dots. If you really must allow underscores, you can set
16000 .code
16001 helo_allow_chars = _
16002 .endd
16003 Note that the value is one string, not a list.
16004
16005
16006 .option helo_lookup_domains main "domain list&!!" &`@:@[]`&
16007 .cindex "HELO" "forcing reverse lookup"
16008 .cindex "EHLO" "forcing reverse lookup"
16009 If the domain given by a client in a HELO or EHLO command matches this
16010 list, a reverse lookup is done in order to establish the host's true name. The
16011 default forces a lookup if the client host gives the server's name or any of
16012 its IP addresses (in brackets), something that broken clients have been seen to
16013 do.
16014
16015
16016 .option helo_try_verify_hosts main "host list&!!" unset
16017 .cindex "HELO verifying" "optional"
16018 .cindex "EHLO" "verifying, optional"
16019 By default, Exim just checks the syntax of HELO and EHLO commands (see
16020 &%helo_accept_junk_hosts%& and &%helo_allow_chars%&). However, some sites like
16021 to do more extensive checking of the data supplied by these commands. The ACL
16022 condition &`verify = helo`& is provided to make this possible.
16023 Formerly, it was necessary also to set this option (&%helo_try_verify_hosts%&)
16024 to force the check to occur. From release 4.53 onwards, this is no longer
16025 necessary. If the check has not been done before &`verify = helo`& is
16026 encountered, it is done at that time. Consequently, this option is obsolete.
16027 Its specification is retained here for backwards compatibility.
16028
16029 When an EHLO or HELO command is received, if the calling host matches
16030 &%helo_try_verify_hosts%&, Exim checks that the host name given in the HELO or
16031 EHLO command either:
16032
16033 .ilist
16034 is an IP literal matching the calling address of the host, or
16035 .next
16036 .cindex "DNS" "reverse lookup"
16037 .cindex "reverse DNS lookup"
16038 matches the host name that Exim obtains by doing a reverse lookup of the
16039 calling host address, or
16040 .next
16041 when looked up in DNS yields the calling host address.
16042 .endlist
16043
16044 However, the EHLO or HELO command is not rejected if any of the checks
16045 fail. Processing continues, but the result of the check is remembered, and can
16046 be detected later in an ACL by the &`verify = helo`& condition.
16047
16048 If DNS was used for successful verification, the variable
16049 .cindex "DNS" "DNSSEC"
16050 &$helo_verify_dnssec$& records the DNSSEC status of the lookups.
16051
16052 .option helo_verify_hosts main "host list&!!" unset
16053 .cindex "HELO verifying" "mandatory"
16054 .cindex "EHLO" "verifying, mandatory"
16055 Like &%helo_try_verify_hosts%&, this option is obsolete, and retained only for
16056 backwards compatibility. For hosts that match this option, Exim checks the host
16057 name given in the HELO or EHLO in the same way as for
16058 &%helo_try_verify_hosts%&. If the check fails, the HELO or EHLO command is
16059 rejected with a 550 error, and entries are written to the main and reject logs.
16060 If a MAIL command is received before EHLO or HELO, it is rejected with a 503
16061 error.
16062
16063 .option hold_domains main "domain list&!!" unset
16064 .cindex "domain" "delaying delivery"
16065 .cindex "delivery" "delaying certain domains"
16066 This option allows mail for particular domains to be held in the queue
16067 manually. The option is overridden if a message delivery is forced with the
16068 &%-M%&, &%-qf%&, &%-Rf%& or &%-Sf%& options, and also while testing or
16069 verifying addresses using &%-bt%& or &%-bv%&. Otherwise, if a domain matches an
16070 item in &%hold_domains%&, no routing or delivery for that address is done, and
16071 it is deferred every time the message is looked at.
16072
16073 This option is intended as a temporary operational measure for delaying the
16074 delivery of mail while some problem is being sorted out, or some new
16075 configuration tested. If you just want to delay the processing of some
16076 domains until a queue run occurs, you should use &%queue_domains%& or
16077 &%queue_smtp_domains%&, not &%hold_domains%&.
16078
16079 A setting of &%hold_domains%& does not override Exim's code for removing
16080 messages from the queue if they have been there longer than the longest retry
16081 time in any retry rule. If you want to hold messages for longer than the normal
16082 retry times, insert a dummy retry rule with a long retry time.
16083
16084
16085 .option host_lookup main "host list&!!" unset
16086 .cindex "host name" "lookup, forcing"
16087 Exim does not look up the name of a calling host from its IP address unless it
16088 is required to compare against some host list, or the host matches
16089 &%helo_try_verify_hosts%& or &%helo_verify_hosts%&, or the host matches this
16090 option (which normally contains IP addresses rather than host names). The
16091 default configuration file contains
16092 .code
16093 host_lookup = *
16094 .endd
16095 which causes a lookup to happen for all hosts. If the expense of these lookups
16096 is felt to be too great, the setting can be changed or removed.
16097
16098 After a successful reverse lookup, Exim does a forward lookup on the name it
16099 has obtained, to verify that it yields the IP address that it started with. If
16100 this check fails, Exim behaves as if the name lookup failed.
16101
16102 .vindex "&$host_lookup_failed$&"
16103 .vindex "&$sender_host_name$&"
16104 After any kind of failure, the host name (in &$sender_host_name$&) remains
16105 unset, and &$host_lookup_failed$& is set to the string &"1"&. See also
16106 &%dns_again_means_nonexist%&, &%helo_lookup_domains%&, and
16107 &`verify = reverse_host_lookup`& in ACLs.
16108
16109
16110 .option host_lookup_order main "string list" &`bydns:byaddr`&
16111 This option specifies the order of different lookup methods when Exim is trying
16112 to find a host name from an IP address. The default is to do a DNS lookup
16113 first, and then to try a local lookup (using &[gethostbyaddr()]& or equivalent)
16114 if that fails. You can change the order of these lookups, or omit one entirely,
16115 if you want.
16116
16117 &*Warning*&: The &"byaddr"& method does not always yield aliases when there are
16118 multiple PTR records in the DNS and the IP address is not listed in
16119 &_/etc/hosts_&. Different operating systems give different results in this
16120 case. That is why the default tries a DNS lookup first.
16121
16122
16123
16124 .option host_reject_connection main "host list&!!" unset
16125 .cindex "host" "rejecting connections from"
16126 If this option is set, incoming SMTP calls from the hosts listed are rejected
16127 as soon as the connection is made.
16128 This option is obsolete, and retained only for backward compatibility, because
16129 nowadays the ACL specified by &%acl_smtp_connect%& can also reject incoming
16130 connections immediately.
16131
16132 The ability to give an immediate rejection (either by this option or using an
16133 ACL) is provided for use in unusual cases. Many hosts will just try again,
16134 sometimes without much delay. Normally, it is better to use an ACL to reject
16135 incoming messages at a later stage, such as after RCPT commands. See
16136 chapter &<<CHAPACL>>&.
16137
16138
16139 .option hosts_connection_nolog main "host list&!!" unset
16140 .cindex "host" "not logging connections from"
16141 This option defines a list of hosts for which connection logging does not
16142 happen, even though the &%smtp_connection%& log selector is set. For example,
16143 you might want not to log SMTP connections from local processes, or from
16144 127.0.0.1, or from your local LAN. This option is consulted in the main loop of
16145 the daemon; you should therefore strive to restrict its value to a short inline
16146 list of IP addresses and networks. To disable logging SMTP connections from
16147 local processes, you must create a host list with an empty item. For example:
16148 .code
16149 hosts_connection_nolog = :
16150 .endd
16151 If the &%smtp_connection%& log selector is not set, this option has no effect.
16152
16153
16154
16155 .option hosts_proxy main "host list&!!" unset
16156 .cindex proxy "proxy protocol"
16157 This option enables use of Proxy Protocol proxies for incoming
16158 connections.  For details see section &<<SECTproxyInbound>>&.
16159
16160
16161 .option hosts_treat_as_local main "domain list&!!" unset
16162 .cindex "local host" "domains treated as"
16163 .cindex "host" "treated as local"
16164 If this option is set, any host names that match the domain list are treated as
16165 if they were the local host when Exim is scanning host lists obtained from MX
16166 records
16167 or other sources. Note that the value of this option is a domain list, not a
16168 host list, because it is always used to check host names, not IP addresses.
16169
16170 This option also applies when Exim is matching the special items
16171 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`& in a domain list (see
16172 section &<<SECTdomainlist>>&), and when checking the &%hosts%& option in the
16173 &(smtp)& transport for the local host (see the &%allow_localhost%& option in
16174 that transport). See also &%local_interfaces%&, &%extra_local_interfaces%&, and
16175 chapter &<<CHAPinterfaces>>&, which contains a discussion about local network
16176 interfaces and recognizing the local host.
16177
16178
16179 .option ibase_servers main "string list" unset
16180 .cindex "InterBase" "server list"
16181 This option provides a list of InterBase servers and associated connection data,
16182 to be used in conjunction with &(ibase)& lookups (see section &<<SECID72>>&).
16183 The option is available only if Exim has been built with InterBase support.
16184
16185
16186
16187 .option ignore_bounce_errors_after main time 10w
16188 .cindex "bounce message" "discarding"
16189 .cindex "discarding bounce message"
16190 This option affects the processing of bounce messages that cannot be delivered,
16191 that is, those that suffer a permanent delivery failure. (Bounce messages that
16192 suffer temporary delivery failures are of course retried in the usual way.)
16193
16194 After a permanent delivery failure, bounce messages are frozen,
16195 because there is no sender to whom they can be returned. When a frozen bounce
16196 message has been in the queue for more than the given time, it is unfrozen at
16197 the next queue run, and a further delivery is attempted. If delivery fails
16198 again, the bounce message is discarded. This makes it possible to keep failed
16199 bounce messages around for a shorter time than the normal maximum retry time
16200 for frozen messages. For example,
16201 .code
16202 ignore_bounce_errors_after = 12h
16203 .endd
16204 retries failed bounce message deliveries after 12 hours, discarding any further
16205 failures. If the value of this option is set to a zero time period, bounce
16206 failures are discarded immediately. Setting a very long time (as in the default
16207 value) has the effect of disabling this option. For ways of automatically
16208 dealing with other kinds of frozen message, see &%auto_thaw%& and
16209 &%timeout_frozen_after%&.
16210
16211
16212 .option ignore_fromline_hosts main "host list&!!" unset
16213 .cindex "&""From""& line"
16214 .cindex "UUCP" "&""From""& line"
16215 Some broken SMTP clients insist on sending a UUCP-like &"From&~"& line before
16216 the headers of a message. By default this is treated as the start of the
16217 message's body, which means that any following headers are not recognized as
16218 such. Exim can be made to ignore it by setting &%ignore_fromline_hosts%& to
16219 match those hosts that insist on sending it. If the sender is actually a local
16220 process rather than a remote host, and is using &%-bs%& to inject the messages,
16221 &%ignore_fromline_local%& must be set to achieve this effect.
16222
16223
16224 .option ignore_fromline_local main boolean false
16225 See &%ignore_fromline_hosts%& above.
16226
16227 .option keep_environment main "string list" unset
16228 .cindex "environment" "values from"
16229 This option contains a string list of environment variables to keep.
16230 You have to trust these variables or you have to be sure that
16231 these variables do not impose any security risk. Keep in mind that
16232 during the startup phase Exim is running with an effective UID 0 in most
16233 installations. As the default value is an empty list, the default
16234 environment for using libraries, running embedded Perl code, or running
16235 external binaries is empty, and does not not even contain PATH or HOME.
16236
16237 Actually the list is interpreted as a list of patterns
16238 (&<<SECTlistexpand>>&), except that it is not expanded first.
16239
16240 WARNING: Macro substitution is still done first, so having a macro
16241 FOO and having FOO_HOME in your &%keep_environment%& option may have
16242 unexpected results. You may work around this using a regular expression
16243 that does not match the macro name: ^[F]OO_HOME$.
16244
16245 Current versions of Exim issue a warning during startup if you do not mention
16246 &%keep_environment%& in your runtime configuration file and if your
16247 current environment is not empty. Future versions may not issue that warning
16248 anymore.
16249
16250 See the &%add_environment%& main config option for a way to set
16251 environment variables to a fixed value.  The environment for &(pipe)&
16252 transports is handled separately, see section &<<SECTpipeenv>>& for
16253 details.
16254
16255
16256 .option keep_malformed main time 4d
16257 This option specifies the length of time to keep messages whose spool files
16258 have been corrupted in some way. This should, of course, never happen. At the
16259 next attempt to deliver such a message, it gets removed. The incident is
16260 logged.
16261
16262
16263 .option ldap_ca_cert_dir main string unset
16264 .cindex "LDAP", "TLS CA certificate directory"
16265 .cindex certificate "directory for LDAP"
16266 This option indicates which directory contains CA certificates for verifying
16267 a TLS certificate presented by an LDAP server.
16268 While Exim does not provide a default value, your SSL library may.
16269 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
16270 and constrained to be a directory.
16271
16272
16273 .option ldap_ca_cert_file main string unset
16274 .cindex "LDAP", "TLS CA certificate file"
16275 .cindex certificate "file for LDAP"
16276 This option indicates which file contains CA certificates for verifying
16277 a TLS certificate presented by an LDAP server.
16278 While Exim does not provide a default value, your SSL library may.
16279 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
16280 and constrained to be a file.
16281
16282
16283 .option ldap_cert_file main string unset
16284 .cindex "LDAP" "TLS client certificate file"
16285 .cindex certificate "file for LDAP"
16286 This option indicates which file contains an TLS client certificate which
16287 Exim should present to the LDAP server during TLS negotiation.
16288 Should be used together with &%ldap_cert_key%&.
16289
16290
16291 .option ldap_cert_key main string unset
16292 .cindex "LDAP" "TLS client key file"
16293 .cindex certificate "key for LDAP"
16294 This option indicates which file contains the secret/private key to use
16295 to prove identity to the LDAP server during TLS negotiation.
16296 Should be used together with &%ldap_cert_file%&, which contains the
16297 identity to be proven.
16298
16299
16300 .option ldap_cipher_suite main string unset
16301 .cindex "LDAP" "TLS cipher suite"
16302 This controls the TLS cipher-suite negotiation during TLS negotiation with
16303 the LDAP server.  See &<<SECTreqciphssl>>& for more details of the format of
16304 cipher-suite options with OpenSSL (as used by LDAP client libraries).
16305
16306
16307 .option ldap_default_servers main "string list" unset
16308 .cindex "LDAP" "default servers"
16309 This option provides a list of LDAP servers which are tried in turn when an
16310 LDAP query does not contain a server. See section &<<SECTforldaque>>& for
16311 details of LDAP queries. This option is available only when Exim has been built
16312 with LDAP support.
16313
16314
16315 .option ldap_require_cert main string unset.
16316 .cindex "LDAP" "policy for LDAP server TLS cert presentation"
16317 This should be one of the values "hard", "demand", "allow", "try" or "never".
16318 A value other than one of these is interpreted as "never".
16319 See the entry "TLS_REQCERT" in your system man page for ldap.conf(5).
16320 Although Exim does not set a default, the LDAP library probably defaults
16321 to hard/demand.
16322
16323
16324 .option ldap_start_tls main boolean false
16325 .cindex "LDAP" "whether or not to negotiate TLS"
16326 If set, Exim will attempt to negotiate TLS with the LDAP server when
16327 connecting on a regular LDAP port.  This is the LDAP equivalent of SMTP's
16328 "STARTTLS".  This is distinct from using "ldaps", which is the LDAP form
16329 of SSL-on-connect.
16330 In the event of failure to negotiate TLS, the action taken is controlled
16331 by &%ldap_require_cert%&.
16332 This option is ignored for &`ldapi`& connections.
16333
16334
16335 .option ldap_version main integer unset
16336 .cindex "LDAP" "protocol version, forcing"
16337 This option can be used to force Exim to set a specific protocol version for
16338 LDAP. If it option is unset, it is shown by the &%-bP%& command line option as
16339 -1. When this is the case, the default is 3 if LDAP_VERSION3 is defined in
16340 the LDAP headers; otherwise it is 2. This option is available only when Exim
16341 has been built with LDAP support.
16342
16343
16344
16345 .option local_from_check main boolean true
16346 .cindex "&'Sender:'& header line" "disabling addition of"
16347 .cindex "&'From:'& header line" "disabling checking of"
16348 When a message is submitted locally (that is, not over a TCP/IP connection) by
16349 an untrusted user, Exim removes any existing &'Sender:'& header line, and
16350 checks that the &'From:'& header line matches the login of the calling user and
16351 the domain specified by &%qualify_domain%&.
16352
16353 &*Note*&: An unqualified address (no domain) in the &'From:'& header in a
16354 locally submitted message is automatically qualified by Exim, unless the
16355 &%-bnq%& command line option is used.
16356
16357 You can use &%local_from_prefix%& and &%local_from_suffix%& to permit affixes
16358 on the local part. If the &'From:'& header line does not match, Exim adds a
16359 &'Sender:'& header with an address constructed from the calling user's login
16360 and the default qualify domain.
16361
16362 If &%local_from_check%& is set false, the &'From:'& header check is disabled,
16363 and no &'Sender:'& header is ever added. If, in addition, you want to retain
16364 &'Sender:'& header lines supplied by untrusted users, you must also set
16365 &%local_sender_retain%& to be true.
16366
16367 .cindex "envelope from"
16368 .cindex "envelope sender"
16369 These options affect only the header lines in the message. The envelope sender
16370 is still forced to be the login id at the qualify domain unless
16371 &%untrusted_set_sender%& permits the user to supply an envelope sender.
16372
16373 For messages received over TCP/IP, an ACL can specify &"submission mode"& to
16374 request similar header line checking. See section &<<SECTthesenhea>>&, which
16375 has more details about &'Sender:'& processing.
16376
16377
16378
16379
16380 .option local_from_prefix main string unset
16381 When Exim checks the &'From:'& header line of locally submitted messages for
16382 matching the login id (see &%local_from_check%& above), it can be configured to
16383 ignore certain prefixes and suffixes in the local part of the address. This is
16384 done by setting &%local_from_prefix%& and/or &%local_from_suffix%& to
16385 appropriate lists, in the same form as the &%local_part_prefix%& and
16386 &%local_part_suffix%& router options (see chapter &<<CHAProutergeneric>>&). For
16387 example, if
16388 .code
16389 local_from_prefix = *-
16390 .endd
16391 is set, a &'From:'& line containing
16392 .code
16393 From: anything-user@your.domain.example
16394 .endd
16395 will not cause a &'Sender:'& header to be added if &'user@your.domain.example'&
16396 matches the actual sender address that is constructed from the login name and
16397 qualify domain.
16398
16399
16400 .option local_from_suffix main string unset
16401 See &%local_from_prefix%& above.
16402
16403
16404 .option local_interfaces main "string list" "see below"
16405 This option controls which network interfaces are used by the daemon for
16406 listening; they are also used to identify the local host when routing. Chapter
16407 &<<CHAPinterfaces>>& contains a full description of this option and the related
16408 options &%daemon_smtp_ports%&, &%extra_local_interfaces%&,
16409 &%hosts_treat_as_local%&, and &%tls_on_connect_ports%&. The default value for
16410 &%local_interfaces%& is
16411 .code
16412 local_interfaces = 0.0.0.0
16413 .endd
16414 when Exim is built without IPv6 support; otherwise it is
16415 .code
16416 local_interfaces = <; ::0 ; 0.0.0.0
16417 .endd
16418
16419 .option local_scan_timeout main time 5m
16420 .cindex "timeout" "for &[local_scan()]& function"
16421 .cindex "&[local_scan()]& function" "timeout"
16422 This timeout applies to the &[local_scan()]& function (see chapter
16423 &<<CHAPlocalscan>>&). Zero means &"no timeout"&. If the timeout is exceeded,
16424 the incoming message is rejected with a temporary error if it is an SMTP
16425 message. For a non-SMTP message, the message is dropped and Exim ends with a
16426 non-zero code. The incident is logged on the main and reject logs.
16427
16428
16429
16430 .option local_sender_retain main boolean false
16431 .cindex "&'Sender:'& header line" "retaining from local submission"
16432 When a message is submitted locally (that is, not over a TCP/IP connection) by
16433 an untrusted user, Exim removes any existing &'Sender:'& header line. If you
16434 do not want this to happen, you must set &%local_sender_retain%&, and you must
16435 also set &%local_from_check%& to be false (Exim will complain if you do not).
16436 See also the ACL modifier &`control = suppress_local_fixups`&. Section
16437 &<<SECTthesenhea>>& has more details about &'Sender:'& processing.
16438
16439
16440
16441
16442 .option localhost_number main string&!! unset
16443 .cindex "host" "locally unique number for"
16444 .cindex "message ids" "with multiple hosts"
16445 .vindex "&$localhost_number$&"
16446 Exim's message ids are normally unique only within the local host. If
16447 uniqueness among a set of hosts is required, each host must set a different
16448 value for the &%localhost_number%& option. The string is expanded immediately
16449 after reading the configuration file (so that a number can be computed from the
16450 host name, for example) and the result of the expansion must be a number in the
16451 range 0&--16 (or 0&--10 on operating systems with case-insensitive file
16452 systems). This is available in subsequent string expansions via the variable
16453 &$localhost_number$&. When &%localhost_number is set%&, the final two
16454 characters of the message id, instead of just being a fractional part of the
16455 time, are computed from the time and the local host number as described in
16456 section &<<SECTmessiden>>&.
16457
16458
16459
16460 .option log_file_path main "string list&!!" "set at compile time"
16461 .cindex "log" "file path for"
16462 This option sets the path which is used to determine the names of Exim's log
16463 files, or indicates that logging is to be to syslog, or both. It is expanded
16464 when Exim is entered, so it can, for example, contain a reference to the host
16465 name. If no specific path is set for the log files at compile or runtime,
16466 or if the option is unset at runtime (i.e.  &`log_file_path = `&)
16467 they are written in a sub-directory called &_log_& in Exim's spool directory.
16468 A path must start with a slash.
16469 To send to syslog, use the word &"syslog"&.
16470 Chapter &<<CHAPlog>>& contains further details about Exim's logging, and
16471 section &<<SECTwhelogwri>>& describes how the contents of &%log_file_path%& are
16472 used. If this string is fixed at your installation (contains no expansion
16473 variables) it is recommended that you do not set this option in the
16474 configuration file, but instead supply the path using LOG_FILE_PATH in
16475 &_Local/Makefile_& so that it is available to Exim for logging errors detected
16476 early on &-- in particular, failure to read the configuration file.
16477
16478
16479 .option log_selector main string unset
16480 .cindex "log" "selectors"
16481 This option can be used to reduce or increase the number of things that Exim
16482 writes to its log files. Its argument is made up of names preceded by plus or
16483 minus characters. For example:
16484 .code
16485 log_selector = +arguments -retry_defer
16486 .endd
16487 A list of possible names and what they control is given in the chapter on
16488 logging, in section &<<SECTlogselector>>&.
16489
16490
16491 .option log_timezone main boolean false
16492 .cindex "log" "timezone for entries"
16493 .vindex "&$tod_log$&"
16494 .vindex "&$tod_zone$&"
16495 By default, the timestamps on log lines are in local time without the
16496 timezone. This means that if your timezone changes twice a year, the timestamps
16497 in log lines are ambiguous for an hour when the clocks go back. One way of
16498 avoiding this problem is to set the timezone to UTC. An alternative is to set
16499 &%log_timezone%& true. This turns on the addition of the timezone offset to
16500 timestamps in log lines. Turning on this option can add quite a lot to the size
16501 of log files because each line is extended by 6 characters. Note that the
16502 &$tod_log$& variable contains the log timestamp without the zone, but there is
16503 another variable called &$tod_zone$& that contains just the timezone offset.
16504
16505
16506 .option lookup_open_max main integer 25
16507 .cindex "too many open files"
16508 .cindex "open files, too many"
16509 .cindex "file" "too many open"
16510 .cindex "lookup" "maximum open files"
16511 .cindex "limit" "open files for lookups"
16512 This option limits the number of simultaneously open files for single-key
16513 lookups that use regular files (that is, &(lsearch)&, &(dbm)&, and &(cdb)&).
16514 Exim normally keeps these files open during routing, because often the same
16515 file is required several times. If the limit is reached, Exim closes the least
16516 recently used file. Note that if you are using the &'ndbm'& library, it
16517 actually opens two files for each logical DBM database, though it still counts
16518 as one for the purposes of &%lookup_open_max%&. If you are getting &"too many
16519 open files"& errors with NDBM, you need to reduce the value of
16520 &%lookup_open_max%&.
16521
16522
16523 .option max_username_length main integer 0
16524 .cindex "length of login name"
16525 .cindex "user name" "maximum length"
16526 .cindex "limit" "user name length"
16527 Some operating systems are broken in that they truncate long arguments to
16528 &[getpwnam()]& to eight characters, instead of returning &"no such user"&. If
16529 this option is set greater than zero, any attempt to call &[getpwnam()]& with
16530 an argument that is longer behaves as if &[getpwnam()]& failed.
16531
16532
16533 .option message_body_newlines main bool false
16534 .cindex "message body" "newlines in variables"
16535 .cindex "newline" "in message body variables"
16536 .vindex "&$message_body$&"
16537 .vindex "&$message_body_end$&"
16538 By default, newlines in the message body are replaced by spaces when setting
16539 the &$message_body$& and &$message_body_end$& expansion variables. If this
16540 option is set true, this no longer happens.
16541
16542
16543 .option message_body_visible main integer 500
16544 .cindex "body of message" "visible size"
16545 .cindex "message body" "visible size"
16546 .vindex "&$message_body$&"
16547 .vindex "&$message_body_end$&"
16548 This option specifies how much of a message's body is to be included in the
16549 &$message_body$& and &$message_body_end$& expansion variables.
16550
16551
16552 .option message_id_header_domain main string&!! unset
16553 .cindex "&'Message-ID:'& header line"
16554 If this option is set, the string is expanded and used as the right hand side
16555 (domain) of the &'Message-ID:'& header that Exim creates if a
16556 locally-originated incoming message does not have one. &"Locally-originated"&
16557 means &"not received over TCP/IP."&
16558 Otherwise, the primary host name is used.
16559 Only letters, digits, dot and hyphen are accepted; any other characters are
16560 replaced by hyphens. If the expansion is forced to fail, or if the result is an
16561 empty string, the option is ignored.
16562
16563
16564 .option message_id_header_text main string&!! unset
16565 If this variable is set, the string is expanded and used to augment the text of
16566 the &'Message-id:'& header that Exim creates if a locally-originated incoming
16567 message does not have one. The text of this header is required by RFC 2822 to
16568 take the form of an address. By default, Exim uses its internal message id as
16569 the local part, and the primary host name as the domain. If this option is set,
16570 it is expanded, and provided the expansion is not forced to fail, and does not
16571 yield an empty string, the result is inserted into the header immediately
16572 before the @, separated from the internal message id by a dot. Any characters
16573 that are illegal in an address are automatically converted into hyphens. This
16574 means that variables such as &$tod_log$& can be used, because the spaces and
16575 colons will become hyphens.
16576
16577
16578 .option message_logs main boolean true
16579 .cindex "message logs" "disabling"
16580 .cindex "log" "message log; disabling"
16581 If this option is turned off, per-message log files are not created in the
16582 &_msglog_& spool sub-directory. This reduces the amount of disk I/O required by
16583 Exim, by reducing the number of files involved in handling a message from a
16584 minimum of four (header spool file, body spool file, delivery journal, and
16585 per-message log) to three. The other major I/O activity is Exim's main log,
16586 which is not affected by this option.
16587
16588
16589 .option message_size_limit main string&!! 50M
16590 .cindex "message" "size limit"
16591 .cindex "limit" "message size"
16592 .cindex "size" "of message, limit"
16593 This option limits the maximum size of message that Exim will process. The
16594 value is expanded for each incoming connection so, for example, it can be made
16595 to depend on the IP address of the remote host for messages arriving via
16596 TCP/IP. After expansion, the value must be a sequence of decimal digits,
16597 optionally followed by K or M.
16598
16599 .cindex "SIZE" "ESMTP extension, advertising"
16600 .cindex "ESMTP extensions" SIZE
16601 If nonzero the value will be advertised as a parameter to the ESMTP SIZE
16602 service extension keyword.
16603
16604 &*Note*&: This limit cannot be made to depend on a message's sender or any
16605 other properties of an individual message, because it has to be advertised in
16606 the server's response to EHLO. String expansion failure causes a temporary
16607 error. A value of zero means no limit, but its use is not recommended. See also
16608 &%bounce_return_size_limit%&.
16609
16610 Incoming SMTP messages are failed with a 552 error if the limit is
16611 exceeded; locally-generated messages either get a stderr message or a delivery
16612 failure message to the sender, depending on the &%-oe%& setting. Rejection of
16613 an oversized message is logged in both the main and the reject logs. See also
16614 the generic transport option &%message_size_limit%&, which limits the size of
16615 message that an individual transport can process.
16616
16617 If you use a virus-scanner and set this option to to a value larger than the
16618 maximum size that your virus-scanner is configured to support, you may get
16619 failures triggered by large mails.  The right size to configure for the
16620 virus-scanner depends upon what data is passed and the options in use but it's
16621 probably safest to just set it to a little larger than this value.  E.g., with a
16622 default Exim message size of 50M and a default ClamAV StreamMaxLength of 10M,
16623 some problems may result.
16624
16625 A value of 0 will disable size limit checking; Exim will still advertise the
16626 SIZE extension in an EHLO response, but without a limit, so as to permit
16627 SMTP clients to still indicate the message size along with the MAIL verb.
16628
16629
16630 .option move_frozen_messages main boolean false
16631 .cindex "frozen messages" "moving"
16632 This option, which is available only if Exim has been built with the setting
16633 .code
16634 SUPPORT_MOVE_FROZEN_MESSAGES=yes
16635 .endd
16636 in &_Local/Makefile_&, causes frozen messages and their message logs to be
16637 moved from the &_input_& and &_msglog_& directories on the spool to &_Finput_&
16638 and &_Fmsglog_&, respectively. There is currently no support in Exim or the
16639 standard utilities for handling such moved messages, and they do not show up in
16640 lists generated by &%-bp%& or by the Exim monitor.
16641
16642
16643 .option mua_wrapper main boolean false
16644 Setting this option true causes Exim to run in a very restrictive mode in which
16645 it passes messages synchronously to a smart host. Chapter &<<CHAPnonqueueing>>&
16646 contains a full description of this facility.
16647
16648
16649
16650 .option mysql_servers main "string list" unset
16651 .cindex "MySQL" "server list"
16652 This option provides a list of MySQL servers and associated connection data, to
16653 be used in conjunction with &(mysql)& lookups (see section &<<SECID72>>&). The
16654 option is available only if Exim has been built with MySQL support.
16655
16656
16657 .option never_users main "string list&!!" unset
16658 This option is expanded just once, at the start of Exim's processing. Local
16659 message deliveries are normally run in processes that are setuid to the
16660 recipient, and remote deliveries are normally run under Exim's own uid and gid.
16661 It is usually desirable to prevent any deliveries from running as root, as a
16662 safety precaution.
16663
16664 When Exim is built, an option called FIXED_NEVER_USERS can be set to a
16665 list of users that must not be used for local deliveries. This list is fixed in
16666 the binary and cannot be overridden by the configuration file. By default, it
16667 contains just the single user name &"root"&. The &%never_users%& runtime option
16668 can be used to add more users to the fixed list.
16669
16670 If a message is to be delivered as one of the users on the fixed list or the
16671 &%never_users%& list, an error occurs, and delivery is deferred. A common
16672 example is
16673 .code
16674 never_users = root:daemon:bin
16675 .endd
16676 Including root is redundant if it is also on the fixed list, but it does no
16677 harm. This option overrides the &%pipe_as_creator%& option of the &(pipe)&
16678 transport driver.
16679
16680
16681 .option notifier_socket main string "$spool_directory/exim_daemon_notify"
16682 This option gives the name for a unix-domain socket on which the daemon
16683 listens for work and information-requests.
16684 Only installations running multiple daemons sharing a spool directory
16685 should need to modify the default.
16686
16687 The option is expanded before use.
16688 If the platform supports Linux-style abstract socket names, the result
16689 is used with a nul byte prefixed.
16690 Otherwise, it should be a full path name and use a directory accessible
16691 to Exim.
16692
16693 If the Exim command line uses a &%-oX%& option and does not use &%-oP%&
16694 then a notifier socket is not created.
16695
16696
16697 .option openssl_options main "string list" "+no_sslv2 +no_sslv3 +single_dh_use +no_ticket +no_renegotiation"
16698 .cindex "OpenSSL "compatibility options"
16699 This option allows an administrator to adjust the SSL options applied
16700 by OpenSSL to connections.  It is given as a space-separated list of items,
16701 each one to be +added or -subtracted from the current value.
16702
16703 This option is only available if Exim is built against OpenSSL.  The values
16704 available for this option vary according to the age of your OpenSSL install.
16705 The &"all"& value controls a subset of flags which are available, typically
16706 the bug workaround options.  The &'SSL_CTX_set_options'& man page will
16707 list the values known on your system and Exim should support all the
16708 &"bug workaround"& options and many of the &"modifying"& options.  The Exim
16709 names lose the leading &"SSL_OP_"& and are lower-cased.
16710
16711 Note that adjusting the options can have severe impact upon the security of
16712 SSL as used by Exim.  It is possible to disable safety checks and shoot
16713 yourself in the foot in various unpleasant ways.  This option should not be
16714 adjusted lightly.  An unrecognised item will be detected at startup, by
16715 invoking Exim with the &%-bV%& flag.
16716
16717 The option affects Exim operating both as a server and as a client.
16718
16719 Historical note: prior to release 4.80, Exim defaulted this value to
16720 "+dont_insert_empty_fragments", which may still be needed for compatibility
16721 with some clients, but which lowers security by increasing exposure to
16722 some now infamous attacks.
16723
16724 Examples:
16725 .code
16726 # Make both old MS and old Eudora happy:
16727 openssl_options = -all +microsoft_big_sslv3_buffer \
16728                        +dont_insert_empty_fragments
16729
16730 # Disable older protocol versions:
16731 openssl_options = +no_sslv2 +no_sslv3
16732 .endd
16733
16734 Possible options may include:
16735 .ilist
16736 &`all`&
16737 .next
16738 &`allow_unsafe_legacy_renegotiation`&
16739 .next
16740 &`cipher_server_preference`&
16741 .next
16742 &`dont_insert_empty_fragments`&
16743 .next
16744 &`ephemeral_rsa`&
16745 .next
16746 &`legacy_server_connect`&
16747 .next
16748 &`microsoft_big_sslv3_buffer`&
16749 .next
16750 &`microsoft_sess_id_bug`&
16751 .next
16752 &`msie_sslv2_rsa_padding`&
16753 .next
16754 &`netscape_challenge_bug`&
16755 .next
16756 &`netscape_reuse_cipher_change_bug`&
16757 .next
16758 &`no_compression`&
16759 .next
16760 &`no_session_resumption_on_renegotiation`&
16761 .next
16762 &`no_sslv2`&
16763 .next
16764 &`no_sslv3`&
16765 .next
16766 &`no_ticket`&
16767 .next
16768 &`no_tlsv1`&
16769 .next
16770 &`no_tlsv1_1`&
16771 .next
16772 &`no_tlsv1_2`&
16773 .next
16774 &`safari_ecdhe_ecdsa_bug`&
16775 .next
16776 &`single_dh_use`&
16777 .next
16778 &`single_ecdh_use`&
16779 .next
16780 &`ssleay_080_client_dh_bug`&
16781 .next
16782 &`sslref2_reuse_cert_type_bug`&
16783 .next
16784 &`tls_block_padding_bug`&
16785 .next
16786 &`tls_d5_bug`&
16787 .next
16788 &`tls_rollback_bug`&
16789 .endlist
16790
16791 As an aside, the &`safari_ecdhe_ecdsa_bug`& item is a misnomer and affects
16792 all clients connecting using the MacOS SecureTransport TLS facility prior
16793 to MacOS 10.8.4, including email clients.  If you see old MacOS clients failing
16794 to negotiate TLS then this option value might help, provided that your OpenSSL
16795 release is new enough to contain this work-around.  This may be a situation
16796 where you have to upgrade OpenSSL to get buggy clients working.
16797
16798
16799 .option oracle_servers main "string list" unset
16800 .cindex "Oracle" "server list"
16801 This option provides a list of Oracle servers and associated connection data,
16802 to be used in conjunction with &(oracle)& lookups (see section &<<SECID72>>&).
16803 The option is available only if Exim has been built with Oracle support.
16804
16805
16806 .option percent_hack_domains main "domain list&!!" unset
16807 .cindex "&""percent hack""&"
16808 .cindex "source routing" "in email address"
16809 .cindex "address" "source-routed"
16810 The &"percent hack"& is the convention whereby a local part containing a
16811 percent sign is re-interpreted as a new email address, with the percent
16812 replaced by @. This is sometimes called &"source routing"&, though that term is
16813 also applied to RFC 2822 addresses that begin with an @ character. If this
16814 option is set, Exim implements the percent facility for those domains listed,
16815 but no others. This happens before an incoming SMTP address is tested against
16816 an ACL.
16817
16818 &*Warning*&: The &"percent hack"& has often been abused by people who are
16819 trying to get round relaying restrictions. For this reason, it is best avoided
16820 if at all possible. Unfortunately, a number of less security-conscious MTAs
16821 implement it unconditionally. If you are running Exim on a gateway host, and
16822 routing mail through to internal MTAs without processing the local parts, it is
16823 a good idea to reject recipient addresses with percent characters in their
16824 local parts. Exim's default configuration does this.
16825
16826
16827 .option perl_at_start main boolean false
16828 .cindex "Perl"
16829 This option is available only when Exim is built with an embedded Perl
16830 interpreter. See chapter &<<CHAPperl>>& for details of its use.
16831
16832
16833 .option perl_startup main string unset
16834 .cindex "Perl"
16835 This option is available only when Exim is built with an embedded Perl
16836 interpreter. See chapter &<<CHAPperl>>& for details of its use.
16837
16838 .option perl_taintmode main boolean false
16839 .cindex "Perl"
16840 This option enables the taint mode of the embedded Perl interpreter.
16841
16842
16843 .option pgsql_servers main "string list" unset
16844 .cindex "PostgreSQL lookup type" "server list"
16845 This option provides a list of PostgreSQL servers and associated connection
16846 data, to be used in conjunction with &(pgsql)& lookups (see section
16847 &<<SECID72>>&). The option is available only if Exim has been built with
16848 PostgreSQL support.
16849
16850
16851 .option pid_file_path main string&!! "set at compile time"
16852 .cindex "daemon" "pid file path"
16853 .cindex "pid file, path for"
16854 This option sets the name of the file to which the Exim daemon writes its
16855 process id. The string is expanded, so it can contain, for example, references
16856 to the host name:
16857 .code
16858 pid_file_path = /var/log/$primary_hostname/exim.pid
16859 .endd
16860 If no path is set, the pid is written to the file &_exim-daemon.pid_& in Exim's
16861 spool directory.
16862 The value set by the option can be overridden by the &%-oP%& command line
16863 option. A pid file is not written if a &"non-standard"& daemon is run by means
16864 of the &%-oX%& option, unless a path is explicitly supplied by &%-oP%&.
16865
16866
16867 .option pipelining_advertise_hosts main "host list&!!" *
16868 .cindex "PIPELINING" "suppressing advertising"
16869 .cindex "ESMTP extensions" PIPELINING
16870 This option can be used to suppress the advertisement of the SMTP
16871 PIPELINING extension to specific hosts. See also the &*no_pipelining*&
16872 control in section &<<SECTcontrols>>&. When PIPELINING is not advertised and
16873 &%smtp_enforce_sync%& is true, an Exim server enforces strict synchronization
16874 for each SMTP command and response. When PIPELINING is advertised, Exim assumes
16875 that clients will use it; &"out of order"& commands that are &"expected"& do
16876 not count as protocol errors (see &%smtp_max_synprot_errors%&).
16877
16878 .option pipelining_connect_advertise_hosts main "host list&!!" *
16879 .cindex "pipelining" "early connection"
16880 .cindex "pipelining" PIPE_CONNECT
16881 .cindex "ESMTP extensions" X_PIPE_CONNECT
16882 If Exim is built with the SUPPORT_PIPE_CONNECT build option
16883 this option controls which hosts the facility is advertised to
16884 and from which pipeline early-connection (before MAIL) SMTP
16885 commands are acceptable.
16886 When used, the pipelining saves on roundtrip times.
16887
16888 See also the &%hosts_pipe_connect%& smtp transport option.
16889
16890 Currently the option name &"X_PIPE_CONNECT"& is used.
16891
16892
16893 .option prdr_enable main boolean false
16894 .cindex "PRDR" "enabling on server"
16895 .cindex "ESMTP extensions" PRDR
16896 This option can be used to enable the Per-Recipient Data Response extension
16897 to SMTP, defined by Eric Hall.
16898 If the option is set, PRDR is advertised by Exim when operating as a server.
16899 If the client requests PRDR, and more than one recipient, for a message
16900 an additional ACL is called for each recipient after the message content
16901 is received.  See section &<<SECTPRDRACL>>&.
16902
16903 .option preserve_message_logs main boolean false
16904 .cindex "message logs" "preserving"
16905 If this option is set, message log files are not deleted when messages are
16906 completed. Instead, they are moved to a sub-directory of the spool directory
16907 called &_msglog.OLD_&, where they remain available for statistical or debugging
16908 purposes. This is a dangerous option to set on systems with any appreciable
16909 volume of mail. Use with care!
16910
16911
16912 .option primary_hostname main string "see below"
16913 .cindex "name" "of local host"
16914 .cindex "host" "name of local"
16915 .cindex "local host" "name of"
16916 .vindex "&$primary_hostname$&"
16917 This specifies the name of the current host. It is used in the default EHLO or
16918 HELO command for outgoing SMTP messages (changeable via the &%helo_data%&
16919 option in the &(smtp)& transport), and as the default for &%qualify_domain%&.
16920 The value is also used by default in some SMTP response messages from an Exim
16921 server. This can be changed dynamically by setting &%smtp_active_hostname%&.
16922
16923 If &%primary_hostname%& is not set, Exim calls &[uname()]& to find the host
16924 name. If this fails, Exim panics and dies. If the name returned by &[uname()]&
16925 contains only one component, Exim passes it to &[gethostbyname()]& (or
16926 &[getipnodebyname()]& when available) in order to obtain the fully qualified
16927 version. The variable &$primary_hostname$& contains the host name, whether set
16928 explicitly by this option, or defaulted.
16929
16930
16931 .option print_topbitchars main boolean false
16932 .cindex "printing characters"
16933 .cindex "8-bit characters"
16934 By default, Exim considers only those characters whose codes lie in the range
16935 32&--126 to be printing characters. In a number of circumstances (for example,
16936 when writing log entries) non-printing characters are converted into escape
16937 sequences, primarily to avoid messing up the layout. If &%print_topbitchars%&
16938 is set, code values of 128 and above are also considered to be printing
16939 characters.
16940
16941 This option also affects the header syntax checks performed by the
16942 &(autoreply)& transport, and whether Exim uses RFC 2047 encoding of
16943 the user's full name when constructing From: and Sender: addresses (as
16944 described in section &<<SECTconstr>>&). Setting this option can cause
16945 Exim to generate eight bit message headers that do not conform to the
16946 standards.
16947
16948
16949 .option process_log_path main string unset
16950 .cindex "process log path"
16951 .cindex "log" "process log"
16952 .cindex "&'exiwhat'&"
16953 This option sets the name of the file to which an Exim process writes its
16954 &"process log"& when sent a USR1 signal. This is used by the &'exiwhat'&
16955 utility script. If this option is unset, the file called &_exim-process.info_&
16956 in Exim's spool directory is used. The ability to specify the name explicitly
16957 can be useful in environments where two different Exims are running, using
16958 different spool directories.
16959
16960
16961 .option prod_requires_admin main boolean true
16962 .cindex "restricting access to features"
16963 .oindex "&%-M%&"
16964 .oindex "&%-R%&"
16965 .oindex "&%-q%&"
16966 The &%-M%&, &%-R%&, and &%-q%& command-line options require the caller to be an
16967 admin user unless &%prod_requires_admin%& is set false. See also
16968 &%queue_list_requires_admin%& and &%commandline_checks_require_admin%&.
16969
16970
16971 .option qualify_domain main string "see below"
16972 .cindex "domain" "for qualifying addresses"
16973 .cindex "address" "qualification"
16974 This option specifies the domain name that is added to any envelope sender
16975 addresses that do not have a domain qualification. It also applies to
16976 recipient addresses if &%qualify_recipient%& is not set. Unqualified addresses
16977 are accepted by default only for locally-generated messages. Qualification is
16978 also applied to addresses in header lines such as &'From:'& and &'To:'& for
16979 locally-generated messages, unless the &%-bnq%& command line option is used.
16980
16981 Messages from external sources must always contain fully qualified addresses,
16982 unless the sending host matches &%sender_unqualified_hosts%& or
16983 &%recipient_unqualified_hosts%& (as appropriate), in which case incoming
16984 addresses are qualified with &%qualify_domain%& or &%qualify_recipient%& as
16985 necessary. Internally, Exim always works with fully qualified envelope
16986 addresses. If &%qualify_domain%& is not set, it defaults to the
16987 &%primary_hostname%& value.
16988
16989
16990 .option qualify_recipient main string "see below"
16991 This option allows you to specify a different domain for qualifying recipient
16992 addresses to the one that is used for senders. See &%qualify_domain%& above.
16993
16994
16995
16996 .option queue_domains main "domain list&!!" unset
16997 .cindex "domain" "specifying non-immediate delivery"
16998 .cindex "queueing incoming messages"
16999 .cindex "message" "queueing certain domains"
17000 This option lists domains for which immediate delivery is not required.
17001 A delivery process is started whenever a message is received, but only those
17002 domains that do not match are processed. All other deliveries wait until the
17003 next queue run. See also &%hold_domains%& and &%queue_smtp_domains%&.
17004
17005
17006 .new
17007 .option queue_fast_ramp main boolean false
17008 .cindex "queue runner" "two phase"
17009 .cindex "queue" "double scanning"
17010 If set to true, two-phase queue runs, initiated using &%-qq%& on the
17011 command line, may start parallel delivery processes during their first
17012 phase.  This will be done when a threshold number of messages have been
17013 routed for a single host.
17014 .wen
17015
17016
17017 .option queue_list_requires_admin main boolean true
17018 .cindex "restricting access to features"
17019 .oindex "&%-bp%&"
17020 The &%-bp%& command-line option, which lists the messages that are on the
17021 queue, requires the caller to be an admin user unless
17022 &%queue_list_requires_admin%& is set false.
17023 See also &%prod_requires_admin%& and &%commandline_checks_require_admin%&.
17024
17025
17026 .option queue_only main boolean false
17027 .cindex "queueing incoming messages"
17028 .cindex "message" "queueing unconditionally"
17029 If &%queue_only%& is set, a delivery process is not automatically started
17030 whenever a message is received. Instead, the message waits in the queue for the
17031 next queue run. Even if &%queue_only%& is false, incoming messages may not get
17032 delivered immediately when certain conditions (such as heavy load) occur.
17033
17034 The &%-odq%& command line has the same effect as &%queue_only%&. The &%-odb%&
17035 and &%-odi%& command line options override &%queue_only%& unless
17036 &%queue_only_override%& is set false. See also &%queue_only_file%&,
17037 &%queue_only_load%&, and &%smtp_accept_queue%&.
17038
17039
17040 .option queue_only_file main string unset
17041 .cindex "queueing incoming messages"
17042 .cindex "message" "queueing by file existence"
17043 This option can be set to a colon-separated list of absolute path names, each
17044 one optionally preceded by &"smtp"&. When Exim is receiving a message,
17045 it tests for the existence of each listed path using a call to &[stat()]&. For
17046 each path that exists, the corresponding queueing option is set.
17047 For paths with no prefix, &%queue_only%& is set; for paths prefixed by
17048 &"smtp"&, &%queue_smtp_domains%& is set to match all domains. So, for example,
17049 .code
17050 queue_only_file = smtp/some/file
17051 .endd
17052 causes Exim to behave as if &%queue_smtp_domains%& were set to &"*"& whenever
17053 &_/some/file_& exists.
17054
17055
17056 .option queue_only_load main fixed-point unset
17057 .cindex "load average"
17058 .cindex "queueing incoming messages"
17059 .cindex "message" "queueing by load"
17060 If the system load average is higher than this value, incoming messages from
17061 all sources are queued, and no automatic deliveries are started. If this
17062 happens during local or remote SMTP input, all subsequent messages received on
17063 the same SMTP connection are queued by default, whatever happens to the load in
17064 the meantime, but this can be changed by setting &%queue_only_load_latch%&
17065 false.
17066
17067 Deliveries will subsequently be performed by queue runner processes. This
17068 option has no effect on ancient operating systems on which Exim cannot
17069 determine the load average. See also &%deliver_queue_load_max%& and
17070 &%smtp_load_reserve%&.
17071
17072
17073 .option queue_only_load_latch main boolean true
17074 .cindex "load average" "re-evaluating per message"
17075 When this option is true (the default), once one message has been queued
17076 because the load average is higher than the value set by &%queue_only_load%&,
17077 all subsequent messages received on the same SMTP connection are also queued.
17078 This is a deliberate choice; even though the load average may fall below the
17079 threshold, it doesn't seem right to deliver later messages on the same
17080 connection when not delivering earlier ones. However, there are special
17081 circumstances such as very long-lived connections from scanning appliances
17082 where this is not the best strategy. In such cases, &%queue_only_load_latch%&
17083 should be set false. This causes the value of the load average to be
17084 re-evaluated for each message.
17085
17086
17087 .option queue_only_override main boolean true
17088 .cindex "queueing incoming messages"
17089 When this option is true, the &%-od%&&'x'& command line options override the
17090 setting of &%queue_only%& or &%queue_only_file%& in the configuration file. If
17091 &%queue_only_override%& is set false, the &%-od%&&'x'& options cannot be used
17092 to override; they are accepted, but ignored.
17093
17094
17095 .option queue_run_in_order main boolean false
17096 .cindex "queue runner" "processing messages in order"
17097 If this option is set, queue runs happen in order of message arrival instead of
17098 in an arbitrary order. For this to happen, a complete list of the entire queue
17099 must be set up before the deliveries start. When the queue is all held in a
17100 single directory (the default), a single list is created for both the ordered
17101 and the non-ordered cases. However, if &%split_spool_directory%& is set, a
17102 single list is not created when &%queue_run_in_order%& is false. In this case,
17103 the sub-directories are processed one at a time (in a random order), and this
17104 avoids setting up one huge list for the whole queue. Thus, setting
17105 &%queue_run_in_order%& with &%split_spool_directory%& may degrade performance
17106 when the queue is large, because of the extra work in setting up the single,
17107 large list. In most situations, &%queue_run_in_order%& should not be set.
17108
17109
17110
17111 .option queue_run_max main integer&!! 5
17112 .cindex "queue runner" "maximum number of"
17113 This controls the maximum number of queue runner processes that an Exim daemon
17114 can run simultaneously. This does not mean that it starts them all at once,
17115 but rather that if the maximum number are still running when the time comes to
17116 start another one, it refrains from starting another one. This can happen with
17117 very large queues and/or very sluggish deliveries. This option does not,
17118 however, interlock with other processes, so additional queue runners can be
17119 started by other means, or by killing and restarting the daemon.
17120
17121 Setting this option to zero does not suppress queue runs; rather, it disables
17122 the limit, allowing any number of simultaneous queue runner processes to be
17123 run. If you do not want queue runs to occur, omit the &%-q%&&'xx'& setting on
17124 the daemon's command line.
17125
17126 .cindex queues named
17127 .cindex "named queues" "resource limit"
17128 To set limits for different named queues use
17129 an expansion depending on the &$queue_name$& variable.
17130
17131 .option queue_smtp_domains main "domain list&!!" unset
17132 .cindex "queueing incoming messages"
17133 .cindex "message" "queueing remote deliveries"
17134 .cindex "first pass routing"
17135 When this option is set, a delivery process is started whenever a message is
17136 received, routing is performed, and local deliveries take place.
17137 However, if any SMTP deliveries are required for domains that match
17138 &%queue_smtp_domains%&, they are not immediately delivered, but instead the
17139 message waits in the queue for the next queue run. Since routing of the message
17140 has taken place, Exim knows to which remote hosts it must be delivered, and so
17141 when the queue run happens, multiple messages for the same host are delivered
17142 over a single SMTP connection. The &%-odqs%& command line option causes all
17143 SMTP deliveries to be queued in this way, and is equivalent to setting
17144 &%queue_smtp_domains%& to &"*"&. See also &%hold_domains%& and
17145 &%queue_domains%&.
17146
17147
17148 .option receive_timeout main time 0s
17149 .cindex "timeout" "for non-SMTP input"
17150 This option sets the timeout for accepting a non-SMTP message, that is, the
17151 maximum time that Exim waits when reading a message on the standard input. If
17152 the value is zero, it will wait forever. This setting is overridden by the
17153 &%-or%& command line option. The timeout for incoming SMTP messages is
17154 controlled by &%smtp_receive_timeout%&.
17155
17156 .option received_header_text main string&!! "see below"
17157 .cindex "customizing" "&'Received:'& header"
17158 .cindex "&'Received:'& header line" "customizing"
17159 This string defines the contents of the &'Received:'& message header that is
17160 added to each message, except for the timestamp, which is automatically added
17161 on at the end (preceded by a semicolon). The string is expanded each time it is
17162 used. If the expansion yields an empty string, no &'Received:'& header line is
17163 added to the message. Otherwise, the string should start with the text
17164 &"Received:"& and conform to the RFC 2822 specification for &'Received:'&
17165 header lines.
17166 The default setting is:
17167
17168 .code
17169 received_header_text = Received: \
17170   ${if def:sender_rcvhost {from $sender_rcvhost\n\t}\
17171     {${if def:sender_ident \
17172       {from ${quote_local_part:$sender_ident} }}\
17173         ${if def:sender_helo_name {(helo=$sender_helo_name)\n\t}}}}\
17174   by $primary_hostname \
17175   ${if def:received_protocol {with $received_protocol }}\
17176   ${if def:tls_in_ver        { ($tls_in_ver)}}\
17177   ${if def:tls_in_cipher_std { tls $tls_in_cipher_std\n\t}}\
17178   (Exim $version_number)\n\t\
17179   ${if def:sender_address \
17180   {(envelope-from <$sender_address>)\n\t}}\
17181   id $message_exim_id\
17182   ${if def:received_for {\n\tfor $received_for}}
17183 .endd
17184
17185 The references to the TLS version and cipher are
17186 omitted when Exim is built without TLS
17187 support. The use of conditional expansions ensures that this works for both
17188 locally generated messages and messages received from remote hosts, giving
17189 header lines such as the following:
17190 .code
17191 Received: from scrooge.carol.example ([192.168.12.25] ident=root)
17192 by marley.carol.example with esmtp (Exim 4.00)
17193 (envelope-from <bob@carol.example>)
17194 id 16IOWa-00019l-00
17195 for chas@dickens.example; Tue, 25 Dec 2001 14:43:44 +0000
17196 Received: by scrooge.carol.example with local (Exim 4.00)
17197 id 16IOWW-000083-00; Tue, 25 Dec 2001 14:43:41 +0000
17198 .endd
17199 Until the body of the message has been received, the timestamp is the time when
17200 the message started to be received. Once the body has arrived, and all policy
17201 checks have taken place, the timestamp is updated to the time at which the
17202 message was accepted.
17203
17204
17205 .option received_headers_max main integer 30
17206 .cindex "loop" "prevention"
17207 .cindex "mail loop prevention"
17208 .cindex "&'Received:'& header line" "counting"
17209 When a message is to be delivered, the number of &'Received:'& headers is
17210 counted, and if it is greater than this parameter, a mail loop is assumed to
17211 have occurred, the delivery is abandoned, and an error message is generated.
17212 This applies to both local and remote deliveries.
17213
17214
17215 .option recipient_unqualified_hosts main "host list&!!" unset
17216 .cindex "unqualified addresses"
17217 .cindex "host" "unqualified addresses from"
17218 This option lists those hosts from which Exim is prepared to accept unqualified
17219 recipient addresses in message envelopes. The addresses are made fully
17220 qualified by the addition of the &%qualify_recipient%& value. This option also
17221 affects message header lines. Exim does not reject unqualified recipient
17222 addresses in headers, but it qualifies them only if the message came from a
17223 host that matches &%recipient_unqualified_hosts%&,
17224 or if the message was submitted locally (not using TCP/IP), and the &%-bnq%&
17225 option was not set.
17226
17227
17228 .option recipients_max main integer 0
17229 .cindex "limit" "number of recipients"
17230 .cindex "recipient" "maximum number"
17231 If this option is set greater than zero, it specifies the maximum number of
17232 original recipients for any message. Additional recipients that are generated
17233 by aliasing or forwarding do not count. SMTP messages get a 452 response for
17234 all recipients over the limit; earlier recipients are delivered as normal.
17235 Non-SMTP messages with too many recipients are failed, and no deliveries are
17236 done.
17237
17238 .cindex "RCPT" "maximum number of incoming"
17239 &*Note*&: The RFCs specify that an SMTP server should accept at least 100
17240 RCPT commands in a single message.
17241
17242
17243 .option recipients_max_reject main boolean false
17244 If this option is set true, Exim rejects SMTP messages containing too many
17245 recipients by giving 552 errors to the surplus RCPT commands, and a 554
17246 error to the eventual DATA command. Otherwise (the default) it gives a 452
17247 error to the surplus RCPT commands and accepts the message on behalf of the
17248 initial set of recipients. The remote server should then re-send the message
17249 for the remaining recipients at a later time.
17250
17251
17252 .option remote_max_parallel main integer 2
17253 .cindex "delivery" "parallelism for remote"
17254 This option controls parallel delivery of one message to a number of remote
17255 hosts. If the value is less than 2, parallel delivery is disabled, and Exim
17256 does all the remote deliveries for a message one by one. Otherwise, if a single
17257 message has to be delivered to more than one remote host, or if several copies
17258 have to be sent to the same remote host, up to &%remote_max_parallel%&
17259 deliveries are done simultaneously. If more than &%remote_max_parallel%&
17260 deliveries are required, the maximum number of processes are started, and as
17261 each one finishes, another is begun. The order of starting processes is the
17262 same as if sequential delivery were being done, and can be controlled by the
17263 &%remote_sort_domains%& option. If parallel delivery takes place while running
17264 with debugging turned on, the debugging output from each delivery process is
17265 tagged with its process id.
17266
17267 This option controls only the maximum number of parallel deliveries for one
17268 message in one Exim delivery process. Because Exim has no central queue
17269 manager, there is no way of controlling the total number of simultaneous
17270 deliveries if the configuration allows a delivery attempt as soon as a message
17271 is received.
17272
17273 .cindex "number of deliveries"
17274 .cindex "delivery" "maximum number of"
17275 If you want to control the total number of deliveries on the system, you
17276 need to set the &%queue_only%& option. This ensures that all incoming messages
17277 are added to the queue without starting a delivery process. Then set up an Exim
17278 daemon to start queue runner processes at appropriate intervals (probably
17279 fairly often, for example, every minute), and limit the total number of queue
17280 runners by setting the &%queue_run_max%& parameter. Because each queue runner
17281 delivers only one message at a time, the maximum number of deliveries that can
17282 then take place at once is &%queue_run_max%& multiplied by
17283 &%remote_max_parallel%&.
17284
17285 If it is purely remote deliveries you want to control, use
17286 &%queue_smtp_domains%& instead of &%queue_only%&. This has the added benefit of
17287 doing the SMTP routing before queueing, so that several messages for the same
17288 host will eventually get delivered down the same connection.
17289
17290
17291 .option remote_sort_domains main "domain list&!!" unset
17292 .cindex "sorting remote deliveries"
17293 .cindex "delivery" "sorting remote"
17294 When there are a number of remote deliveries for a message, they are sorted by
17295 domain into the order given by this list. For example,
17296 .code
17297 remote_sort_domains = *.cam.ac.uk:*.uk
17298 .endd
17299 would attempt to deliver to all addresses in the &'cam.ac.uk'& domain first,
17300 then to those in the &%uk%& domain, then to any others.
17301
17302
17303 .option retry_data_expire main time 7d
17304 .cindex "hints database" "data expiry"
17305 This option sets a &"use before"& time on retry information in Exim's hints
17306 database. Any older retry data is ignored. This means that, for example, once a
17307 host has not been tried for 7 days, Exim behaves as if it has no knowledge of
17308 past failures.
17309
17310
17311 .option retry_interval_max main time 24h
17312 .cindex "retry" "limit on interval"
17313 .cindex "limit" "on retry interval"
17314 Chapter &<<CHAPretry>>& describes Exim's mechanisms for controlling the
17315 intervals between delivery attempts for messages that cannot be delivered
17316 straight away. This option sets an overall limit to the length of time between
17317 retries. It cannot be set greater than 24 hours; any attempt to do so forces
17318 the default value.
17319
17320
17321 .option return_path_remove main boolean true
17322 .cindex "&'Return-path:'& header line" "removing"
17323 RFC 2821, section 4.4, states that an SMTP server must insert a
17324 &'Return-path:'& header line into a message when it makes a &"final delivery"&.
17325 The &'Return-path:'& header preserves the sender address as received in the
17326 MAIL command. This description implies that this header should not be present
17327 in an incoming message. If &%return_path_remove%& is true, any existing
17328 &'Return-path:'& headers are removed from messages at the time they are
17329 received. Exim's transports have options for adding &'Return-path:'& headers at
17330 the time of delivery. They are normally used only for final local deliveries.
17331
17332
17333 .option return_size_limit main integer 100K
17334 This option is an obsolete synonym for &%bounce_return_size_limit%&.
17335
17336
17337 .option rfc1413_hosts main "host list&!!" @[]
17338 .cindex "RFC 1413"
17339 .cindex "host" "for RFC 1413 calls"
17340 RFC 1413 identification calls are made to any client host which matches
17341 an item in the list.
17342 The default value specifies just this host, being any local interface
17343 for the system.
17344
17345 .option rfc1413_query_timeout main time 0s
17346 .cindex "RFC 1413" "query timeout"
17347 .cindex "timeout" "for RFC 1413 call"
17348 This sets the timeout on RFC 1413 identification calls. If it is set to zero,
17349 no RFC 1413 calls are ever made.
17350
17351
17352 .option sender_unqualified_hosts main "host list&!!" unset
17353 .cindex "unqualified addresses"
17354 .cindex "host" "unqualified addresses from"
17355 This option lists those hosts from which Exim is prepared to accept unqualified
17356 sender addresses. The addresses are made fully qualified by the addition of
17357 &%qualify_domain%&. This option also affects message header lines. Exim does
17358 not reject unqualified addresses in headers that contain sender addresses, but
17359 it qualifies them only if the message came from a host that matches
17360 &%sender_unqualified_hosts%&, or if the message was submitted locally (not
17361 using TCP/IP), and the &%-bnq%& option was not set.
17362
17363
17364 .option slow_lookup_log main integer 0
17365 .cindex "logging" "slow lookups"
17366 .cindex "dns" "logging slow lookups"
17367 This option controls logging of slow lookups.
17368 If the value is nonzero it is taken as a number of milliseconds
17369 and lookups taking longer than this are logged.
17370 Currently this applies only to DNS lookups.
17371
17372
17373
17374 .option smtp_accept_keepalive main boolean true
17375 .cindex "keepalive" "on incoming connection"
17376 This option controls the setting of the SO_KEEPALIVE option on incoming
17377 TCP/IP socket connections. When set, it causes the kernel to probe idle
17378 connections periodically, by sending packets with &"old"& sequence numbers. The
17379 other end of the connection should send an acknowledgment if the connection is
17380 still okay or a reset if the connection has been aborted. The reason for doing
17381 this is that it has the beneficial effect of freeing up certain types of
17382 connection that can get stuck when the remote host is disconnected without
17383 tidying up the TCP/IP call properly. The keepalive mechanism takes several
17384 hours to detect unreachable hosts.
17385
17386
17387
17388 .option smtp_accept_max main integer 20
17389 .cindex "limit" "incoming SMTP connections"
17390 .cindex "SMTP" "incoming connection count"
17391 .cindex "inetd"
17392 This option specifies the maximum number of simultaneous incoming SMTP calls
17393 that Exim will accept. It applies only to the listening daemon; there is no
17394 control (in Exim) when incoming SMTP is being handled by &'inetd'&. If the
17395 value is set to zero, no limit is applied. However, it is required to be
17396 non-zero if either &%smtp_accept_max_per_host%& or &%smtp_accept_queue%& is
17397 set. See also &%smtp_accept_reserve%& and &%smtp_load_reserve%&.
17398
17399 A new SMTP connection is immediately rejected if the &%smtp_accept_max%& limit
17400 has been reached. If not, Exim first checks &%smtp_accept_max_per_host%&. If
17401 that limit has not been reached for the client host, &%smtp_accept_reserve%&
17402 and &%smtp_load_reserve%& are then checked before accepting the connection.
17403
17404
17405 .option smtp_accept_max_nonmail main integer 10
17406 .cindex "limit" "non-mail SMTP commands"
17407 .cindex "SMTP" "limiting non-mail commands"
17408 Exim counts the number of &"non-mail"& commands in an SMTP session, and drops
17409 the connection if there are too many. This option defines &"too many"&. The
17410 check catches some denial-of-service attacks, repeated failing AUTHs, or a mad
17411 client looping sending EHLO, for example. The check is applied only if the
17412 client host matches &%smtp_accept_max_nonmail_hosts%&.
17413
17414 When a new message is expected, one occurrence of RSET is not counted. This
17415 allows a client to send one RSET between messages (this is not necessary,
17416 but some clients do it). Exim also allows one uncounted occurrence of HELO
17417 or EHLO, and one occurrence of STARTTLS between messages. After
17418 starting up a TLS session, another EHLO is expected, and so it too is not
17419 counted. The first occurrence of AUTH in a connection, or immediately
17420 following STARTTLS is not counted. Otherwise, all commands other than
17421 MAIL, RCPT, DATA, and QUIT are counted.
17422
17423
17424 .option smtp_accept_max_nonmail_hosts main "host list&!!" *
17425 You can control which hosts are subject to the &%smtp_accept_max_nonmail%&
17426 check by setting this option. The default value makes it apply to all hosts. By
17427 changing the value, you can exclude any badly-behaved hosts that you have to
17428 live with.
17429
17430
17431 . Allow this long option name to split; give it unsplit as a fifth argument
17432 . for the automatic .oindex that is generated by .option.
17433 . We insert " &~&~" which is both pretty nasty visually and results in
17434 . non-searchable text.  HowItWorks.txt mentions an option for inserting
17435 . zero-width-space, which would be nicer visually and results in (at least)
17436 . html that Firefox will split on when it's forced to reflow (rather than
17437 . inserting a horizontal scrollbar).  However, the text is still not
17438 . searchable.  NM changed this occurrence for bug 1197 to no longer allow
17439 . the option name to split.
17440
17441 .option "smtp_accept_max_per_connection" main integer 1000 &&&
17442          smtp_accept_max_per_connection
17443 .cindex "SMTP" "limiting incoming message count"
17444 .cindex "limit" "messages per SMTP connection"
17445 The value of this option limits the number of MAIL commands that Exim is
17446 prepared to accept over a single SMTP connection, whether or not each command
17447 results in the transfer of a message. After the limit is reached, a 421
17448 response is given to subsequent MAIL commands. This limit is a safety
17449 precaution against a client that goes mad (incidents of this type have been
17450 seen).
17451
17452
17453 .option smtp_accept_max_per_host main string&!! unset
17454 .cindex "limit" "SMTP connections from one host"
17455 .cindex "host" "limiting SMTP connections from"
17456 This option restricts the number of simultaneous IP connections from a single
17457 host (strictly, from a single IP address) to the Exim daemon. The option is
17458 expanded, to enable different limits to be applied to different hosts by
17459 reference to &$sender_host_address$&. Once the limit is reached, additional
17460 connection attempts from the same host are rejected with error code 421. This
17461 is entirely independent of &%smtp_accept_reserve%&. The option's default value
17462 of zero imposes no limit. If this option is set greater than zero, it is
17463 required that &%smtp_accept_max%& be non-zero.
17464
17465 &*Warning*&: When setting this option you should not use any expansion
17466 constructions that take an appreciable amount of time. The expansion and test
17467 happen in the main daemon loop, in order to reject additional connections
17468 without forking additional processes (otherwise a denial-of-service attack
17469 could cause a vast number or processes to be created). While the daemon is
17470 doing this processing, it cannot accept any other incoming connections.
17471
17472
17473
17474 .option smtp_accept_queue main integer 0
17475 .cindex "SMTP" "incoming connection count"
17476 .cindex "queueing incoming messages"
17477 .cindex "message" "queueing by SMTP connection count"
17478 If the number of simultaneous incoming SMTP connections being handled via the
17479 listening daemon exceeds this value, messages received by SMTP are just placed
17480 in the queue; no delivery processes are started automatically. The count is
17481 fixed at the start of an SMTP connection. It cannot be updated in the
17482 subprocess that receives messages, and so the queueing or not queueing applies
17483 to all messages received in the same connection.
17484
17485 A value of zero implies no limit, and clearly any non-zero value is useful only
17486 if it is less than the &%smtp_accept_max%& value (unless that is zero). See
17487 also &%queue_only%&, &%queue_only_load%&, &%queue_smtp_domains%&, and the
17488 various &%-od%&&'x'& command line options.
17489
17490
17491 . See the comment on smtp_accept_max_per_connection
17492
17493 .option "smtp_accept_queue_per_connection" main integer 10 &&&
17494          smtp_accept_queue_per_connection
17495 .cindex "queueing incoming messages"
17496 .cindex "message" "queueing by message count"
17497 This option limits the number of delivery processes that Exim starts
17498 automatically when receiving messages via SMTP, whether via the daemon or by
17499 the use of &%-bs%& or &%-bS%&. If the value of the option is greater than zero,
17500 and the number of messages received in a single SMTP session exceeds this
17501 number, subsequent messages are placed in the queue, but no delivery processes
17502 are started. This helps to limit the number of Exim processes when a server
17503 restarts after downtime and there is a lot of mail waiting for it on other
17504 systems. On large systems, the default should probably be increased, and on
17505 dial-in client systems it should probably be set to zero (that is, disabled).
17506
17507
17508 .option smtp_accept_reserve main integer 0
17509 .cindex "SMTP" "incoming call count"
17510 .cindex "host" "reserved"
17511 When &%smtp_accept_max%& is set greater than zero, this option specifies a
17512 number of SMTP connections that are reserved for connections from the hosts
17513 that are specified in &%smtp_reserve_hosts%&. The value set in
17514 &%smtp_accept_max%& includes this reserve pool. The specified hosts are not
17515 restricted to this number of connections; the option specifies a minimum number
17516 of connection slots for them, not a maximum. It is a guarantee that this group
17517 of hosts can always get at least &%smtp_accept_reserve%& connections. However,
17518 the limit specified by &%smtp_accept_max_per_host%& is still applied to each
17519 individual host.
17520
17521 For example, if &%smtp_accept_max%& is set to 50 and &%smtp_accept_reserve%& is
17522 set to 5, once there are 45 active connections (from any hosts), new
17523 connections are accepted only from hosts listed in &%smtp_reserve_hosts%&,
17524 provided the other criteria for acceptance are met.
17525
17526
17527 .option smtp_active_hostname main string&!! unset
17528 .cindex "host" "name in SMTP responses"
17529 .cindex "SMTP" "host name in responses"
17530 .vindex "&$primary_hostname$&"
17531 This option is provided for multi-homed servers that want to masquerade as
17532 several different hosts. At the start of an incoming SMTP connection, its value
17533 is expanded and used instead of the value of &$primary_hostname$& in SMTP
17534 responses. For example, it is used as domain name in the response to an
17535 incoming HELO or EHLO command.
17536
17537 .vindex "&$smtp_active_hostname$&"
17538 The active hostname is placed in the &$smtp_active_hostname$& variable, which
17539 is saved with any messages that are received. It is therefore available for use
17540 in routers and transports when the message is later delivered.
17541
17542 If this option is unset, or if its expansion is forced to fail, or if the
17543 expansion results in an empty string, the value of &$primary_hostname$& is
17544 used. Other expansion failures cause a message to be written to the main and
17545 panic logs, and the SMTP command receives a temporary error. Typically, the
17546 value of &%smtp_active_hostname%& depends on the incoming interface address.
17547 For example:
17548 .code
17549 smtp_active_hostname = ${if eq{$received_ip_address}{10.0.0.1}\
17550   {cox.mydomain}{box.mydomain}}
17551 .endd
17552
17553 Although &$smtp_active_hostname$& is primarily concerned with incoming
17554 messages, it is also used as the default for HELO commands in callout
17555 verification if there is no remote transport from which to obtain a
17556 &%helo_data%& value.
17557
17558 .option smtp_banner main string&!! "see below"
17559 .cindex "SMTP" "welcome banner"
17560 .cindex "banner for SMTP"
17561 .cindex "welcome banner for SMTP"
17562 .cindex "customizing" "SMTP banner"
17563 This string, which is expanded every time it is used, is output as the initial
17564 positive response to an SMTP connection. The default setting is:
17565 .code
17566 smtp_banner = $smtp_active_hostname ESMTP Exim \
17567   $version_number $tod_full
17568 .endd
17569 Failure to expand the string causes a panic error. If you want to create a
17570 multiline response to the initial SMTP connection, use &"\n"& in the string at
17571 appropriate points, but not at the end. Note that the 220 code is not included
17572 in this string. Exim adds it automatically (several times in the case of a
17573 multiline response).
17574
17575
17576 .option smtp_check_spool_space main boolean true
17577 .cindex "checking disk space"
17578 .cindex "disk space, checking"
17579 .cindex "spool directory" "checking space"
17580 When this option is set, if an incoming SMTP session encounters the SIZE
17581 option on a MAIL command, it checks that there is enough space in the
17582 spool directory's partition to accept a message of that size, while still
17583 leaving free the amount specified by &%check_spool_space%& (even if that value
17584 is zero). If there isn't enough space, a temporary error code is returned.
17585
17586
17587 .option smtp_connect_backlog main integer 20
17588 .cindex "connection backlog"
17589 .cindex "SMTP" "connection backlog"
17590 .cindex "backlog of connections"
17591 This option specifies a maximum number of waiting SMTP connections. Exim passes
17592 this value to the TCP/IP system when it sets up its listener. Once this number
17593 of connections are waiting for the daemon's attention, subsequent connection
17594 attempts are refused at the TCP/IP level. At least, that is what the manuals
17595 say; in some circumstances such connection attempts have been observed to time
17596 out instead. For large systems it is probably a good idea to increase the
17597 value (to 50, say). It also gives some protection against denial-of-service
17598 attacks by SYN flooding.
17599
17600
17601 .option smtp_enforce_sync main boolean true
17602 .cindex "SMTP" "synchronization checking"
17603 .cindex "synchronization checking in SMTP"
17604 The SMTP protocol specification requires the client to wait for a response from
17605 the server at certain points in the dialogue. Without PIPELINING these
17606 synchronization points are after every command; with PIPELINING they are
17607 fewer, but they still exist.
17608
17609 Some spamming sites send out a complete set of SMTP commands without waiting
17610 for any response. Exim protects against this by rejecting a message if the
17611 client has sent further input when it should not have. The error response &"554
17612 SMTP synchronization error"& is sent, and the connection is dropped. Testing
17613 for this error cannot be perfect because of transmission delays (unexpected
17614 input may be on its way but not yet received when Exim checks). However, it
17615 does detect many instances.
17616
17617 The check can be globally disabled by setting &%smtp_enforce_sync%& false.
17618 If you want to disable the check selectively (for example, only for certain
17619 hosts), you can do so by an appropriate use of a &%control%& modifier in an ACL
17620 (see section &<<SECTcontrols>>&). See also &%pipelining_advertise_hosts%&.
17621
17622
17623
17624 .option smtp_etrn_command main string&!! unset
17625 .cindex "ETRN" "command to be run"
17626 .cindex "ESMTP extensions" ETRN
17627 .vindex "&$domain$&"
17628 If this option is set, the given command is run whenever an SMTP ETRN
17629 command is received from a host that is permitted to issue such commands (see
17630 chapter &<<CHAPACL>>&). The string is split up into separate arguments which
17631 are independently expanded. The expansion variable &$domain$& is set to the
17632 argument of the ETRN command, and no syntax checking is done on it. For
17633 example:
17634 .code
17635 smtp_etrn_command = /etc/etrn_command $domain \
17636                     $sender_host_address
17637 .endd
17638 If the option is not set, the argument for the ETRN command must
17639 be a &'#'& followed by an address string.
17640 In this case an &'exim -R <string>'& command is used;
17641 if the ETRN ACL has set up a named-queue then &'-MCG <queue>'& is appended.
17642
17643 A new process is created to run the command, but Exim does not wait for it to
17644 complete. Consequently, its status cannot be checked. If the command cannot be
17645 run, a line is written to the panic log, but the ETRN caller still receives
17646 a 250 success response. Exim is normally running under its own uid when
17647 receiving SMTP, so it is not possible for it to change the uid before running
17648 the command.
17649
17650
17651 .option smtp_etrn_serialize main boolean true
17652 .cindex "ETRN" "serializing"
17653 When this option is set, it prevents the simultaneous execution of more than
17654 one identical command as a result of ETRN in an SMTP connection. See
17655 section &<<SECTETRN>>& for details.
17656
17657
17658 .option smtp_load_reserve main fixed-point unset
17659 .cindex "load average"
17660 If the system load average ever gets higher than this, incoming SMTP calls are
17661 accepted only from those hosts that match an entry in &%smtp_reserve_hosts%&.
17662 If &%smtp_reserve_hosts%& is not set, no incoming SMTP calls are accepted when
17663 the load is over the limit. The option has no effect on ancient operating
17664 systems on which Exim cannot determine the load average. See also
17665 &%deliver_queue_load_max%& and &%queue_only_load%&.
17666
17667
17668
17669 .option smtp_max_synprot_errors main integer 3
17670 .cindex "SMTP" "limiting syntax and protocol errors"
17671 .cindex "limit" "SMTP syntax and protocol errors"
17672 Exim rejects SMTP commands that contain syntax or protocol errors. In
17673 particular, a syntactically invalid email address, as in this command:
17674 .code
17675 RCPT TO:<abc xyz@a.b.c>
17676 .endd
17677 causes immediate rejection of the command, before any other tests are done.
17678 (The ACL cannot be run if there is no valid address to set up for it.) An
17679 example of a protocol error is receiving RCPT before MAIL. If there are
17680 too many syntax or protocol errors in one SMTP session, the connection is
17681 dropped. The limit is set by this option.
17682
17683 .cindex "PIPELINING" "expected errors"
17684 When the PIPELINING extension to SMTP is in use, some protocol errors are
17685 &"expected"&, for instance, a RCPT command after a rejected MAIL command.
17686 Exim assumes that PIPELINING will be used if it advertises it (see
17687 &%pipelining_advertise_hosts%&), and in this situation, &"expected"& errors do
17688 not count towards the limit.
17689
17690
17691
17692 .option smtp_max_unknown_commands main integer 3
17693 .cindex "SMTP" "limiting unknown commands"
17694 .cindex "limit" "unknown SMTP commands"
17695 If there are too many unrecognized commands in an incoming SMTP session, an
17696 Exim server drops the connection. This is a defence against some kinds of abuse
17697 that subvert web
17698 clients
17699 into making connections to SMTP ports; in these circumstances, a number of
17700 non-SMTP command lines are sent first.
17701
17702
17703
17704 .option smtp_ratelimit_hosts main "host list&!!" unset
17705 .cindex "SMTP" "rate limiting"
17706 .cindex "limit" "rate of message arrival"
17707 .cindex "RCPT" "rate limiting"
17708 Some sites find it helpful to be able to limit the rate at which certain hosts
17709 can send them messages, and the rate at which an individual message can specify
17710 recipients.
17711
17712 Exim has two rate-limiting facilities. This section describes the older
17713 facility, which can limit rates within a single connection. The newer
17714 &%ratelimit%& ACL condition can limit rates across all connections. See section
17715 &<<SECTratelimiting>>& for details of the newer facility.
17716
17717 When a host matches &%smtp_ratelimit_hosts%&, the values of
17718 &%smtp_ratelimit_mail%& and &%smtp_ratelimit_rcpt%& are used to control the
17719 rate of acceptance of MAIL and RCPT commands in a single SMTP session,
17720 respectively. Each option, if set, must contain a set of four comma-separated
17721 values:
17722
17723 .ilist
17724 A threshold, before which there is no rate limiting.
17725 .next
17726 An initial time delay. Unlike other times in Exim, numbers with decimal
17727 fractional parts are allowed here.
17728 .next
17729 A factor by which to increase the delay each time.
17730 .next
17731 A maximum value for the delay. This should normally be less than 5 minutes,
17732 because after that time, the client is liable to timeout the SMTP command.
17733 .endlist
17734
17735 For example, these settings have been used successfully at the site which
17736 first suggested this feature, for controlling mail from their customers:
17737 .code
17738 smtp_ratelimit_mail = 2,0.5s,1.05,4m
17739 smtp_ratelimit_rcpt = 4,0.25s,1.015,4m
17740 .endd
17741 The first setting specifies delays that are applied to MAIL commands after
17742 two have been received over a single connection. The initial delay is 0.5
17743 seconds, increasing by a factor of 1.05 each time. The second setting applies
17744 delays to RCPT commands when more than four occur in a single message.
17745
17746
17747 .option smtp_ratelimit_mail main string unset
17748 See &%smtp_ratelimit_hosts%& above.
17749
17750
17751 .option smtp_ratelimit_rcpt main string unset
17752 See &%smtp_ratelimit_hosts%& above.
17753
17754
17755 .option smtp_receive_timeout main time&!! 5m
17756 .cindex "timeout" "for SMTP input"
17757 .cindex "SMTP" "input timeout"
17758 This sets a timeout value for SMTP reception. It applies to all forms of SMTP
17759 input, including batch SMTP. If a line of input (either an SMTP command or a
17760 data line) is not received within this time, the SMTP connection is dropped and
17761 the message is abandoned.
17762 A line is written to the log containing one of the following messages:
17763 .code
17764 SMTP command timeout on connection from...
17765 SMTP data timeout on connection from...
17766 .endd
17767 The former means that Exim was expecting to read an SMTP command; the latter
17768 means that it was in the DATA phase, reading the contents of a message.
17769
17770 If the first character of the option is a &"$"& the option is
17771 expanded before use and may depend on
17772 &$sender_host_name$&, &$sender_host_address$& and &$sender_host_port$&.
17773
17774
17775 .oindex "&%-os%&"
17776 The value set by this option can be overridden by the
17777 &%-os%& command-line option. A setting of zero time disables the timeout, but
17778 this should never be used for SMTP over TCP/IP. (It can be useful in some cases
17779 of local input using &%-bs%& or &%-bS%&.) For non-SMTP input, the reception
17780 timeout is controlled by &%receive_timeout%& and &%-or%&.
17781
17782
17783 .option smtp_reserve_hosts main "host list&!!" unset
17784 This option defines hosts for which SMTP connections are reserved; see
17785 &%smtp_accept_reserve%& and &%smtp_load_reserve%& above.
17786
17787
17788 .option smtp_return_error_details main boolean false
17789 .cindex "SMTP" "details policy failures"
17790 .cindex "policy control" "rejection, returning details"
17791 In the default state, Exim uses bland messages such as
17792 &"Administrative prohibition"& when it rejects SMTP commands for policy
17793 reasons. Many sysadmins like this because it gives away little information
17794 to spammers. However, some other sysadmins who are applying strict checking
17795 policies want to give out much fuller information about failures. Setting
17796 &%smtp_return_error_details%& true causes Exim to be more forthcoming. For
17797 example, instead of &"Administrative prohibition"&, it might give:
17798 .code
17799 550-Rejected after DATA: '>' missing at end of address:
17800 550 failing address in "From" header is: <user@dom.ain
17801 .endd
17802
17803
17804 .option smtputf8_advertise_hosts main "host list&!!" *
17805 .cindex "SMTPUTF8" "ESMTP extension, advertising"
17806 .cindex "ESMTP extensions" SMTPUTF8
17807 When Exim is built with support for internationalised mail names,
17808 the availability thereof is advertised in
17809 response to EHLO only to those client hosts that match this option. See
17810 chapter &<<CHAPi18n>>& for details of Exim's support for internationalisation.
17811
17812
17813 .option spamd_address main string "127.0.0.1 783"
17814 This option is available when Exim is compiled with the content-scanning
17815 extension. It specifies how Exim connects to SpamAssassin's &%spamd%& daemon.
17816 See section &<<SECTscanspamass>>& for more details.
17817
17818
17819
17820 .option spf_guess main string "v=spf1 a/24 mx/24 ptr ?all"
17821 This option is available when Exim is compiled with SPF support.
17822 See section &<<SECSPF>>& for more details.
17823
17824 .option spf_smtp_comment_template main string&!! "Please%_see%_http://www.open-spf.org/Why"
17825 This option is available when Exim is compiled with SPF support.  It
17826 allows the customisation of the SMTP comment that the SPF library
17827 generates.  You are strongly encouraged to link to your own explanative
17828 site. The template must not contain spaces. If you need spaces in the
17829 output, use the proper placeholder. If libspf2 can not parse the
17830 template, it uses a built-in default broken link. The following placeholders
17831 (along with Exim variables (but see below)) are allowed in the template:
17832 .ilist
17833 &*%_*&: A space.
17834 .next
17835 &*%{L}*&: Envelope sender's local part.
17836 .next
17837 &*%{S}*&: Envelope sender.
17838 .next
17839 &*%{O}*&: Envelope sender's domain.
17840 .next
17841 &*%{D}*&: Current(?) domain.
17842 .next
17843 &*%{I}*&: SMTP client Ip.
17844 .next
17845 &*%{C}*&: SMTP client pretty IP.
17846 .next
17847 &*%{T}*&: Epoch time (UTC).
17848 .next
17849 &*%{P}*&: SMTP client domain name.
17850 .next
17851 &*%{V}*&: IP version.
17852 .next
17853 &*%{H}*&: EHLO/HELO domain.
17854 .next
17855 &*%{R}*&: Receiving domain.
17856 .endlist
17857 The capitalized placeholders do proper URL encoding, if you use them
17858 lowercased, no encoding takes place.  This list was compiled from the
17859 libspf2 sources.
17860
17861 A note on using Exim variables: As
17862 currently the SPF library is initialized before the SMTP EHLO phase,
17863 the variables useful for expansion are quite limited.
17864
17865
17866 .option split_spool_directory main boolean false
17867 .cindex "multiple spool directories"
17868 .cindex "spool directory" "split"
17869 .cindex "directories, multiple"
17870 If this option is set, it causes Exim to split its input directory into 62
17871 subdirectories, each with a single alphanumeric character as its name. The
17872 sixth character of the message id is used to allocate messages to
17873 subdirectories; this is the least significant base-62 digit of the time of
17874 arrival of the message.
17875
17876 Splitting up the spool in this way may provide better performance on systems
17877 where there are long mail queues, by reducing the number of files in any one
17878 directory. The msglog directory is also split up in a similar way to the input
17879 directory; however, if &%preserve_message_logs%& is set, all old msglog files
17880 are still placed in the single directory &_msglog.OLD_&.
17881
17882 It is not necessary to take any special action for existing messages when
17883 changing &%split_spool_directory%&. Exim notices messages that are in the
17884 &"wrong"& place, and continues to process them. If the option is turned off
17885 after a period of being on, the subdirectories will eventually empty and be
17886 automatically deleted.
17887
17888 When &%split_spool_directory%& is set, the behaviour of queue runner processes
17889 changes. Instead of creating a list of all messages in the queue, and then
17890 trying to deliver each one, in turn, it constructs a list of those in one
17891 sub-directory and tries to deliver them, before moving on to the next
17892 sub-directory. The sub-directories are processed in a random order. This
17893 spreads out the scanning of the input directories, and uses less memory. It is
17894 particularly beneficial when there are lots of messages in the queue. However,
17895 if &%queue_run_in_order%& is set, none of this new processing happens. The
17896 entire queue has to be scanned and sorted before any deliveries can start.
17897
17898
17899 .option spool_directory main string&!! "set at compile time"
17900 .cindex "spool directory" "path to"
17901 This defines the directory in which Exim keeps its spool, that is, the messages
17902 it is waiting to deliver. The default value is taken from the compile-time
17903 configuration setting, if there is one. If not, this option must be set. The
17904 string is expanded, so it can contain, for example, a reference to
17905 &$primary_hostname$&.
17906
17907 If the spool directory name is fixed on your installation, it is recommended
17908 that you set it at build time rather than from this option, particularly if the
17909 log files are being written to the spool directory (see &%log_file_path%&).
17910 Otherwise log files cannot be used for errors that are detected early on, such
17911 as failures in the configuration file.
17912
17913 By using this option to override the compiled-in path, it is possible to run
17914 tests of Exim without using the standard spool.
17915
17916 .option spool_wireformat main boolean false
17917 .cindex "spool directory" "file formats"
17918 If this option is set, Exim may for some messages use an alternative format
17919 for data-files in the spool which matches the wire format.
17920 Doing this permits more efficient message reception and transmission.
17921 Currently it is only done for messages received using the ESMTP CHUNKING
17922 option.
17923
17924 The following variables will not have useful values:
17925 .code
17926 $max_received_linelength
17927 $body_linecount
17928 $body_zerocount
17929 .endd
17930
17931 Users of the local_scan() API (see &<<CHAPlocalscan>>&),
17932 and any external programs which are passed a reference to a message data file
17933 (except via the &"regex"&, &"malware"& or &"spam"&) ACL conditions)
17934 will need to be aware of the different formats potentially available.
17935
17936 Using any of the ACL conditions noted will negate the reception benefit
17937 (as a Unix-mbox-format file is constructed for them).
17938 The transmission benefit is maintained.
17939
17940 .option sqlite_lock_timeout main time 5s
17941 .cindex "sqlite lookup type" "lock timeout"
17942 This option controls the timeout that the &(sqlite)& lookup uses when trying to
17943 access an SQLite database. See section &<<SECTsqlite>>& for more details.
17944
17945 .option strict_acl_vars main boolean false
17946 .cindex "&ACL;" "variables, handling unset"
17947 This option controls what happens if a syntactically valid but undefined ACL
17948 variable is referenced. If it is false (the default), an empty string
17949 is substituted; if it is true, an error is generated. See section
17950 &<<SECTaclvariables>>& for details of ACL variables.
17951
17952 .option strip_excess_angle_brackets main boolean false
17953 .cindex "angle brackets, excess"
17954 If this option is set, redundant pairs of angle brackets round &"route-addr"&
17955 items in addresses are stripped. For example, &'<<xxx@a.b.c.d>>'& is
17956 treated as &'<xxx@a.b.c.d>'&. If this is in the envelope and the message is
17957 passed on to another MTA, the excess angle brackets are not passed on. If this
17958 option is not set, multiple pairs of angle brackets cause a syntax error.
17959
17960
17961 .option strip_trailing_dot main boolean false
17962 .cindex "trailing dot on domain"
17963 .cindex "dot" "trailing on domain"
17964 If this option is set, a trailing dot at the end of a domain in an address is
17965 ignored. If this is in the envelope and the message is passed on to another
17966 MTA, the dot is not passed on. If this option is not set, a dot at the end of a
17967 domain causes a syntax error.
17968 However, addresses in header lines are checked only when an ACL requests header
17969 syntax checking.
17970
17971
17972 .option syslog_duplication main boolean true
17973 .cindex "syslog" "duplicate log lines; suppressing"
17974 When Exim is logging to syslog, it writes the log lines for its three
17975 separate logs at different syslog priorities so that they can in principle
17976 be separated on the logging hosts. Some installations do not require this
17977 separation, and in those cases, the duplication of certain log lines is a
17978 nuisance. If &%syslog_duplication%& is set false, only one copy of any
17979 particular log line is written to syslog. For lines that normally go to
17980 both the main log and the reject log, the reject log version (possibly
17981 containing message header lines) is written, at LOG_NOTICE priority.
17982 Lines that normally go to both the main and the panic log are written at
17983 the LOG_ALERT priority.
17984
17985
17986 .option syslog_facility main string unset
17987 .cindex "syslog" "facility; setting"
17988 This option sets the syslog &"facility"& name, used when Exim is logging to
17989 syslog. The value must be one of the strings &"mail"&, &"user"&, &"news"&,
17990 &"uucp"&, &"daemon"&, or &"local&'x'&"& where &'x'& is a digit between 0 and 7.
17991 If this option is unset, &"mail"& is used. See chapter &<<CHAPlog>>& for
17992 details of Exim's logging.
17993
17994
17995 .option syslog_pid main boolean true
17996 .cindex "syslog" "pid"
17997 If &%syslog_pid%& is set false, the PID on Exim's log lines are
17998 omitted when these lines are sent to syslog. (Syslog normally prefixes
17999 the log lines with the PID of the logging process automatically.) You need
18000 to enable the &`+pid`& log selector item, if you want Exim to write it's PID
18001 into the logs.) See chapter &<<CHAPlog>>& for details of Exim's logging.
18002
18003
18004
18005 .option syslog_processname main string &`exim`&
18006 .cindex "syslog" "process name; setting"
18007 This option sets the syslog &"ident"& name, used when Exim is logging to
18008 syslog. The value must be no longer than 32 characters. See chapter
18009 &<<CHAPlog>>& for details of Exim's logging.
18010
18011
18012
18013 .option syslog_timestamp main boolean true
18014 .cindex "syslog" "timestamps"
18015 .cindex timestamps syslog
18016 If &%syslog_timestamp%& is set false, the timestamps on Exim's log lines are
18017 omitted when these lines are sent to syslog. See chapter &<<CHAPlog>>& for
18018 details of Exim's logging.
18019
18020
18021 .option system_filter main string&!! unset
18022 .cindex "filter" "system filter"
18023 .cindex "system filter" "specifying"
18024 .cindex "Sieve filter" "not available for system filter"
18025 This option specifies an Exim filter file that is applied to all messages at
18026 the start of each delivery attempt, before any routing is done. System filters
18027 must be Exim filters; they cannot be Sieve filters. If the system filter
18028 generates any deliveries to files or pipes, or any new mail messages, the
18029 appropriate &%system_filter_..._transport%& option(s) must be set, to define
18030 which transports are to be used. Details of this facility are given in chapter
18031 &<<CHAPsystemfilter>>&.
18032 A forced expansion failure results in no filter operation.
18033
18034
18035 .option system_filter_directory_transport main string&!! unset
18036 .vindex "&$address_file$&"
18037 This sets the name of the transport driver that is to be used when the
18038 &%save%& command in a system message filter specifies a path ending in &"/"&,
18039 implying delivery of each message into a separate file in some directory.
18040 During the delivery, the variable &$address_file$& contains the path name.
18041
18042
18043 .option system_filter_file_transport main string&!! unset
18044 .cindex "file" "transport for system filter"
18045 This sets the name of the transport driver that is to be used when the &%save%&
18046 command in a system message filter specifies a path not ending in &"/"&. During
18047 the delivery, the variable &$address_file$& contains the path name.
18048
18049 .option system_filter_group main string unset
18050 .cindex "gid (group id)" "system filter"
18051 This option is used only when &%system_filter_user%& is also set. It sets the
18052 gid under which the system filter is run, overriding any gid that is associated
18053 with the user. The value may be numerical or symbolic.
18054
18055 .option system_filter_pipe_transport main string&!! unset
18056 .cindex "&(pipe)& transport" "for system filter"
18057 .vindex "&$address_pipe$&"
18058 This specifies the transport driver that is to be used when a &%pipe%& command
18059 is used in a system filter. During the delivery, the variable &$address_pipe$&
18060 contains the pipe command.
18061
18062
18063 .option system_filter_reply_transport main string&!! unset
18064 .cindex "&(autoreply)& transport" "for system filter"
18065 This specifies the transport driver that is to be used when a &%mail%& command
18066 is used in a system filter.
18067
18068
18069 .option system_filter_user main string unset
18070 .cindex "uid (user id)" "system filter"
18071 If this option is set to root, the system filter is run in the main Exim
18072 delivery process, as root.  Otherwise, the system filter runs in a separate
18073 process, as the given user, defaulting to the Exim run-time user.
18074 Unless the string consists entirely of digits, it
18075 is looked up in the password data. Failure to find the named user causes a
18076 configuration error. The gid is either taken from the password data, or
18077 specified by &%system_filter_group%&. When the uid is specified numerically,
18078 &%system_filter_group%& is required to be set.
18079
18080 If the system filter generates any pipe, file, or reply deliveries, the uid
18081 under which the filter is run is used when transporting them, unless a
18082 transport option overrides.
18083
18084
18085 .option tcp_nodelay main boolean true
18086 .cindex "daemon" "TCP_NODELAY on sockets"
18087 .cindex "Nagle algorithm"
18088 .cindex "TCP_NODELAY on listening sockets"
18089 If this option is set false, it stops the Exim daemon setting the
18090 TCP_NODELAY option on its listening sockets. Setting TCP_NODELAY
18091 turns off the &"Nagle algorithm"&, which is a way of improving network
18092 performance in interactive (character-by-character) situations. Turning it off
18093 should improve Exim's performance a bit, so that is what happens by default.
18094 However, it appears that some broken clients cannot cope, and time out. Hence
18095 this option. It affects only those sockets that are set up for listening by the
18096 daemon. Sockets created by the smtp transport for delivering mail always set
18097 TCP_NODELAY.
18098
18099
18100 .option timeout_frozen_after main time 0s
18101 .cindex "frozen messages" "timing out"
18102 .cindex "timeout" "frozen messages"
18103 If &%timeout_frozen_after%& is set to a time greater than zero, a frozen
18104 message of any kind that has been in the queue for longer than the given time
18105 is automatically cancelled at the next queue run. If the frozen message is a
18106 bounce message, it is just discarded; otherwise, a bounce is sent to the
18107 sender, in a similar manner to cancellation by the &%-Mg%& command line option.
18108 If you want to timeout frozen bounce messages earlier than other kinds of
18109 frozen message, see &%ignore_bounce_errors_after%&.
18110
18111 &*Note:*& the default value of zero means no timeouts; with this setting,
18112 frozen messages remain in the queue forever (except for any frozen bounce
18113 messages that are released by &%ignore_bounce_errors_after%&).
18114
18115
18116 .option timezone main string unset
18117 .cindex "timezone, setting"
18118 .cindex "environment" "values from"
18119 The value of &%timezone%& is used to set the environment variable TZ while
18120 running Exim (if it is different on entry). This ensures that all timestamps
18121 created by Exim are in the required timezone. If you want all your timestamps
18122 to be in UTC (aka GMT) you should set
18123 .code
18124 timezone = UTC
18125 .endd
18126 The default value is taken from TIMEZONE_DEFAULT in &_Local/Makefile_&,
18127 or, if that is not set, from the value of the TZ environment variable when Exim
18128 is built. If &%timezone%& is set to the empty string, either at build or run
18129 time, any existing TZ variable is removed from the environment when Exim
18130 runs. This is appropriate behaviour for obtaining wall-clock time on some, but
18131 unfortunately not all, operating systems.
18132
18133
18134 .option tls_advertise_hosts main "host list&!!" *
18135 .cindex "TLS" "advertising"
18136 .cindex "encryption" "on SMTP connection"
18137 .cindex "SMTP" "encrypted connection"
18138 .cindex "ESMTP extensions" STARTTLS
18139 When Exim is built with support for TLS encrypted connections, the availability
18140 of the STARTTLS command to set up an encrypted session is advertised in
18141 response to EHLO only to those client hosts that match this option. See
18142 chapter &<<CHAPTLS>>& for details of Exim's support for TLS.
18143 Note that the default value requires that a certificate be supplied
18144 using the &%tls_certificate%& option.  If TLS support for incoming connections
18145 is not required the &%tls_advertise_hosts%& option should be set empty.
18146
18147
18148 .option tls_certificate main string list&!! unset
18149 .cindex "TLS" "server certificate; location of"
18150 .cindex "certificate" "server, location of"
18151 The value of this option is expanded, and must then be a list of absolute paths to
18152 files which contain the server's certificates (in PEM format).
18153 Commonly only one file is needed.
18154 The server's private key is also
18155 assumed to be in this file if &%tls_privatekey%& is unset. See chapter
18156 &<<CHAPTLS>>& for further details.
18157
18158 &*Note*&: The certificates defined by this option are used only when Exim is
18159 receiving incoming messages as a server. If you want to supply certificates for
18160 use when sending messages as a client, you must set the &%tls_certificate%&
18161 option in the relevant &(smtp)& transport.
18162
18163 &*Note*&: If you use filenames based on IP addresses, change the list
18164 separator in the usual way (&<<SECTlistsepchange>>&) to avoid confusion under IPv6.
18165
18166 &*Note*&: Under versions of OpenSSL preceding 1.1.1,
18167 when a list of more than one
18168 file is used, the &$tls_in_ourcert$& variable is unreliable.
18169 The macro "_TLS_BAD_MULTICERT_IN_OURCERT" will be defined for those versions.
18170
18171 .cindex SNI "selecting server certificate based on"
18172 If the option contains &$tls_out_sni$& and Exim is built against OpenSSL, then
18173 if the OpenSSL build supports TLS extensions and the TLS client sends the
18174 Server Name Indication extension, then this option and others documented in
18175 &<<SECTtlssni>>& will be re-expanded.
18176
18177 If this option is unset or empty a fresh self-signed certificate will be
18178 generated for every connection.
18179
18180 .option tls_crl main string&!! unset
18181 .cindex "TLS" "server certificate revocation list"
18182 .cindex "certificate" "revocation list for server"
18183 This option specifies a certificate revocation list. The expanded value must
18184 be the name of a file that contains CRLs in PEM format.
18185
18186 Under OpenSSL the option can specify a directory with CRL files.
18187
18188 &*Note:*& Under OpenSSL the option must, if given, supply a CRL
18189 for each signing element of the certificate chain (i.e. all but the leaf).
18190 For the file variant this can be multiple PEM blocks in the one file.
18191
18192 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
18193
18194
18195 .option tls_dh_max_bits main integer 2236
18196 .cindex "TLS" "D-H bit count"
18197 The number of bits used for Diffie-Hellman key-exchange may be suggested by
18198 the chosen TLS library.  That value might prove to be too high for
18199 interoperability.  This option provides a maximum clamp on the value
18200 suggested, trading off security for interoperability.
18201
18202 The value must be at least 1024.
18203
18204 The value 2236 was chosen because, at time of adding the option, it was the
18205 hard-coded maximum value supported by the NSS cryptographic library, as used
18206 by Thunderbird, while GnuTLS was suggesting 2432 bits as normal.
18207
18208 If you prefer more security and are willing to break some clients, raise this
18209 number.
18210
18211 Note that the value passed to GnuTLS for *generating* a new prime may be a
18212 little less than this figure, because GnuTLS is inexact and may produce a
18213 larger prime than requested.
18214
18215
18216 .option tls_dhparam main string&!! unset
18217 .cindex "TLS" "D-H parameters for server"
18218 The value of this option is expanded and indicates the source of DH parameters
18219 to be used by Exim.
18220
18221 This option is ignored for GnuTLS version 3.6.0 and later.
18222 The library manages parameter negotiation internally.
18223
18224 &*Note: The Exim Maintainers strongly recommend,
18225 for other TLS library versions,
18226 using a filename with site-generated
18227 local DH parameters*&, which has been supported across all versions of Exim.  The
18228 other specific constants available are a fallback so that even when
18229 "unconfigured", Exim can offer Perfect Forward Secrecy in older ciphersuites in TLS.
18230
18231 If &%tls_dhparam%& is a filename starting with a &`/`&,
18232 then it names a file from which DH
18233 parameters should be loaded.  If the file exists, it should hold a PEM-encoded
18234 PKCS#3 representation of the DH prime.  If the file does not exist, for
18235 OpenSSL it is an error.  For GnuTLS, Exim will attempt to create the file and
18236 fill it with a generated DH prime.  For OpenSSL, if the DH bit-count from
18237 loading the file is greater than &%tls_dh_max_bits%& then it will be ignored,
18238 and treated as though the &%tls_dhparam%& were set to "none".
18239
18240 If this option expands to the string "none", then no DH parameters will be
18241 loaded by Exim.
18242
18243 If this option expands to the string "historic" and Exim is using GnuTLS, then
18244 Exim will attempt to load a file from inside the spool directory.  If the file
18245 does not exist, Exim will attempt to create it.
18246 See section &<<SECTgnutlsparam>>& for further details.
18247
18248 If Exim is using OpenSSL and this option is empty or unset, then Exim will load
18249 a default DH prime; the default is Exim-specific but lacks verifiable provenance.
18250
18251 In older versions of Exim the default was the 2048 bit prime described in section
18252 2.2 of RFC 5114, "2048-bit MODP Group with 224-bit Prime Order Subgroup", which
18253 in IKE is assigned number 23.
18254
18255 Otherwise, the option must expand to the name used by Exim for any of a number
18256 of DH primes specified in RFC 2409, RFC 3526, RFC 5114, RFC 7919, or from other
18257 sources.  As names, Exim uses a standard specified name, else "ike" followed by
18258 the number used by IKE, or "default" which corresponds to
18259 &`exim.dev.20160529.3`&.
18260
18261 The available standard primes are:
18262 &`ffdhe2048`&, &`ffdhe3072`&, &`ffdhe4096`&, &`ffdhe6144`&, &`ffdhe8192`&,
18263 &`ike1`&, &`ike2`&, &`ike5`&,
18264 &`ike14`&, &`ike15`&, &`ike16`&, &`ike17`&, &`ike18`&,
18265 &`ike22`&, &`ike23`& and &`ike24`&.
18266
18267 The available additional primes are:
18268 &`exim.dev.20160529.1`&, &`exim.dev.20160529.2`& and &`exim.dev.20160529.3`&.
18269
18270 Some of these will be too small to be accepted by clients.
18271 Some may be too large to be accepted by clients.
18272 The open cryptographic community has suspicions about the integrity of some
18273 of the later IKE values, which led into RFC7919 providing new fixed constants
18274 (the "ffdhe" identifiers).
18275
18276 At this point, all of the "ike" values should be considered obsolete;
18277 they're still in Exim to avoid breaking unusual configurations, but are
18278 candidates for removal the next time we have backwards-incompatible changes.
18279
18280 The TLS protocol does not negotiate an acceptable size for this; clients tend
18281 to hard-drop connections if what is offered by the server is unacceptable,
18282 whether too large or too small, and there's no provision for the client to
18283 tell the server what these constraints are.  Thus, as a server operator, you
18284 need to make an educated guess as to what is most likely to work for your
18285 userbase.
18286
18287 Some known size constraints suggest that a bit-size in the range 2048 to 2236
18288 is most likely to maximise interoperability.  The upper bound comes from
18289 applications using the Mozilla Network Security Services (NSS) library, which
18290 used to set its &`DH_MAX_P_BITS`& upper-bound to 2236.  This affects many
18291 mail user agents (MUAs). The lower bound comes from Debian installs of Exim4
18292 prior to the 4.80 release, as Debian used to patch Exim to raise the minimum
18293 acceptable bound from 1024 to 2048.
18294
18295
18296 .option tls_eccurve main string&!! &`auto`&
18297 .cindex TLS "EC cryptography"
18298 This option selects a EC curve for use by Exim when used with OpenSSL.
18299 It has no effect when Exim is used with GnuTLS.
18300
18301 After expansion it must contain a valid EC curve parameter, such as
18302 &`prime256v1`&, &`secp384r1`&, or &`P-512`&. Consult your OpenSSL manual
18303 for valid selections.
18304
18305 For OpenSSL versions before (and not including) 1.0.2, the string
18306 &`auto`& selects &`prime256v1`&. For more recent OpenSSL versions
18307 &`auto`& tells the library to choose.
18308
18309 If the option expands to an empty string, no EC curves will be enabled.
18310
18311
18312 .option tls_ocsp_file main string&!! unset
18313 .cindex TLS "certificate status"
18314 .cindex TLS "OCSP proof file"
18315 This option
18316 must if set expand to the absolute path to a file which contains a current
18317 status proof for the server's certificate, as obtained from the
18318 Certificate Authority.
18319
18320 Usable for GnuTLS 3.4.4 or 3.3.17 or OpenSSL 1.1.0 (or later).
18321 The macro "_HAVE_TLS_OCSP" will be defined for those versions.
18322
18323 For OpenSSL 1.1.0 or later, and
18324 for GnuTLS 3.5.6 or later the expanded value of this option can be a list
18325 of files, to match a list given for the &%tls_certificate%& option.
18326 The ordering of the two lists must match.
18327 The macro "_HAVE_TLS_OCSP_LIST" will be defined for those versions.
18328
18329 The file(s) should be in DER format,
18330 except for GnuTLS 3.6.3 or later
18331 or for OpenSSL,
18332 when an optional filetype prefix can be used.
18333 The prefix must be one of "DER" or "PEM", followed by
18334 a single space.  If one is used it sets the format for subsequent
18335 files in the list; the initial format is DER.
18336 If multiple proofs are wanted, for multiple chain elements
18337 (this only works under TLS1.3)
18338 they must be coded as a combined OCSP response.
18339
18340 Although GnuTLS will accept PEM files with multiple separate
18341 PEM blobs (ie. separate OCSP responses), it sends them in the
18342 TLS Certificate record interleaved with the certificates of the chain;
18343 although a GnuTLS client is happy with that, an OpenSSL client is not.
18344
18345 .option tls_on_connect_ports main "string list" unset
18346 .cindex SSMTP
18347 .cindex SMTPS
18348 This option specifies a list of incoming SSMTP (aka SMTPS) ports that should
18349 operate the SSMTP (SMTPS) protocol, where a TLS session is immediately
18350 set up without waiting for the client to issue a STARTTLS command. For
18351 further details, see section &<<SECTsupobssmt>>&.
18352
18353
18354
18355 .option tls_privatekey main string list&!! unset
18356 .cindex "TLS" "server private key; location of"
18357 The value of this option is expanded, and must then be a list of absolute paths to
18358 files which contains the server's private keys.
18359 If this option is unset, or if
18360 the expansion is forced to fail, or the result is an empty string, the private
18361 key is assumed to be in the same file as the server's certificates. See chapter
18362 &<<CHAPTLS>>& for further details.
18363
18364 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
18365
18366
18367 .option tls_remember_esmtp main boolean false
18368 .cindex "TLS" "esmtp state; remembering"
18369 .cindex "TLS" "broken clients"
18370 If this option is set true, Exim violates the RFCs by remembering that it is in
18371 &"esmtp"& state after successfully negotiating a TLS session. This provides
18372 support for broken clients that fail to send a new EHLO after starting a
18373 TLS session.
18374
18375
18376 .option tls_require_ciphers main string&!! unset
18377 .cindex "TLS" "requiring specific ciphers"
18378 .cindex "cipher" "requiring specific"
18379 This option controls which ciphers can be used for incoming TLS connections.
18380 The &(smtp)& transport has an option of the same name for controlling outgoing
18381 connections. This option is expanded for each connection, so can be varied for
18382 different clients if required. The value of this option must be a list of
18383 permitted cipher suites. The OpenSSL and GnuTLS libraries handle cipher control
18384 in somewhat different ways. If GnuTLS is being used, the client controls the
18385 preference order of the available ciphers. Details are given in sections
18386 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
18387
18388
18389 .new
18390 .option tls_resumption_hosts main "host list&!!" unset
18391 .cindex TLS resumption
18392 This option controls which connections to offer the TLS resumption feature.
18393 See &<<SECTresumption>>& for details.
18394 .wen
18395
18396
18397 .option tls_try_verify_hosts main "host list&!!" unset
18398 .cindex "TLS" "client certificate verification"
18399 .cindex "certificate" "verification of client"
18400 See &%tls_verify_hosts%& below.
18401
18402
18403 .option tls_verify_certificates main string&!! system
18404 .cindex "TLS" "client certificate verification"
18405 .cindex "certificate" "verification of client"
18406 The value of this option is expanded, and must then be either the
18407 word "system"
18408 or the absolute path to
18409 a file or directory containing permitted certificates for clients that
18410 match &%tls_verify_hosts%& or &%tls_try_verify_hosts%&.
18411
18412 The "system" value for the option will use a
18413 system default location compiled into the SSL library.
18414 This is not available for GnuTLS versions preceding 3.0.20,
18415 and will be taken as empty; an explicit location
18416 must be specified.
18417
18418 The use of a directory for the option value is not available for GnuTLS versions
18419 preceding 3.3.6 and a single file must be used.
18420
18421 With OpenSSL the certificates specified
18422 explicitly
18423 either by file or directory
18424 are added to those given by the system default location.
18425
18426 These certificates should be for the certificate authorities trusted, rather
18427 than the public cert of individual clients.  With both OpenSSL and GnuTLS, if
18428 the value is a file then the certificates are sent by Exim as a server to
18429 connecting clients, defining the list of accepted certificate authorities.
18430 Thus the values defined should be considered public data.  To avoid this,
18431 use the explicit directory version.
18432
18433 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
18434
18435 A forced expansion failure or setting to an empty string is equivalent to
18436 being unset.
18437
18438
18439 .option tls_verify_hosts main "host list&!!" unset
18440 .cindex "TLS" "client certificate verification"
18441 .cindex "certificate" "verification of client"
18442 This option, along with &%tls_try_verify_hosts%&, controls the checking of
18443 certificates from clients. The expected certificates are defined by
18444 &%tls_verify_certificates%&, which must be set. A configuration error occurs if
18445 either &%tls_verify_hosts%& or &%tls_try_verify_hosts%& is set and
18446 &%tls_verify_certificates%& is not set.
18447
18448 Any client that matches &%tls_verify_hosts%& is constrained by
18449 &%tls_verify_certificates%&. When the client initiates a TLS session, it must
18450 present one of the listed certificates. If it does not, the connection is
18451 aborted. &*Warning*&: Including a host in &%tls_verify_hosts%& does not require
18452 the host to use TLS. It can still send SMTP commands through unencrypted
18453 connections. Forcing a client to use TLS has to be done separately using an
18454 ACL to reject inappropriate commands when the connection is not encrypted.
18455
18456 A weaker form of checking is provided by &%tls_try_verify_hosts%&. If a client
18457 matches this option (but not &%tls_verify_hosts%&), Exim requests a
18458 certificate and checks it against &%tls_verify_certificates%&, but does not
18459 abort the connection if there is no certificate or if it does not match. This
18460 state can be detected in an ACL, which makes it possible to implement policies
18461 such as &"accept for relay only if a verified certificate has been received,
18462 but accept for local delivery if encrypted, even without a verified
18463 certificate"&.
18464
18465 Client hosts that match neither of these lists are not asked to present
18466 certificates.
18467
18468
18469 .option trusted_groups main "string list&!!" unset
18470 .cindex "trusted groups"
18471 .cindex "groups" "trusted"
18472 This option is expanded just once, at the start of Exim's processing. If this
18473 option is set, any process that is running in one of the listed groups, or
18474 which has one of them as a supplementary group, is trusted. The groups can be
18475 specified numerically or by name. See section &<<SECTtrustedadmin>>& for
18476 details of what trusted callers are permitted to do. If neither
18477 &%trusted_groups%& nor &%trusted_users%& is set, only root and the Exim user
18478 are trusted.
18479
18480 .option trusted_users main "string list&!!" unset
18481 .cindex "trusted users"
18482 .cindex "user" "trusted"
18483 This option is expanded just once, at the start of Exim's processing. If this
18484 option is set, any process that is running as one of the listed users is
18485 trusted. The users can be specified numerically or by name. See section
18486 &<<SECTtrustedadmin>>& for details of what trusted callers are permitted to do.
18487 If neither &%trusted_groups%& nor &%trusted_users%& is set, only root and the
18488 Exim user are trusted.
18489
18490 .option unknown_login main string&!! unset
18491 .cindex "uid (user id)" "unknown caller"
18492 .vindex "&$caller_uid$&"
18493 This is a specialized feature for use in unusual configurations. By default, if
18494 the uid of the caller of Exim cannot be looked up using &[getpwuid()]&, Exim
18495 gives up. The &%unknown_login%& option can be used to set a login name to be
18496 used in this circumstance. It is expanded, so values like &%user$caller_uid%&
18497 can be set. When &%unknown_login%& is used, the value of &%unknown_username%&
18498 is used for the user's real name (gecos field), unless this has been set by the
18499 &%-F%& option.
18500
18501 .option unknown_username main string unset
18502 See &%unknown_login%&.
18503
18504 .option untrusted_set_sender main "address list&!!" unset
18505 .cindex "trusted users"
18506 .cindex "sender" "setting by untrusted user"
18507 .cindex "untrusted user setting sender"
18508 .cindex "user" "untrusted setting sender"
18509 .cindex "envelope from"
18510 .cindex "envelope sender"
18511 When an untrusted user submits a message to Exim using the standard input, Exim
18512 normally creates an envelope sender address from the user's login and the
18513 default qualification domain. Data from the &%-f%& option (for setting envelope
18514 senders on non-SMTP messages) or the SMTP MAIL command (if &%-bs%& or &%-bS%&
18515 is used) is ignored.
18516
18517 However, untrusted users are permitted to set an empty envelope sender address,
18518 to declare that a message should never generate any bounces. For example:
18519 .code
18520 exim -f '<>' user@domain.example
18521 .endd
18522 .vindex "&$sender_ident$&"
18523 The &%untrusted_set_sender%& option allows you to permit untrusted users to set
18524 other envelope sender addresses in a controlled way. When it is set, untrusted
18525 users are allowed to set envelope sender addresses that match any of the
18526 patterns in the list. Like all address lists, the string is expanded. The
18527 identity of the user is in &$sender_ident$&, so you can, for example, restrict
18528 users to setting senders that start with their login ids
18529 followed by a hyphen
18530 by a setting like this:
18531 .code
18532 untrusted_set_sender = ^$sender_ident-
18533 .endd
18534 If you want to allow untrusted users to set envelope sender addresses without
18535 restriction, you can use
18536 .code
18537 untrusted_set_sender = *
18538 .endd
18539 The &%untrusted_set_sender%& option applies to all forms of local input, but
18540 only to the setting of the envelope sender. It does not permit untrusted users
18541 to use the other options which trusted user can use to override message
18542 parameters. Furthermore, it does not stop Exim from removing an existing
18543 &'Sender:'& header in the message, or from adding a &'Sender:'& header if
18544 necessary. See &%local_sender_retain%& and &%local_from_check%& for ways of
18545 overriding these actions. The handling of the &'Sender:'& header is also
18546 described in section &<<SECTthesenhea>>&.
18547
18548 The log line for a message's arrival shows the envelope sender following
18549 &"<="&. For local messages, the user's login always follows, after &"U="&. In
18550 &%-bp%& displays, and in the Exim monitor, if an untrusted user sets an
18551 envelope sender address, the user's login is shown in parentheses after the
18552 sender address.
18553
18554
18555 .option uucp_from_pattern main string "see below"
18556 .cindex "&""From""& line"
18557 .cindex "UUCP" "&""From""& line"
18558 Some applications that pass messages to an MTA via a command line interface use
18559 an initial line starting with &"From&~"& to pass the envelope sender. In
18560 particular, this is used by UUCP software. Exim recognizes such a line by means
18561 of a regular expression that is set in &%uucp_from_pattern%&. When the pattern
18562 matches, the sender address is constructed by expanding the contents of
18563 &%uucp_from_sender%&, provided that the caller of Exim is a trusted user. The
18564 default pattern recognizes lines in the following two forms:
18565 .code
18566 From ph10 Fri Jan  5 12:35 GMT 1996
18567 From ph10 Fri, 7 Jan 97 14:00:00 GMT
18568 .endd
18569 The pattern can be seen by running
18570 .code
18571 exim -bP uucp_from_pattern
18572 .endd
18573 It checks only up to the hours and minutes, and allows for a 2-digit or 4-digit
18574 year in the second case. The first word after &"From&~"& is matched in the
18575 regular expression by a parenthesized subpattern. The default value for
18576 &%uucp_from_sender%& is &"$1"&, which therefore just uses this first word
18577 (&"ph10"& in the example above) as the message's sender. See also
18578 &%ignore_fromline_hosts%&.
18579
18580
18581 .option uucp_from_sender main string&!! &`$1`&
18582 See &%uucp_from_pattern%& above.
18583
18584
18585 .option warn_message_file main string&!! unset
18586 .cindex "warning of delay" "customizing the message"
18587 .cindex "customizing" "warning message"
18588 This option defines a template file containing paragraphs of text to be used
18589 for constructing the warning message which is sent by Exim when a message has
18590 been in the queue for a specified amount of time, as specified by
18591 &%delay_warning%&. Details of the file's contents are given in chapter
18592 &<<CHAPemsgcust>>&.
18593 .cindex warn_message_file "tainted data"
18594 The option is expanded to give the file path, which must be
18595 absolute and untainted.
18596 See also &%bounce_message_file%&.
18597
18598
18599 .option write_rejectlog main boolean true
18600 .cindex "reject log" "disabling"
18601 If this option is set false, Exim no longer writes anything to the reject log.
18602 See chapter &<<CHAPlog>>& for details of what Exim writes to its logs.
18603 .ecindex IIDconfima
18604 .ecindex IIDmaiconf
18605
18606
18607
18608
18609 . ////////////////////////////////////////////////////////////////////////////
18610 . ////////////////////////////////////////////////////////////////////////////
18611
18612 .chapter "Generic options for routers" "CHAProutergeneric"
18613 .scindex IIDgenoprou1 "options" "generic; for routers"
18614 .scindex IIDgenoprou2 "generic options" "router"
18615 This chapter describes the generic options that apply to all routers.
18616 Those that are preconditions are marked with &Dagger; in the &"use"& field.
18617
18618 For a general description of how a router operates, see sections
18619 &<<SECTrunindrou>>& and &<<SECTrouprecon>>&. The latter specifies the order in
18620 which the preconditions are tested. The order of expansion of the options that
18621 provide data for a transport is: &%errors_to%&, &%headers_add%&,
18622 &%headers_remove%&, &%transport%&.
18623
18624
18625
18626 .option address_data routers string&!! unset
18627 .cindex "router" "data attached to address"
18628 The string is expanded just before the router is run, that is, after all the
18629 precondition tests have succeeded. If the expansion is forced to fail, the
18630 router declines, the value of &%address_data%& remains unchanged, and the
18631 &%more%& option controls what happens next. Other expansion failures cause
18632 delivery of the address to be deferred.
18633
18634 .vindex "&$address_data$&"
18635 When the expansion succeeds, the value is retained with the address, and can be
18636 accessed using the variable &$address_data$& in the current router, subsequent
18637 routers, and the eventual transport.
18638
18639 &*Warning*&: If the current or any subsequent router is a &(redirect)& router
18640 that runs a user's filter file, the contents of &$address_data$& are accessible
18641 in the filter. This is not normally a problem, because such data is usually
18642 either not confidential or it &"belongs"& to the current user, but if you do
18643 put confidential data into &$address_data$& you need to remember this point.
18644
18645 Even if the router declines or passes, the value of &$address_data$& remains
18646 with the address, though it can be changed by another &%address_data%& setting
18647 on a subsequent router. If a router generates child addresses, the value of
18648 &$address_data$& propagates to them. This also applies to the special kind of
18649 &"child"& that is generated by a router with the &%unseen%& option.
18650
18651 The idea of &%address_data%& is that you can use it to look up a lot of data
18652 for the address once, and then pick out parts of the data later. For example,
18653 you could use a single LDAP lookup to return a string of the form
18654 .code
18655 uid=1234 gid=5678 mailbox=/mail/xyz forward=/home/xyz/.forward
18656 .endd
18657 In the transport you could pick out the mailbox by a setting such as
18658 .code
18659 file = ${extract{mailbox}{$address_data}}
18660 .endd
18661 This makes the configuration file less messy, and also reduces the number of
18662 lookups (though Exim does cache lookups).
18663
18664 See also the &%set%& option below.
18665
18666 .vindex "&$sender_address_data$&"
18667 .vindex "&$address_data$&"
18668 The &%address_data%& facility is also useful as a means of passing information
18669 from one router to another, and from a router to a transport. In addition, if
18670 &$address_data$& is set by a router when verifying a recipient address from an
18671 ACL, it remains available for use in the rest of the ACL statement. After
18672 verifying a sender, the value is transferred to &$sender_address_data$&.
18673
18674
18675
18676 .option address_test routers&!? boolean true
18677 .oindex "&%-bt%&"
18678 .cindex "router" "skipping when address testing"
18679 If this option is set false, the router is skipped when routing is being tested
18680 by means of the &%-bt%& command line option. This can be a convenience when
18681 your first router sends messages to an external scanner, because it saves you
18682 having to set the &"already scanned"& indicator when testing real address
18683 routing.
18684
18685
18686
18687 .option cannot_route_message routers string&!! unset
18688 .cindex "router" "customizing &""cannot route""& message"
18689 .cindex "customizing" "&""cannot route""& message"
18690 This option specifies a text message that is used when an address cannot be
18691 routed because Exim has run out of routers. The default message is
18692 &"Unrouteable address"&. This option is useful only on routers that have
18693 &%more%& set false, or on the very last router in a configuration, because the
18694 value that is used is taken from the last router that is considered. This
18695 includes a router that is skipped because its preconditions are not met, as
18696 well as a router that declines. For example, using the default configuration,
18697 you could put:
18698 .code
18699 cannot_route_message = Remote domain not found in DNS
18700 .endd
18701 on the first router, which is a &(dnslookup)& router with &%more%& set false,
18702 and
18703 .code
18704 cannot_route_message = Unknown local user
18705 .endd
18706 on the final router that checks for local users. If string expansion fails for
18707 this option, the default message is used. Unless the expansion failure was
18708 explicitly forced, a message about the failure is written to the main and panic
18709 logs, in addition to the normal message about the routing failure.
18710
18711
18712 .option caseful_local_part routers boolean false
18713 .cindex "case of local parts"
18714 .cindex "router" "case of local parts"
18715 By default, routers handle the local parts of addresses in a case-insensitive
18716 manner, though the actual case is preserved for transmission with the message.
18717 If you want the case of letters to be significant in a router, you must set
18718 this option true. For individual router options that contain address or local
18719 part lists (for example, &%local_parts%&), case-sensitive matching can be
18720 turned on by &"+caseful"& as a list item. See section &<<SECTcasletadd>>& for
18721 more details.
18722
18723 .vindex "&$local_part$&"
18724 .vindex "&$original_local_part$&"
18725 .vindex "&$parent_local_part$&"
18726 The value of the &$local_part$& variable is forced to lower case while a
18727 router is running unless &%caseful_local_part%& is set. When a router assigns
18728 an address to a transport, the value of &$local_part$& when the transport runs
18729 is the same as it was in the router. Similarly, when a router generates child
18730 addresses by aliasing or forwarding, the values of &$original_local_part$&
18731 and &$parent_local_part$& are those that were used by the redirecting router.
18732
18733 This option applies to the processing of an address by a router. When a
18734 recipient address is being processed in an ACL, there is a separate &%control%&
18735 modifier that can be used to specify case-sensitive processing within the ACL
18736 (see section &<<SECTcontrols>>&).
18737
18738
18739
18740 .option check_local_user routers&!? boolean false
18741 .cindex "local user, checking in router"
18742 .cindex "router" "checking for local user"
18743 .cindex "&_/etc/passwd_&"
18744 .vindex "&$home$&"
18745 When this option is true, Exim checks that the local part of the recipient
18746 address (with affixes removed if relevant) is the name of an account on the
18747 local system. The check is done by calling the &[getpwnam()]& function rather
18748 than trying to read &_/etc/passwd_& directly. This means that other methods of
18749 holding password data (such as NIS) are supported. If the local part is a local
18750 user, &$home$& is set from the password data, and can be tested in other
18751 preconditions that are evaluated after this one (the order of evaluation is
18752 given in section &<<SECTrouprecon>>&). However, the value of &$home$& can be
18753 overridden by &%router_home_directory%&. If the local part is not a local user,
18754 the router is skipped.
18755
18756 If you want to check that the local part is either the name of a local user
18757 or matches something else, you cannot combine &%check_local_user%& with a
18758 setting of &%local_parts%&, because that specifies the logical &'and'& of the
18759 two conditions. However, you can use a &(passwd)& lookup in a &%local_parts%&
18760 setting to achieve this. For example:
18761 .code
18762 local_parts = passwd;$local_part : lsearch;/etc/other/users
18763 .endd
18764 Note, however, that the side effects of &%check_local_user%& (such as setting
18765 up a home directory) do not occur when a &(passwd)& lookup is used in a
18766 &%local_parts%& (or any other) precondition.
18767
18768
18769
18770 .option condition routers&!? string&!! unset
18771 .cindex "router" "customized precondition"
18772 This option specifies a general precondition test that has to succeed for the
18773 router to be called. The &%condition%& option is the last precondition to be
18774 evaluated (see section &<<SECTrouprecon>>&). The string is expanded, and if the
18775 result is a forced failure, or an empty string, or one of the strings &"0"& or
18776 &"no"& or &"false"& (checked without regard to the case of the letters), the
18777 router is skipped, and the address is offered to the next one.
18778
18779 If the result is any other value, the router is run (as this is the last
18780 precondition to be evaluated, all the other preconditions must be true).
18781
18782 This option is unusual in that multiple &%condition%& options may be present.
18783 All &%condition%& options must succeed.
18784
18785 The &%condition%& option provides a means of applying custom conditions to the
18786 running of routers. Note that in the case of a simple conditional expansion,
18787 the default expansion values are exactly what is wanted. For example:
18788 .code
18789 condition = ${if >{$message_age}{600}}
18790 .endd
18791 Because of the default behaviour of the string expansion, this is equivalent to
18792 .code
18793 condition = ${if >{$message_age}{600}{true}{}}
18794 .endd
18795
18796 A multiple condition example, which succeeds:
18797 .code
18798 condition = ${if >{$message_age}{600}}
18799 condition = ${if !eq{${lc:$local_part}}{postmaster}}
18800 condition = foobar
18801 .endd
18802
18803 If the expansion fails (other than forced failure) delivery is deferred. Some
18804 of the other precondition options are common special cases that could in fact
18805 be specified using &%condition%&.
18806
18807 Historical note: We have &%condition%& on ACLs and on Routers.  Routers
18808 are far older, and use one set of semantics.  ACLs are newer and when
18809 they were created, the ACL &%condition%& process was given far stricter
18810 parse semantics.  The &%bool{}%& expansion condition uses the same rules as
18811 ACLs.  The &%bool_lax{}%& expansion condition uses the same rules as
18812 Routers.  More pointedly, the &%bool_lax{}%& was written to match the existing
18813 Router rules processing behavior.
18814
18815 This is best illustrated in an example:
18816 .code
18817 # If used in an ACL condition will fail with a syntax error, but
18818 # in a router condition any extra characters are treated as a string
18819
18820 $ exim -be '${if eq {${lc:GOOGLE.com}} {google.com}} {yes} {no}}'
18821 true {yes} {no}}
18822
18823 $ exim -be '${if eq {${lc:WHOIS.com}} {google.com}} {yes} {no}}'
18824  {yes} {no}}
18825 .endd
18826 In each example above, the &%if%& statement actually ends after
18827 &"{google.com}}"&.  Since no true or false braces were defined, the
18828 default &%if%& behavior is to return a boolean true or a null answer
18829 (which evaluates to false). The rest of the line is then treated as a
18830 string. So the first example resulted in the boolean answer &"true"&
18831 with the string &" {yes} {no}}"& appended to it. The second example
18832 resulted in the null output (indicating false) with the string
18833 &" {yes} {no}}"& appended to it.
18834
18835 In fact you can put excess forward braces in too.  In the router
18836 &%condition%&, Exim's parser only looks for &"{"& symbols when they
18837 mean something, like after a &"$"& or when required as part of a
18838 conditional.  But otherwise &"{"& and &"}"& are treated as ordinary
18839 string characters.
18840
18841 Thus, in a Router, the above expansion strings will both always evaluate
18842 true, as the result of expansion is a non-empty string which doesn't
18843 match an explicit false value.  This can be tricky to debug.  By
18844 contrast, in an ACL either of those strings will always result in an
18845 expansion error because the result doesn't look sufficiently boolean.
18846
18847
18848 .option debug_print routers string&!! unset
18849 .cindex "testing" "variables in drivers"
18850 If this option is set and debugging is enabled (see the &%-d%& command line
18851 option) or in address-testing mode (see the &%-bt%& command line option),
18852 the string is expanded and included in the debugging output.
18853 If expansion of the string fails, the error message is written to the debugging
18854 output, and Exim carries on processing.
18855 This option is provided to help with checking out the values of variables and
18856 so on when debugging router configurations. For example, if a &%condition%&
18857 option appears not to be working, &%debug_print%& can be used to output the
18858 variables it references. The output happens after checks for &%domains%&,
18859 &%local_parts%&, and &%check_local_user%& but before any other preconditions
18860 are tested. A newline is added to the text if it does not end with one.
18861 The variable &$router_name$& contains the name of the router.
18862
18863
18864
18865 .option disable_logging routers boolean false
18866 If this option is set true, nothing is logged for any routing errors
18867 or for any deliveries caused by this router. You should not set this option
18868 unless you really, really know what you are doing. See also the generic
18869 transport option of the same name.
18870
18871 .option dnssec_request_domains routers "domain list&!!" *
18872 .cindex "MX record" "security"
18873 .cindex "DNSSEC" "MX lookup"
18874 .cindex "security" "MX lookup"
18875 .cindex "DNS" "DNSSEC"
18876 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
18877 the dnssec request bit set.
18878 This applies to all of the SRV, MX, AAAA, A lookup sequence.
18879
18880 .option dnssec_require_domains routers "domain list&!!" unset
18881 .cindex "MX record" "security"
18882 .cindex "DNSSEC" "MX lookup"
18883 .cindex "security" "MX lookup"
18884 .cindex "DNS" "DNSSEC"
18885 DNS lookups for domains matching &%dnssec_require_domains%& will be done with
18886 the dnssec request bit set.  Any returns not having the Authenticated Data bit
18887 (AD bit) set will be ignored and logged as a host-lookup failure.
18888 This applies to all of the SRV, MX, AAAA, A lookup sequence.
18889
18890
18891 .option domains routers&!? "domain list&!!" unset
18892 .cindex "router" "restricting to specific domains"
18893 .vindex "&$domain_data$&"
18894 If this option is set, the router is skipped unless the current domain matches
18895 the list. If the match is achieved by means of a file lookup, the data that the
18896 lookup returned for the domain is placed in &$domain_data$& for use in string
18897 expansions of the driver's private options. See section &<<SECTrouprecon>>& for
18898 a list of the order in which preconditions are evaluated.
18899
18900
18901
18902 .option driver routers string unset
18903 This option must always be set. It specifies which of the available routers is
18904 to be used.
18905
18906
18907 .option dsn_lasthop routers boolean false
18908 .cindex "DSN" "success"
18909 .cindex "Delivery Status Notification" "success"
18910 If this option is set true, and extended DSN (RFC3461) processing is in effect,
18911 Exim will not pass on DSN requests to downstream DSN-aware hosts but will
18912 instead send a success DSN as if the next hop does not support DSN.
18913 Not effective on redirect routers.
18914
18915
18916
18917 .option errors_to routers string&!! unset
18918 .cindex "envelope from"
18919 .cindex "envelope sender"
18920 .cindex "router" "changing address for errors"
18921 If a router successfully handles an address, it may assign the address to a
18922 transport for delivery or it may generate child addresses. In both cases, if
18923 there is a delivery problem during later processing, the resulting bounce
18924 message is sent to the address that results from expanding this string,
18925 provided that the address verifies successfully. The &%errors_to%& option is
18926 expanded before &%headers_add%&, &%headers_remove%&, and &%transport%&.
18927
18928 The &%errors_to%& setting associated with an address can be overridden if it
18929 subsequently passes through other routers that have their own &%errors_to%&
18930 settings, or if the message is delivered by a transport with a &%return_path%&
18931 setting.
18932
18933 If &%errors_to%& is unset, or the expansion is forced to fail, or the result of
18934 the expansion fails to verify, the errors address associated with the incoming
18935 address is used. At top level, this is the envelope sender. A non-forced
18936 expansion failure causes delivery to be deferred.
18937
18938 If an address for which &%errors_to%& has been set ends up being delivered over
18939 SMTP, the envelope sender for that delivery is the &%errors_to%& value, so that
18940 any bounces that are generated by other MTAs on the delivery route are also
18941 sent there. You can set &%errors_to%& to the empty string by either of these
18942 settings:
18943 .code
18944 errors_to =
18945 errors_to = ""
18946 .endd
18947 An expansion item that yields an empty string has the same effect. If you do
18948 this, a locally detected delivery error for addresses processed by this router
18949 no longer gives rise to a bounce message; the error is discarded. If the
18950 address is delivered to a remote host, the return path is set to &`<>`&, unless
18951 overridden by the &%return_path%& option on the transport.
18952
18953 .vindex "&$address_data$&"
18954 If for some reason you want to discard local errors, but use a non-empty
18955 MAIL command for remote delivery, you can preserve the original return
18956 path in &$address_data$& in the router, and reinstate it in the transport by
18957 setting &%return_path%&.
18958
18959 The most common use of &%errors_to%& is to direct mailing list bounces to the
18960 manager of the list, as described in section &<<SECTmailinglists>>&, or to
18961 implement VERP (Variable Envelope Return Paths) (see section &<<SECTverp>>&).
18962
18963
18964
18965 .option expn routers&!? boolean true
18966 .cindex "address" "testing"
18967 .cindex "testing" "addresses"
18968 .cindex "EXPN" "router skipping"
18969 .cindex "router" "skipping for EXPN"
18970 If this option is turned off, the router is skipped when testing an address
18971 as a result of processing an SMTP EXPN command. You might, for example,
18972 want to turn it off on a router for users' &_.forward_& files, while leaving it
18973 on for the system alias file.
18974 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18975 are evaluated.
18976
18977 The use of the SMTP EXPN command is controlled by an ACL (see chapter
18978 &<<CHAPACL>>&). When Exim is running an EXPN command, it is similar to testing
18979 an address with &%-bt%&. Compare VRFY, whose counterpart is &%-bv%&.
18980
18981
18982
18983 .option fail_verify routers boolean false
18984 .cindex "router" "forcing verification failure"
18985 Setting this option has the effect of setting both &%fail_verify_sender%& and
18986 &%fail_verify_recipient%& to the same value.
18987
18988
18989
18990 .option fail_verify_recipient routers boolean false
18991 If this option is true and an address is accepted by this router when
18992 verifying a recipient, verification fails.
18993
18994
18995
18996 .option fail_verify_sender routers boolean false
18997 If this option is true and an address is accepted by this router when
18998 verifying a sender, verification fails.
18999
19000
19001
19002 .option fallback_hosts routers "string list" unset
19003 .cindex "router" "fallback hosts"
19004 .cindex "fallback" "hosts specified on router"
19005 String expansion is not applied to this option. The argument must be a
19006 colon-separated list of host names or IP addresses. The list separator can be
19007 changed (see section &<<SECTlistsepchange>>&), and a port can be specified with
19008 each name or address. In fact, the format of each item is exactly the same as
19009 defined for the list of hosts in a &(manualroute)& router (see section
19010 &<<SECTformatonehostitem>>&).
19011
19012 If a router queues an address for a remote transport, this host list is
19013 associated with the address, and used instead of the transport's fallback host
19014 list. If &%hosts_randomize%& is set on the transport, the order of the list is
19015 randomized for each use. See the &%fallback_hosts%& option of the &(smtp)&
19016 transport for further details.
19017
19018
19019 .option group routers string&!! "see below"
19020 .cindex "gid (group id)" "local delivery"
19021 .cindex "local transports" "uid and gid"
19022 .cindex "transport" "local"
19023 .cindex "router" "setting group"
19024 When a router queues an address for a transport, and the transport does not
19025 specify a group, the group given here is used when running the delivery
19026 process.
19027 The group may be specified numerically or by name. If expansion fails, the
19028 error is logged and delivery is deferred.
19029 The default is unset, unless &%check_local_user%& is set, when the default
19030 is taken from the password information. See also &%initgroups%& and &%user%&
19031 and the discussion in chapter &<<CHAPenvironment>>&.
19032
19033
19034
19035 .option headers_add routers list&!! unset
19036 .cindex "header lines" "adding"
19037 .cindex "router" "adding header lines"
19038 This option specifies a list of text headers,
19039 newline-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
19040 that is associated with any addresses that are accepted by the router.
19041 Each item is separately expanded, at routing time.  However, this
19042 option has no effect when an address is just being verified. The way in which
19043 the text is used to add header lines at transport time is described in section
19044 &<<SECTheadersaddrem>>&. New header lines are not actually added until the
19045 message is in the process of being transported. This means that references to
19046 header lines in string expansions in the transport's configuration do not
19047 &"see"& the added header lines.
19048
19049 The &%headers_add%& option is expanded after &%errors_to%&, but before
19050 &%headers_remove%& and &%transport%&. If an item is empty, or if
19051 an item expansion is forced to fail, the item has no effect. Other expansion
19052 failures are treated as configuration errors.
19053
19054 Unlike most options, &%headers_add%& can be specified multiple times
19055 for a router; all listed headers are added.
19056
19057 &*Warning 1*&: The &%headers_add%& option cannot be used for a &(redirect)&
19058 router that has the &%one_time%& option set.
19059
19060 .cindex "duplicate addresses"
19061 .oindex "&%unseen%&"
19062 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
19063 additions are deleted when the address is passed on to subsequent routers.
19064 For a &%redirect%& router, if a generated address is the same as the incoming
19065 address, this can lead to duplicate addresses with different header
19066 modifications. Exim does not do duplicate deliveries (except, in certain
19067 circumstances, to pipes -- see section &<<SECTdupaddr>>&), but it is undefined
19068 which of the duplicates is discarded, so this ambiguous situation should be
19069 avoided. The &%repeat_use%& option of the &%redirect%& router may be of help.
19070
19071
19072
19073 .option headers_remove routers list&!! unset
19074 .cindex "header lines" "removing"
19075 .cindex "router" "removing header lines"
19076 This option specifies a list of text headers,
19077 colon-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
19078 that is associated with any addresses that are accepted by the router.
19079 However, the option has no effect when an address is just being verified.
19080 Each list item is separately expanded, at transport time.
19081 If an item ends in *, it will match any header with the given prefix.
19082 The way in which
19083 the text is used to remove header lines at transport time is described in
19084 section &<<SECTheadersaddrem>>&. Header lines are not actually removed until
19085 the message is in the process of being transported. This means that references
19086 to header lines in string expansions in the transport's configuration still
19087 &"see"& the original header lines.
19088
19089 The &%headers_remove%& option is handled after &%errors_to%& and
19090 &%headers_add%&, but before &%transport%&. If an item expansion is forced to fail,
19091 the item has no effect. Other expansion failures are treated as configuration
19092 errors.
19093
19094 Unlike most options, &%headers_remove%& can be specified multiple times
19095 for a router; all listed headers are removed.
19096
19097 &*Warning 1*&: The &%headers_remove%& option cannot be used for a &(redirect)&
19098 router that has the &%one_time%& option set.
19099
19100 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
19101 removal requests are deleted when the address is passed on to subsequent
19102 routers, and this can lead to problems with duplicates -- see the similar
19103 warning for &%headers_add%& above.
19104
19105 &*Warning 3*&: Because of the separate expansion of the list items,
19106 items that contain a list separator must have it doubled.
19107 To avoid this, change the list separator (&<<SECTlistsepchange>>&).
19108
19109
19110
19111 .option ignore_target_hosts routers "host list&!!" unset
19112 .cindex "IP address" "discarding"
19113 .cindex "router" "discarding IP addresses"
19114 Although this option is a host list, it should normally contain IP address
19115 entries rather than names. If any host that is looked up by the router has an
19116 IP address that matches an item in this list, Exim behaves as if that IP
19117 address did not exist. This option allows you to cope with rogue DNS entries
19118 like
19119 .code
19120 remote.domain.example.  A  127.0.0.1
19121 .endd
19122 by setting
19123 .code
19124 ignore_target_hosts = 127.0.0.1
19125 .endd
19126 on the relevant router. If all the hosts found by a &(dnslookup)& router are
19127 discarded in this way, the router declines. In a conventional configuration, an
19128 attempt to mail to such a domain would normally provoke the &"unrouteable
19129 domain"& error, and an attempt to verify an address in the domain would fail.
19130 Similarly, if &%ignore_target_hosts%& is set on an &(ipliteral)& router, the
19131 router declines if presented with one of the listed addresses.
19132
19133 You can use this option to disable the use of IPv4 or IPv6 for mail delivery by
19134 means of the first or the second of the following settings, respectively:
19135 .code
19136 ignore_target_hosts = 0.0.0.0/0
19137 ignore_target_hosts = <; 0::0/0
19138 .endd
19139 The pattern in the first line matches all IPv4 addresses, whereas the pattern
19140 in the second line matches all IPv6 addresses.
19141
19142 This option may also be useful for ignoring link-local and site-local IPv6
19143 addresses. Because, like all host lists, the value of &%ignore_target_hosts%&
19144 is expanded before use as a list, it is possible to make it dependent on the
19145 domain that is being routed.
19146
19147 .vindex "&$host_address$&"
19148 During its expansion, &$host_address$& is set to the IP address that is being
19149 checked.
19150
19151 .option initgroups routers boolean false
19152 .cindex "additional groups"
19153 .cindex "groups" "additional"
19154 .cindex "local transports" "uid and gid"
19155 .cindex "transport" "local"
19156 If the router queues an address for a transport, and this option is true, and
19157 the uid supplied by the router is not overridden by the transport, the
19158 &[initgroups()]& function is called when running the transport to ensure that
19159 any additional groups associated with the uid are set up. See also &%group%&
19160 and &%user%& and the discussion in chapter &<<CHAPenvironment>>&.
19161
19162
19163
19164 .option local_part_prefix routers&!? "string list" unset
19165 .cindex affix "router precondition"
19166 .cindex "router" "prefix for local part"
19167 .cindex "prefix" "for local part, used in router"
19168 If this option is set, the router is skipped unless the local part starts with
19169 one of the given strings, or &%local_part_prefix_optional%& is true. See
19170 section &<<SECTrouprecon>>& for a list of the order in which preconditions are
19171 evaluated.
19172
19173 The list is scanned from left to right, and the first prefix that matches is
19174 used. A limited form of wildcard is available; if the prefix begins with an
19175 asterisk, it matches the longest possible sequence of arbitrary characters at
19176 the start of the local part. An asterisk should therefore always be followed by
19177 some character that does not occur in normal local parts.
19178 .cindex "multiple mailboxes"
19179 .cindex "mailbox" "multiple"
19180 Wildcarding can be used to set up multiple user mailboxes, as described in
19181 section &<<SECTmulbox>>&.
19182
19183 .vindex "&$local_part$&"
19184 .vindex "&$local_part_prefix$&"
19185 During the testing of the &%local_parts%& option, and while the router is
19186 running, the prefix is removed from the local part, and is available in the
19187 expansion variable &$local_part_prefix$&. When a message is being delivered, if
19188 the router accepts the address, this remains true during subsequent delivery by
19189 a transport. In particular, the local part that is transmitted in the RCPT
19190 command for LMTP, SMTP, and BSMTP deliveries has the prefix removed by default.
19191 This behaviour can be overridden by setting &%rcpt_include_affixes%& true on
19192 the relevant transport.
19193
19194 .vindex &$local_part_prefix_v$&
19195 If wildcarding (above) was used then the part of the prefix matching the
19196 wildcard is available in &$local_part_prefix_v$&.
19197
19198 When an address is being verified, &%local_part_prefix%& affects only the
19199 behaviour of the router. If the callout feature of verification is in use, this
19200 means that the full address, including the prefix, will be used during the
19201 callout.
19202
19203 The prefix facility is commonly used to handle local parts of the form
19204 &%owner-something%&. Another common use is to support local parts of the form
19205 &%real-username%& to bypass a user's &_.forward_& file &-- helpful when trying
19206 to tell a user their forwarding is broken &-- by placing a router like this one
19207 immediately before the router that handles &_.forward_& files:
19208 .code
19209 real_localuser:
19210   driver = accept
19211   local_part_prefix = real-
19212   check_local_user
19213   transport = local_delivery
19214 .endd
19215 For security, it would probably be a good idea to restrict the use of this
19216 router to locally-generated messages, using a condition such as this:
19217 .code
19218   condition = ${if match {$sender_host_address}\
19219                          {\N^(|127\.0\.0\.1)$\N}}
19220 .endd
19221
19222 If both &%local_part_prefix%& and &%local_part_suffix%& are set for a router,
19223 both conditions must be met if not optional. Care must be taken if wildcards
19224 are used in both a prefix and a suffix on the same router. Different
19225 separator characters must be used to avoid ambiguity.
19226
19227
19228 .option local_part_prefix_optional routers boolean false
19229 See &%local_part_prefix%& above.
19230
19231
19232
19233 .option local_part_suffix routers&!? "string list" unset
19234 .cindex "router" "suffix for local part"
19235 .cindex "suffix for local part" "used in router"
19236 This option operates in the same way as &%local_part_prefix%&, except that the
19237 local part must end (rather than start) with the given string, the
19238 &%local_part_suffix_optional%& option determines whether the suffix is
19239 mandatory, and the wildcard * character, if present, must be the last
19240 character of the suffix. This option facility is commonly used to handle local
19241 parts of the form &%something-request%& and multiple user mailboxes of the form
19242 &%username-foo%&.
19243
19244
19245 .option local_part_suffix_optional routers boolean false
19246 See &%local_part_suffix%& above.
19247
19248
19249
19250 .option local_parts routers&!? "local part list&!!" unset
19251 .cindex "router" "restricting to specific local parts"
19252 .cindex "local part" "checking in router"
19253 The router is run only if the local part of the address matches the list.
19254 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19255 are evaluated, and
19256 section &<<SECTlocparlis>>& for a discussion of local part lists. Because the
19257 string is expanded, it is possible to make it depend on the domain, for
19258 example:
19259 .code
19260 local_parts = dbm;/usr/local/specials/$domain
19261 .endd
19262 .vindex "&$local_part_data$&"
19263 If the match is achieved by a lookup, the data that the lookup returned
19264 for the local part is placed in the variable &$local_part_data$& for use in
19265 expansions of the router's private options. You might use this option, for
19266 example, if you have a large number of local virtual domains, and you want to
19267 send all postmaster mail to the same place without having to set up an alias in
19268 each virtual domain:
19269 .code
19270 postmaster:
19271   driver = redirect
19272   local_parts = postmaster
19273   data = postmaster@real.domain.example
19274 .endd
19275
19276
19277 .option log_as_local routers boolean "see below"
19278 .cindex "log" "delivery line"
19279 .cindex "delivery" "log line format"
19280 Exim has two logging styles for delivery, the idea being to make local
19281 deliveries stand out more visibly from remote ones. In the &"local"& style, the
19282 recipient address is given just as the local part, without a domain. The use of
19283 this style is controlled by this option. It defaults to true for the &(accept)&
19284 router, and false for all the others. This option applies only when a
19285 router assigns an address to a transport. It has no effect on routers that
19286 redirect addresses.
19287
19288
19289
19290 .option more routers boolean&!! true
19291 The result of string expansion for this option must be a valid boolean value,
19292 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
19293 result causes an error, and delivery is deferred. If the expansion is forced to
19294 fail, the default value for the option (true) is used. Other failures cause
19295 delivery to be deferred.
19296
19297 If this option is set false, and the router declines to handle the address, no
19298 further routers are tried, routing fails, and the address is bounced.
19299 .oindex "&%self%&"
19300 However, if the router explicitly passes an address to the following router by
19301 means of the setting
19302 .code
19303 self = pass
19304 .endd
19305 or otherwise, the setting of &%more%& is ignored. Also, the setting of &%more%&
19306 does not affect the behaviour if one of the precondition tests fails. In that
19307 case, the address is always passed to the next router.
19308
19309 Note that &%address_data%& is not considered to be a precondition. If its
19310 expansion is forced to fail, the router declines, and the value of &%more%&
19311 controls what happens next.
19312
19313
19314 .option pass_on_timeout routers boolean false
19315 .cindex "timeout" "of router"
19316 .cindex "router" "timeout"
19317 If a router times out during a host lookup, it normally causes deferral of the
19318 address. If &%pass_on_timeout%& is set, the address is passed on to the next
19319 router, overriding &%no_more%&. This may be helpful for systems that are
19320 intermittently connected to the Internet, or those that want to pass to a smart
19321 host any messages that cannot immediately be delivered.
19322
19323 There are occasional other temporary errors that can occur while doing DNS
19324 lookups. They are treated in the same way as a timeout, and this option
19325 applies to all of them.
19326
19327
19328
19329 .option pass_router routers string unset
19330 .cindex "router" "go to after &""pass""&"
19331 Routers that recognize the generic &%self%& option (&(dnslookup)&,
19332 &(ipliteral)&, and &(manualroute)&) are able to return &"pass"&, forcing
19333 routing to continue, and overriding a false setting of &%more%&. When one of
19334 these routers returns &"pass"&, the address is normally handed on to the next
19335 router in sequence. This can be changed by setting &%pass_router%& to the name
19336 of another router. However (unlike &%redirect_router%&) the named router must
19337 be below the current router, to avoid loops. Note that this option applies only
19338 to the special case of &"pass"&. It does not apply when a router returns
19339 &"decline"& because it cannot handle an address.
19340
19341
19342
19343 .option redirect_router routers string unset
19344 .cindex "router" "start at after redirection"
19345 Sometimes an administrator knows that it is pointless to reprocess addresses
19346 generated from alias or forward files with the same router again. For
19347 example, if an alias file translates real names into login ids there is no
19348 point searching the alias file a second time, especially if it is a large file.
19349
19350 The &%redirect_router%& option can be set to the name of any router instance.
19351 It causes the routing of any generated addresses to start at the named router
19352 instead of at the first router. This option has no effect if the router in
19353 which it is set does not generate new addresses.
19354
19355
19356
19357 .option require_files routers&!? "string list&!!" unset
19358 .cindex "file" "requiring for router"
19359 .cindex "router" "requiring file existence"
19360 This option provides a general mechanism for predicating the running of a
19361 router on the existence or non-existence of certain files or directories.
19362 Before running a router, as one of its precondition tests, Exim works its way
19363 through the &%require_files%& list, expanding each item separately.
19364
19365 Because the list is split before expansion, any colons in expansion items must
19366 be doubled, or the facility for using a different list separator must be used
19367 (&<<SECTlistsepchange>>&).
19368 If any expansion is forced to fail, the item is ignored. Other expansion
19369 failures cause routing of the address to be deferred.
19370
19371 If any expanded string is empty, it is ignored. Otherwise, except as described
19372 below, each string must be a fully qualified file path, optionally preceded by
19373 &"!"&. The paths are passed to the &[stat()]& function to test for the
19374 existence of the files or directories. The router is skipped if any paths not
19375 preceded by &"!"& do not exist, or if any paths preceded by &"!"& do exist.
19376
19377 .cindex "NFS"
19378 If &[stat()]& cannot determine whether a file exists or not, delivery of
19379 the message is deferred. This can happen when NFS-mounted filesystems are
19380 unavailable.
19381
19382 This option is checked after the &%domains%&, &%local_parts%&, and &%senders%&
19383 options, so you cannot use it to check for the existence of a file in which to
19384 look up a domain, local part, or sender. (See section &<<SECTrouprecon>>& for a
19385 full list of the order in which preconditions are evaluated.) However, as
19386 these options are all expanded, you can use the &%exists%& expansion condition
19387 to make such tests. The &%require_files%& option is intended for checking files
19388 that the router may be going to use internally, or which are needed by a
19389 transport (e.g., &_.procmailrc_&).
19390
19391 During delivery, the &[stat()]& function is run as root, but there is a
19392 facility for some checking of the accessibility of a file by another user.
19393 This is not a proper permissions check, but just a &"rough"& check that
19394 operates as follows:
19395
19396 If an item in a &%require_files%& list does not contain any forward slash
19397 characters, it is taken to be the user (and optional group, separated by a
19398 comma) to be checked for subsequent files in the list. If no group is specified
19399 but the user is specified symbolically, the gid associated with the uid is
19400 used. For example:
19401 .code
19402 require_files = mail:/some/file
19403 require_files = $local_part_data:$home/.procmailrc
19404 .endd
19405 If a user or group name in a &%require_files%& list does not exist, the
19406 &%require_files%& condition fails.
19407
19408 Exim performs the check by scanning along the components of the file path, and
19409 checking the access for the given uid and gid. It checks for &"x"& access on
19410 directories, and &"r"& access on the final file. Note that this means that file
19411 access control lists, if the operating system has them, are ignored.
19412
19413 &*Warning 1*&: When the router is being run to verify addresses for an
19414 incoming SMTP message, Exim is not running as root, but under its own uid. This
19415 may affect the result of a &%require_files%& check. In particular, &[stat()]&
19416 may yield the error EACCES (&"Permission denied"&). This means that the Exim
19417 user is not permitted to read one of the directories on the file's path.
19418
19419 &*Warning 2*&: Even when Exim is running as root while delivering a message,
19420 &[stat()]& can yield EACCES for a file in an NFS directory that is mounted
19421 without root access. In this case, if a check for access by a particular user
19422 is requested, Exim creates a subprocess that runs as that user, and tries the
19423 check again in that process.
19424
19425 The default action for handling an unresolved EACCES is to consider it to
19426 be caused by a configuration error, and routing is deferred because the
19427 existence or non-existence of the file cannot be determined. However, in some
19428 circumstances it may be desirable to treat this condition as if the file did
19429 not exist. If the filename (or the exclamation mark that precedes the filename
19430 for non-existence) is preceded by a plus sign, the EACCES error is treated
19431 as if the file did not exist. For example:
19432 .code
19433 require_files = +/some/file
19434 .endd
19435 If the router is not an essential part of verification (for example, it
19436 handles users' &_.forward_& files), another solution is to set the &%verify%&
19437 option false so that the router is skipped when verifying.
19438
19439
19440
19441 .option retry_use_local_part routers boolean "see below"
19442 .cindex "hints database" "retry keys"
19443 .cindex "local part" "in retry keys"
19444 When a delivery suffers a temporary routing failure, a retry record is created
19445 in Exim's hints database. For addresses whose routing depends only on the
19446 domain, the key for the retry record should not involve the local part, but for
19447 other addresses, both the domain and the local part should be included.
19448 Usually, remote routing is of the former kind, and local routing is of the
19449 latter kind.
19450
19451 This option controls whether the local part is used to form the key for retry
19452 hints for addresses that suffer temporary errors while being handled by this
19453 router. The default value is true for any router that has any of
19454 &%check_local_user%&,
19455 &%local_parts%&,
19456 &%condition%&,
19457 &%local_part_prefix%&,
19458 &%local_part_suffix%&,
19459 &%senders%& or
19460 &%require_files%&
19461 set, and false otherwise. Note that this option does not apply to hints keys
19462 for transport delays; they are controlled by a generic transport option of the
19463 same name.
19464
19465 Failing to set this option when it is needed
19466 (because a remote router handles only some of the local-parts for a domain)
19467 can result in incorrect error messages being generated.
19468
19469 The setting of &%retry_use_local_part%& applies only to the router on which it
19470 appears. If the router generates child addresses, they are routed
19471 independently; this setting does not become attached to them.
19472
19473
19474
19475 .option router_home_directory routers string&!! unset
19476 .cindex "router" "home directory for"
19477 .cindex "home directory" "for router"
19478 .vindex "&$home$&"
19479 This option sets a home directory for use while the router is running. (Compare
19480 &%transport_home_directory%&, which sets a home directory for later
19481 transporting.) In particular, if used on a &(redirect)& router, this option
19482 sets a value for &$home$& while a filter is running. The value is expanded;
19483 forced expansion failure causes the option to be ignored &-- other failures
19484 cause the router to defer.
19485
19486 Expansion of &%router_home_directory%& happens immediately after the
19487 &%check_local_user%& test (if configured), before any further expansions take
19488 place.
19489 (See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19490 are evaluated.)
19491 While the router is running, &%router_home_directory%& overrides the value of
19492 &$home$& that came from &%check_local_user%&.
19493
19494 When a router accepts an address and assigns it to a local transport (including
19495 the cases when a &(redirect)& router generates a pipe, file, or autoreply
19496 delivery), the home directory setting for the transport is taken from the first
19497 of these values that is set:
19498
19499 .ilist
19500 The &%home_directory%& option on the transport;
19501 .next
19502 The &%transport_home_directory%& option on the router;
19503 .next
19504 The password data if &%check_local_user%& is set on the router;
19505 .next
19506 The &%router_home_directory%& option on the router.
19507 .endlist
19508
19509 In other words, &%router_home_directory%& overrides the password data for the
19510 router, but not for the transport.
19511
19512
19513
19514 .option self routers string freeze
19515 .cindex "MX record" "pointing to local host"
19516 .cindex "local host" "MX pointing to"
19517 This option applies to those routers that use a recipient address to find a
19518 list of remote hosts. Currently, these are the &(dnslookup)&, &(ipliteral)&,
19519 and &(manualroute)& routers.
19520 Certain configurations of the &(queryprogram)& router can also specify a list
19521 of remote hosts.
19522 Usually such routers are configured to send the message to a remote host via an
19523 &(smtp)& transport. The &%self%& option specifies what happens when the first
19524 host on the list turns out to be the local host.
19525 The way in which Exim checks for the local host is described in section
19526 &<<SECTreclocipadd>>&.
19527
19528 Normally this situation indicates either an error in Exim's configuration (for
19529 example, the router should be configured not to process this domain), or an
19530 error in the DNS (for example, the MX should not point to this host). For this
19531 reason, the default action is to log the incident, defer the address, and
19532 freeze the message. The following alternatives are provided for use in special
19533 cases:
19534
19535 .vlist
19536 .vitem &%defer%&
19537 Delivery of the message is tried again later, but the message is not frozen.
19538
19539 .vitem "&%reroute%&: <&'domain'&>"
19540 The domain is changed to the given domain, and the address is passed back to
19541 be reprocessed by the routers. No rewriting of headers takes place. This
19542 behaviour is essentially a redirection.
19543
19544 .vitem "&%reroute: rewrite:%& <&'domain'&>"
19545 The domain is changed to the given domain, and the address is passed back to be
19546 reprocessed by the routers. Any headers that contain the original domain are
19547 rewritten.
19548
19549 .vitem &%pass%&
19550 .oindex "&%more%&"
19551 .vindex "&$self_hostname$&"
19552 The router passes the address to the next router, or to the router named in the
19553 &%pass_router%& option if it is set. This overrides &%no_more%&. During
19554 subsequent routing and delivery, the variable &$self_hostname$& contains the
19555 name of the local host that the router encountered. This can be used to
19556 distinguish between different cases for hosts with multiple names. The
19557 combination
19558 .code
19559 self = pass
19560 no_more
19561 .endd
19562 ensures that only those addresses that routed to the local host are passed on.
19563 Without &%no_more%&, addresses that were declined for other reasons would also
19564 be passed to the next router.
19565
19566 .vitem &%fail%&
19567 Delivery fails and an error report is generated.
19568
19569 .vitem &%send%&
19570 .cindex "local host" "sending to"
19571 The anomaly is ignored and the address is queued for the transport. This
19572 setting should be used with extreme caution. For an &(smtp)& transport, it
19573 makes sense only in cases where the program that is listening on the SMTP port
19574 is not this version of Exim. That is, it must be some other MTA, or Exim with a
19575 different configuration file that handles the domain in another way.
19576 .endlist
19577
19578
19579
19580 .option senders routers&!? "address list&!!" unset
19581 .cindex "router" "checking senders"
19582 If this option is set, the router is skipped unless the message's sender
19583 address matches something on the list.
19584 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19585 are evaluated.
19586
19587 There are issues concerning verification when the running of routers is
19588 dependent on the sender. When Exim is verifying the address in an &%errors_to%&
19589 setting, it sets the sender to the null string. When using the &%-bt%& option
19590 to check a configuration file, it is necessary also to use the &%-f%& option to
19591 set an appropriate sender. For incoming mail, the sender is unset when
19592 verifying the sender, but is available when verifying any recipients. If the
19593 SMTP VRFY command is enabled, it must be used after MAIL if the sender address
19594 matters.
19595
19596
19597 .option set routers "string list" unset
19598 .cindex router variables
19599 This option may be used multiple times on a router;
19600 because of this the list aspect is mostly irrelevant.
19601 The list separator is a semicolon but can be changed in the
19602 usual way.
19603
19604 Each list-element given must be of the form &"name = value"&
19605 and the names used must start with the string &"r_"&.
19606 Values containing a list-separator should have them doubled.
19607 When a router runs, the strings are evaluated in order,
19608 to create variables which are added to the set associated with
19609 the address.
19610 The variable is set with the expansion of the value.
19611 The variables can be used by the router options
19612 (not including any preconditions)
19613 and by the transport.
19614 Later definitions of a given named variable will override former ones.
19615 Variable use is via the usual &$r_...$& syntax.
19616
19617 This is similar to the &%address_data%& option, except that
19618 many independent variables can be used, with choice of naming.
19619
19620
19621 .option translate_ip_address routers string&!! unset
19622 .cindex "IP address" "translating"
19623 .cindex "packet radio"
19624 .cindex "router" "IP address translation"
19625 There exist some rare networking situations (for example, packet radio) where
19626 it is helpful to be able to translate IP addresses generated by normal routing
19627 mechanisms into other IP addresses, thus performing a kind of manual IP
19628 routing. This should be done only if the normal IP routing of the TCP/IP stack
19629 is inadequate or broken. Because this is an extremely uncommon requirement, the
19630 code to support this option is not included in the Exim binary unless
19631 SUPPORT_TRANSLATE_IP_ADDRESS=yes is set in &_Local/Makefile_&.
19632
19633 .vindex "&$host_address$&"
19634 The &%translate_ip_address%& string is expanded for every IP address generated
19635 by the router, with the generated address set in &$host_address$&. If the
19636 expansion is forced to fail, no action is taken.
19637 For any other expansion error, delivery of the message is deferred.
19638 If the result of the expansion is an IP address, that replaces the original
19639 address; otherwise the result is assumed to be a host name &-- this is looked
19640 up using &[gethostbyname()]& (or &[getipnodebyname()]& when available) to
19641 produce one or more replacement IP addresses. For example, to subvert all IP
19642 addresses in some specific networks, this could be added to a router:
19643 .code
19644 translate_ip_address = \
19645   ${lookup{${mask:$host_address/26}}lsearch{/some/file}\
19646     {$value}fail}}
19647 .endd
19648 The file would contain lines like
19649 .code
19650 10.2.3.128/26    some.host
19651 10.8.4.34/26     10.44.8.15
19652 .endd
19653 You should not make use of this facility unless you really understand what you
19654 are doing.
19655
19656
19657
19658 .option transport routers string&!! unset
19659 This option specifies the transport to be used when a router accepts an address
19660 and sets it up for delivery. A transport is never needed if a router is used
19661 only for verification. The value of the option is expanded at routing time,
19662 after the expansion of &%errors_to%&, &%headers_add%&, and &%headers_remove%&,
19663 and result must be the name of one of the configured transports. If it is not,
19664 delivery is deferred.
19665
19666 The &%transport%& option is not used by the &(redirect)& router, but it does
19667 have some private options that set up transports for pipe and file deliveries
19668 (see chapter &<<CHAPredirect>>&).
19669
19670
19671
19672 .option transport_current_directory routers string&!! unset
19673 .cindex "current directory for local transport"
19674 This option associates a current directory with any address that is routed
19675 to a local transport. This can happen either because a transport is
19676 explicitly configured for the router, or because it generates a delivery to a
19677 file or a pipe. During the delivery process (that is, at transport time), this
19678 option string is expanded and is set as the current directory, unless
19679 overridden by a setting on the transport.
19680 If the expansion fails for any reason, including forced failure, an error is
19681 logged, and delivery is deferred.
19682 See chapter &<<CHAPenvironment>>& for details of the local delivery
19683 environment.
19684
19685
19686
19687
19688 .option transport_home_directory routers string&!! "see below"
19689 .cindex "home directory" "for local transport"
19690 This option associates a home directory with any address that is routed to a
19691 local transport. This can happen either because a transport is explicitly
19692 configured for the router, or because it generates a delivery to a file or a
19693 pipe. During the delivery process (that is, at transport time), the option
19694 string is expanded and is set as the home directory, unless overridden by a
19695 setting of &%home_directory%& on the transport.
19696 If the expansion fails for any reason, including forced failure, an error is
19697 logged, and delivery is deferred.
19698
19699 If the transport does not specify a home directory, and
19700 &%transport_home_directory%& is not set for the router, the home directory for
19701 the transport is taken from the password data if &%check_local_user%& is set for
19702 the router. Otherwise it is taken from &%router_home_directory%& if that option
19703 is set; if not, no home directory is set for the transport.
19704
19705 See chapter &<<CHAPenvironment>>& for further details of the local delivery
19706 environment.
19707
19708
19709
19710
19711 .option unseen routers boolean&!! false
19712 .cindex "router" "carrying on after success"
19713 The result of string expansion for this option must be a valid boolean value,
19714 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
19715 result causes an error, and delivery is deferred. If the expansion is forced to
19716 fail, the default value for the option (false) is used. Other failures cause
19717 delivery to be deferred.
19718
19719 When this option is set true, routing does not cease if the router accepts the
19720 address. Instead, a copy of the incoming address is passed to the next router,
19721 overriding a false setting of &%more%&. There is little point in setting
19722 &%more%& false if &%unseen%& is always true, but it may be useful in cases when
19723 the value of &%unseen%& contains expansion items (and therefore, presumably, is
19724 sometimes true and sometimes false).
19725
19726 .cindex "copy of message (&%unseen%& option)"
19727 Setting the &%unseen%& option has a similar effect to the &%unseen%& command
19728 qualifier in filter files. It can be used to cause copies of messages to be
19729 delivered to some other destination, while also carrying out a normal delivery.
19730 In effect, the current address is made into a &"parent"& that has two children
19731 &-- one that is delivered as specified by this router, and a clone that goes on
19732 to be routed further. For this reason, &%unseen%& may not be combined with the
19733 &%one_time%& option in a &(redirect)& router.
19734
19735 &*Warning*&: Header lines added to the address (or specified for removal) by
19736 this router or by previous routers affect the &"unseen"& copy of the message
19737 only. The clone that continues to be processed by further routers starts with
19738 no added headers and none specified for removal. For a &%redirect%& router, if
19739 a generated address is the same as the incoming address, this can lead to
19740 duplicate addresses with different header modifications. Exim does not do
19741 duplicate deliveries (except, in certain circumstances, to pipes -- see section
19742 &<<SECTdupaddr>>&), but it is undefined which of the duplicates is discarded,
19743 so this ambiguous situation should be avoided. The &%repeat_use%& option of the
19744 &%redirect%& router may be of help.
19745
19746 Unlike the handling of header modifications, any data that was set by the
19747 &%address_data%& option in the current or previous routers &'is'& passed on to
19748 subsequent routers.
19749
19750
19751 .option user routers string&!! "see below"
19752 .cindex "uid (user id)" "local delivery"
19753 .cindex "local transports" "uid and gid"
19754 .cindex "transport" "local"
19755 .cindex "router" "user for filter processing"
19756 .cindex "filter" "user for processing"
19757 When a router queues an address for a transport, and the transport does not
19758 specify a user, the user given here is used when running the delivery process.
19759 The user may be specified numerically or by name. If expansion fails, the
19760 error is logged and delivery is deferred.
19761 This user is also used by the &(redirect)& router when running a filter file.
19762 The default is unset, except when &%check_local_user%& is set. In this case,
19763 the default is taken from the password information. If the user is specified as
19764 a name, and &%group%& is not set, the group associated with the user is used.
19765 See also &%initgroups%& and &%group%& and the discussion in chapter
19766 &<<CHAPenvironment>>&.
19767
19768
19769
19770 .option verify routers&!? boolean true
19771 Setting this option has the effect of setting &%verify_sender%& and
19772 &%verify_recipient%& to the same value.
19773
19774
19775 .option verify_only routers&!? boolean false
19776 .cindex "EXPN" "with &%verify_only%&"
19777 .oindex "&%-bv%&"
19778 .cindex "router" "used only when verifying"
19779 If this option is set, the router is used only when verifying an address,
19780 delivering in cutthrough mode or
19781 testing with the &%-bv%& option, not when actually doing a delivery, testing
19782 with the &%-bt%& option, or running the SMTP EXPN command. It can be further
19783 restricted to verifying only senders or recipients by means of
19784 &%verify_sender%& and &%verify_recipient%&.
19785
19786 &*Warning*&: When the router is being run to verify addresses for an incoming
19787 SMTP message, Exim is not running as root, but under its own uid. If the router
19788 accesses any files, you need to make sure that they are accessible to the Exim
19789 user or group.
19790
19791
19792 .option verify_recipient routers&!? boolean true
19793 If this option is false, the router is skipped when verifying recipient
19794 addresses,
19795 delivering in cutthrough mode
19796 or testing recipient verification using &%-bv%&.
19797 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19798 are evaluated.
19799 See also the &$verify_mode$& variable.
19800
19801
19802 .option verify_sender routers&!? boolean true
19803 If this option is false, the router is skipped when verifying sender addresses
19804 or testing sender verification using &%-bvs%&.
19805 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19806 are evaluated.
19807 See also the &$verify_mode$& variable.
19808 .ecindex IIDgenoprou1
19809 .ecindex IIDgenoprou2
19810
19811
19812
19813
19814
19815
19816 . ////////////////////////////////////////////////////////////////////////////
19817 . ////////////////////////////////////////////////////////////////////////////
19818
19819 .chapter "The accept router" "CHID4"
19820 .cindex "&(accept)& router"
19821 .cindex "routers" "&(accept)&"
19822 The &(accept)& router has no private options of its own. Unless it is being
19823 used purely for verification (see &%verify_only%&) a transport is required to
19824 be defined by the generic &%transport%& option. If the preconditions that are
19825 specified by generic options are met, the router accepts the address and queues
19826 it for the given transport. The most common use of this router is for setting
19827 up deliveries to local mailboxes. For example:
19828 .code
19829 localusers:
19830   driver = accept
19831   domains = mydomain.example
19832   check_local_user
19833   transport = local_delivery
19834 .endd
19835 The &%domains%& condition in this example checks the domain of the address, and
19836 &%check_local_user%& checks that the local part is the login of a local user.
19837 When both preconditions are met, the &(accept)& router runs, and queues the
19838 address for the &(local_delivery)& transport.
19839
19840
19841
19842
19843
19844
19845 . ////////////////////////////////////////////////////////////////////////////
19846 . ////////////////////////////////////////////////////////////////////////////
19847
19848 .chapter "The dnslookup router" "CHAPdnslookup"
19849 .scindex IIDdnsrou1 "&(dnslookup)& router"
19850 .scindex IIDdnsrou2 "routers" "&(dnslookup)&"
19851 The &(dnslookup)& router looks up the hosts that handle mail for the
19852 recipient's domain in the DNS. A transport must always be set for this router,
19853 unless &%verify_only%& is set.
19854
19855 If SRV support is configured (see &%check_srv%& below), Exim first searches for
19856 SRV records. If none are found, or if SRV support is not configured,
19857 MX records are looked up. If no MX records exist, address records are sought.
19858 However, &%mx_domains%& can be set to disable the direct use of address
19859 records.
19860
19861 MX records of equal priority are sorted by Exim into a random order. Exim then
19862 looks for address records for the host names obtained from MX or SRV records.
19863 When a host has more than one IP address, they are sorted into a random order,
19864 except that IPv6 addresses are sorted before IPv4 addresses. If all the
19865 IP addresses found are discarded by a setting of the &%ignore_target_hosts%&
19866 generic option, the router declines.
19867
19868 Unless they have the highest priority (lowest MX value), MX records that point
19869 to the local host, or to any host name that matches &%hosts_treat_as_local%&,
19870 are discarded, together with any other MX records of equal or lower priority.
19871
19872 .cindex "MX record" "pointing to local host"
19873 .cindex "local host" "MX pointing to"
19874 .oindex "&%self%&" "in &(dnslookup)& router"
19875 If the host pointed to by the highest priority MX record, or looked up as an
19876 address record, is the local host, or matches &%hosts_treat_as_local%&, what
19877 happens is controlled by the generic &%self%& option.
19878
19879
19880 .section "Problems with DNS lookups" "SECTprowitdnsloo"
19881 There have been problems with DNS servers when SRV records are looked up.
19882 Some misbehaving servers return a DNS error or timeout when a non-existent
19883 SRV record is sought. Similar problems have in the past been reported for
19884 MX records. The global &%dns_again_means_nonexist%& option can help with this
19885 problem, but it is heavy-handed because it is a global option.
19886
19887 For this reason, there are two options, &%srv_fail_domains%& and
19888 &%mx_fail_domains%&, that control what happens when a DNS lookup in a
19889 &(dnslookup)& router results in a DNS failure or a &"try again"& response. If
19890 an attempt to look up an SRV or MX record causes one of these results, and the
19891 domain matches the relevant list, Exim behaves as if the DNS had responded &"no
19892 such record"&. In the case of an SRV lookup, this means that the router
19893 proceeds to look for MX records; in the case of an MX lookup, it proceeds to
19894 look for A or AAAA records, unless the domain matches &%mx_domains%&, in which
19895 case routing fails.
19896
19897
19898 .section "Declining addresses by dnslookup" "SECTdnslookupdecline"
19899 .cindex "&(dnslookup)& router" "declines"
19900 There are a few cases where a &(dnslookup)& router will decline to accept
19901 an address; if such a router is expected to handle "all remaining non-local
19902 domains", then it is important to set &%no_more%&.
19903
19904 The router will defer rather than decline if the domain
19905 is found in the &%fail_defer_domains%& router option.
19906
19907 Reasons for a &(dnslookup)& router to decline currently include:
19908 .ilist
19909 The domain does not exist in DNS
19910 .next
19911 The domain exists but the MX record's host part is just "."; this is a common
19912 convention (borrowed from SRV) used to indicate that there is no such service
19913 for this domain and to not fall back to trying A/AAAA records.
19914 .next
19915 Ditto, but for SRV records, when &%check_srv%& is set on this router.
19916 .next
19917 MX record points to a non-existent host.
19918 .next
19919 MX record points to an IP address and the main section option
19920 &%allow_mx_to_ip%& is not set.
19921 .next
19922 MX records exist and point to valid hosts, but all hosts resolve only to
19923 addresses blocked by the &%ignore_target_hosts%& generic option on this router.
19924 .next
19925 The domain is not syntactically valid (see also &%allow_utf8_domains%& and
19926 &%dns_check_names_pattern%& for handling one variant of this)
19927 .next
19928 &%check_secondary_mx%& is set on this router but the local host can
19929 not be found in the MX records (see below)
19930 .endlist
19931
19932
19933
19934
19935 .section "Private options for dnslookup" "SECID118"
19936 .cindex "options" "&(dnslookup)& router"
19937 The private options for the &(dnslookup)& router are as follows:
19938
19939 .option check_secondary_mx dnslookup boolean false
19940 .cindex "MX record" "checking for secondary"
19941 If this option is set, the router declines unless the local host is found in
19942 (and removed from) the list of hosts obtained by MX lookup. This can be used to
19943 process domains for which the local host is a secondary mail exchanger
19944 differently to other domains. The way in which Exim decides whether a host is
19945 the local host is described in section &<<SECTreclocipadd>>&.
19946
19947
19948 .option check_srv dnslookup string&!! unset
19949 .cindex "SRV record" "enabling use of"
19950 The &(dnslookup)& router supports the use of SRV records (see RFC 2782) in
19951 addition to MX and address records. The support is disabled by default. To
19952 enable SRV support, set the &%check_srv%& option to the name of the service
19953 required. For example,
19954 .code
19955 check_srv = smtp
19956 .endd
19957 looks for SRV records that refer to the normal smtp service. The option is
19958 expanded, so the service name can vary from message to message or address
19959 to address. This might be helpful if SRV records are being used for a
19960 submission service. If the expansion is forced to fail, the &%check_srv%&
19961 option is ignored, and the router proceeds to look for MX records in the
19962 normal way.
19963
19964 When the expansion succeeds, the router searches first for SRV records for
19965 the given service (it assumes TCP protocol). A single SRV record with a
19966 host name that consists of just a single dot indicates &"no such service for
19967 this domain"&; if this is encountered, the router declines. If other kinds of
19968 SRV record are found, they are used to construct a host list for delivery
19969 according to the rules of RFC 2782. MX records are not sought in this case.
19970
19971 When no SRV records are found, MX records (and address records) are sought in
19972 the traditional way. In other words, SRV records take precedence over MX
19973 records, just as MX records take precedence over address records. Note that
19974 this behaviour is not sanctioned by RFC 2782, though a previous draft RFC
19975 defined it. It is apparently believed that MX records are sufficient for email
19976 and that SRV records should not be used for this purpose. However, SRV records
19977 have an additional &"weight"& feature which some people might find useful when
19978 trying to split an SMTP load between hosts of different power.
19979
19980 See section &<<SECTprowitdnsloo>>& above for a discussion of Exim's behaviour
19981 when there is a DNS lookup error.
19982
19983
19984
19985
19986 .option fail_defer_domains dnslookup "domain list&!!" unset
19987 .cindex "MX record" "not found"
19988 DNS lookups for domains matching &%fail_defer_domains%&
19989 which find no matching record will cause the router to defer
19990 rather than the default behaviour of decline.
19991 This maybe be useful for queueing messages for a newly created
19992 domain while the DNS configuration is not ready.
19993 However, it will result in any message with mistyped domains
19994 also being queued.
19995
19996
19997 .option ipv4_only "string&!!" unset
19998 .cindex IPv6 disabling
19999 .cindex DNS "IPv6 disabling"
20000 The string is expanded, and if the result is anything but a forced failure,
20001 or an empty string, or one of the strings “0” or “no” or “false”
20002 (checked without regard to the case of the letters),
20003 only A records are used.
20004
20005 .option ipv4_prefer "string&!!" unset
20006 .cindex IPv4 preference
20007 .cindex DNS "IPv4 preference"
20008 The string is expanded, and if the result is anything but a forced failure,
20009 or an empty string, or one of the strings “0” or “no” or “false”
20010 (checked without regard to the case of the letters),
20011 A records are sorted before AAAA records (inverting the default).
20012
20013 .option mx_domains dnslookup "domain list&!!" unset
20014 .cindex "MX record" "required to exist"
20015 .cindex "SRV record" "required to exist"
20016 A domain that matches &%mx_domains%& is required to have either an MX or an SRV
20017 record in order to be recognized. (The name of this option could be improved.)
20018 For example, if all the mail hosts in &'fict.example'& are known to have MX
20019 records, except for those in &'discworld.fict.example'&, you could use this
20020 setting:
20021 .code
20022 mx_domains = ! *.discworld.fict.example : *.fict.example
20023 .endd
20024 This specifies that messages addressed to a domain that matches the list but
20025 has no MX record should be bounced immediately instead of being routed using
20026 the address record.
20027
20028
20029 .option mx_fail_domains dnslookup "domain list&!!" unset
20030 If the DNS lookup for MX records for one of the domains in this list causes a
20031 DNS lookup error, Exim behaves as if no MX records were found. See section
20032 &<<SECTprowitdnsloo>>& for more discussion.
20033
20034
20035
20036
20037 .option qualify_single dnslookup boolean true
20038 .cindex "DNS" "resolver options"
20039 .cindex "DNS" "qualifying single-component names"
20040 When this option is true, the resolver option RES_DEFNAMES is set for DNS
20041 lookups. Typically, but not standardly, this causes the resolver to qualify
20042 single-component names with the default domain. For example, on a machine
20043 called &'dictionary.ref.example'&, the domain &'thesaurus'& would be changed to
20044 &'thesaurus.ref.example'& inside the resolver. For details of what your
20045 resolver actually does, consult your man pages for &'resolver'& and
20046 &'resolv.conf'&.
20047
20048
20049
20050 .option rewrite_headers dnslookup boolean true
20051 .cindex "rewriting" "header lines"
20052 .cindex "header lines" "rewriting"
20053 If the domain name in the address that is being processed is not fully
20054 qualified, it may be expanded to its full form by a DNS lookup. For example, if
20055 an address is specified as &'dormouse@teaparty'&, the domain might be
20056 expanded to &'teaparty.wonderland.fict.example'&. Domain expansion can also
20057 occur as a result of setting the &%widen_domains%& option. If
20058 &%rewrite_headers%& is true, all occurrences of the abbreviated domain name in
20059 any &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-to:'&, &'Sender:'&, and &'To:'&
20060 header lines of the message are rewritten with the full domain name.
20061
20062 This option should be turned off only when it is known that no message is
20063 ever going to be sent outside an environment where the abbreviation makes
20064 sense.
20065
20066 When an MX record is looked up in the DNS and matches a wildcard record, name
20067 servers normally return a record containing the name that has been looked up,
20068 making it impossible to detect whether a wildcard was present or not. However,
20069 some name servers have recently been seen to return the wildcard entry. If the
20070 name returned by a DNS lookup begins with an asterisk, it is not used for
20071 header rewriting.
20072
20073
20074 .option same_domain_copy_routing dnslookup boolean false
20075 .cindex "address" "copying routing"
20076 Addresses with the same domain are normally routed by the &(dnslookup)& router
20077 to the same list of hosts. However, this cannot be presumed, because the router
20078 options and preconditions may refer to the local part of the address. By
20079 default, therefore, Exim routes each address in a message independently. DNS
20080 servers run caches, so repeated DNS lookups are not normally expensive, and in
20081 any case, personal messages rarely have more than a few recipients.
20082
20083 If you are running mailing lists with large numbers of subscribers at the same
20084 domain, and you are using a &(dnslookup)& router which is independent of the
20085 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
20086 lookups for identical domains in one message. In this case, when &(dnslookup)&
20087 routes an address to a remote transport, any other unrouted addresses in the
20088 message that have the same domain are automatically given the same routing
20089 without processing them independently,
20090 provided the following conditions are met:
20091
20092 .ilist
20093 No router that processed the address specified &%headers_add%& or
20094 &%headers_remove%&.
20095 .next
20096 The router did not change the address in any way, for example, by &"widening"&
20097 the domain.
20098 .endlist
20099
20100
20101
20102
20103 .option search_parents dnslookup boolean false
20104 .cindex "DNS" "resolver options"
20105 When this option is true, the resolver option RES_DNSRCH is set for DNS
20106 lookups. This is different from the &%qualify_single%& option in that it
20107 applies to domains containing dots. Typically, but not standardly, it causes
20108 the resolver to search for the name in the current domain and in parent
20109 domains. For example, on a machine in the &'fict.example'& domain, if looking
20110 up &'teaparty.wonderland'& failed, the resolver would try
20111 &'teaparty.wonderland.fict.example'&. For details of what your resolver
20112 actually does, consult your man pages for &'resolver'& and &'resolv.conf'&.
20113
20114 Setting this option true can cause problems in domains that have a wildcard MX
20115 record, because any domain that does not have its own MX record matches the
20116 local wildcard.
20117
20118
20119
20120 .option srv_fail_domains dnslookup "domain list&!!" unset
20121 If the DNS lookup for SRV records for one of the domains in this list causes a
20122 DNS lookup error, Exim behaves as if no SRV records were found. See section
20123 &<<SECTprowitdnsloo>>& for more discussion.
20124
20125
20126
20127
20128 .option widen_domains dnslookup "string list" unset
20129 .cindex "domain" "partial; widening"
20130 If a DNS lookup fails and this option is set, each of its strings in turn is
20131 added onto the end of the domain, and the lookup is tried again. For example,
20132 if
20133 .code
20134 widen_domains = fict.example:ref.example
20135 .endd
20136 is set and a lookup of &'klingon.dictionary'& fails,
20137 &'klingon.dictionary.fict.example'& is looked up, and if this fails,
20138 &'klingon.dictionary.ref.example'& is tried. Note that the &%qualify_single%&
20139 and &%search_parents%& options can cause some widening to be undertaken inside
20140 the DNS resolver. &%widen_domains%& is not applied to sender addresses
20141 when verifying, unless &%rewrite_headers%& is false (not the default).
20142
20143
20144 .section "Effect of qualify_single and search_parents" "SECID119"
20145 When a domain from an envelope recipient is changed by the resolver as a result
20146 of the &%qualify_single%& or &%search_parents%& options, Exim rewrites the
20147 corresponding address in the message's header lines unless &%rewrite_headers%&
20148 is set false. Exim then re-routes the address, using the full domain.
20149
20150 These two options affect only the DNS lookup that takes place inside the router
20151 for the domain of the address that is being routed. They do not affect lookups
20152 such as that implied by
20153 .code
20154 domains = @mx_any
20155 .endd
20156 that may happen while processing a router precondition before the router is
20157 entered. No widening ever takes place for these lookups.
20158 .ecindex IIDdnsrou1
20159 .ecindex IIDdnsrou2
20160
20161
20162
20163
20164
20165
20166
20167
20168
20169 . ////////////////////////////////////////////////////////////////////////////
20170 . ////////////////////////////////////////////////////////////////////////////
20171
20172 .chapter "The ipliteral router" "CHID5"
20173 .cindex "&(ipliteral)& router"
20174 .cindex "domain literal" "routing"
20175 .cindex "routers" "&(ipliteral)&"
20176 This router has no private options. Unless it is being used purely for
20177 verification (see &%verify_only%&) a transport is required to be defined by the
20178 generic &%transport%& option. The router accepts the address if its domain part
20179 takes the form of an RFC 2822 domain literal. For example, the &(ipliteral)&
20180 router handles the address
20181 .code
20182 root@[192.168.1.1]
20183 .endd
20184 by setting up delivery to the host with that IP address. IPv4 domain literals
20185 consist of an IPv4 address enclosed in square brackets. IPv6 domain literals
20186 are similar, but the address is preceded by &`ipv6:`&. For example:
20187 .code
20188 postmaster@[ipv6:fe80::a00:20ff:fe86:a061.5678]
20189 .endd
20190 Exim allows &`ipv4:`& before IPv4 addresses, for consistency, and on the
20191 grounds that sooner or later somebody will try it.
20192
20193 .oindex "&%self%&" "in &(ipliteral)& router"
20194 If the IP address matches something in &%ignore_target_hosts%&, the router
20195 declines. If an IP literal turns out to refer to the local host, the generic
20196 &%self%& option determines what happens.
20197
20198 The RFCs require support for domain literals; however, their use is
20199 controversial in today's Internet. If you want to use this router, you must
20200 also set the main configuration option &%allow_domain_literals%&. Otherwise,
20201 Exim will not recognize the domain literal syntax in addresses.
20202
20203
20204
20205 . ////////////////////////////////////////////////////////////////////////////
20206 . ////////////////////////////////////////////////////////////////////////////
20207
20208 .chapter "The iplookup router" "CHID6"
20209 .cindex "&(iplookup)& router"
20210 .cindex "routers" "&(iplookup)&"
20211 The &(iplookup)& router was written to fulfil a specific requirement in
20212 Cambridge University (which in fact no longer exists). For this reason, it is
20213 not included in the binary of Exim by default. If you want to include it, you
20214 must set
20215 .code
20216 ROUTER_IPLOOKUP=yes
20217 .endd
20218 in your &_Local/Makefile_& configuration file.
20219
20220 The &(iplookup)& router routes an address by sending it over a TCP or UDP
20221 connection to one or more specific hosts. The host can then return the same or
20222 a different address &-- in effect rewriting the recipient address in the
20223 message's envelope. The new address is then passed on to subsequent routers. If
20224 this process fails, the address can be passed on to other routers, or delivery
20225 can be deferred. Since &(iplookup)& is just a rewriting router, a transport
20226 must not be specified for it.
20227
20228 .cindex "options" "&(iplookup)& router"
20229 .option hosts iplookup string unset
20230 This option must be supplied. Its value is a colon-separated list of host
20231 names. The hosts are looked up using &[gethostbyname()]&
20232 (or &[getipnodebyname()]& when available)
20233 and are tried in order until one responds to the query. If none respond, what
20234 happens is controlled by &%optional%&.
20235
20236
20237 .option optional iplookup boolean false
20238 If &%optional%& is true, if no response is obtained from any host, the address
20239 is passed to the next router, overriding &%no_more%&. If &%optional%& is false,
20240 delivery to the address is deferred.
20241
20242
20243 .option port iplookup integer 0
20244 .cindex "port" "&(iplookup)& router"
20245 This option must be supplied. It specifies the port number for the TCP or UDP
20246 call.
20247
20248
20249 .option protocol iplookup string udp
20250 This option can be set to &"udp"& or &"tcp"& to specify which of the two
20251 protocols is to be used.
20252
20253
20254 .option query iplookup string&!! "see below"
20255 This defines the content of the query that is sent to the remote hosts. The
20256 default value is:
20257 .code
20258 $local_part@$domain $local_part@$domain
20259 .endd
20260 The repetition serves as a way of checking that a response is to the correct
20261 query in the default case (see &%response_pattern%& below).
20262
20263
20264 .option reroute iplookup string&!! unset
20265 If this option is not set, the rerouted address is precisely the byte string
20266 returned by the remote host, up to the first white space, if any. If set, the
20267 string is expanded to form the rerouted address. It can include parts matched
20268 in the response by &%response_pattern%& by means of numeric variables such as
20269 &$1$&, &$2$&, etc. The variable &$0$& refers to the entire input string,
20270 whether or not a pattern is in use. In all cases, the rerouted address must end
20271 up in the form &'local_part@domain'&.
20272
20273
20274 .option response_pattern iplookup string unset
20275 This option can be set to a regular expression that is applied to the string
20276 returned from the remote host. If the pattern does not match the response, the
20277 router declines. If &%response_pattern%& is not set, no checking of the
20278 response is done, unless the query was defaulted, in which case there is a
20279 check that the text returned after the first white space is the original
20280 address. This checks that the answer that has been received is in response to
20281 the correct question. For example, if the response is just a new domain, the
20282 following could be used:
20283 .code
20284 response_pattern = ^([^@]+)$
20285 reroute = $local_part@$1
20286 .endd
20287
20288 .option timeout iplookup time 5s
20289 This specifies the amount of time to wait for a response from the remote
20290 machine. The same timeout is used for the &[connect()]& function for a TCP
20291 call. It does not apply to UDP.
20292
20293
20294
20295
20296 . ////////////////////////////////////////////////////////////////////////////
20297 . ////////////////////////////////////////////////////////////////////////////
20298
20299 .chapter "The manualroute router" "CHID7"
20300 .scindex IIDmanrou1 "&(manualroute)& router"
20301 .scindex IIDmanrou2 "routers" "&(manualroute)&"
20302 .cindex "domain" "manually routing"
20303 The &(manualroute)& router is so-called because it provides a way of manually
20304 routing an address according to its domain. It is mainly used when you want to
20305 route addresses to remote hosts according to your own rules, bypassing the
20306 normal DNS routing that looks up MX records. However, &(manualroute)& can also
20307 route to local transports, a facility that may be useful if you want to save
20308 messages for dial-in hosts in local files.
20309
20310 The &(manualroute)& router compares a list of domain patterns with the domain
20311 it is trying to route. If there is no match, the router declines. Each pattern
20312 has associated with it a list of hosts and some other optional data, which may
20313 include a transport. The combination of a pattern and its data is called a
20314 &"routing rule"&. For patterns that do not have an associated transport, the
20315 generic &%transport%& option must specify a transport, unless the router is
20316 being used purely for verification (see &%verify_only%&).
20317
20318 .vindex "&$host$&"
20319 In the case of verification, matching the domain pattern is sufficient for the
20320 router to accept the address. When actually routing an address for delivery,
20321 an address that matches a domain pattern is queued for the associated
20322 transport. If the transport is not a local one, a host list must be associated
20323 with the pattern; IP addresses are looked up for the hosts, and these are
20324 passed to the transport along with the mail address. For local transports, a
20325 host list is optional. If it is present, it is passed in &$host$& as a single
20326 text string.
20327
20328 The list of routing rules can be provided as an inline string in
20329 &%route_list%&, or the data can be obtained by looking up the domain in a file
20330 or database by setting &%route_data%&. Only one of these settings may appear in
20331 any one instance of &(manualroute)&. The format of routing rules is described
20332 below, following the list of private options.
20333
20334
20335 .section "Private options for manualroute" "SECTprioptman"
20336
20337 .cindex "options" "&(manualroute)& router"
20338 The private options for the &(manualroute)& router are as follows:
20339
20340 .option host_all_ignored manualroute string defer
20341 See &%host_find_failed%&.
20342
20343 .option host_find_failed manualroute string freeze
20344 This option controls what happens when &(manualroute)& tries to find an IP
20345 address for a host, and the host does not exist. The option can be set to one
20346 of the following values:
20347 .code
20348 decline
20349 defer
20350 fail
20351 freeze
20352 ignore
20353 pass
20354 .endd
20355 The default (&"freeze"&) assumes that this state is a serious configuration
20356 error. The difference between &"pass"& and &"decline"& is that the former
20357 forces the address to be passed to the next router (or the router defined by
20358 &%pass_router%&),
20359 .oindex "&%more%&"
20360 overriding &%no_more%&, whereas the latter passes the address to the next
20361 router only if &%more%& is true.
20362
20363 The value &"ignore"& causes Exim to completely ignore a host whose IP address
20364 cannot be found. If all the hosts in the list are ignored, the behaviour is
20365 controlled by the &%host_all_ignored%& option. This takes the same values
20366 as &%host_find_failed%&, except that it cannot be set to &"ignore"&.
20367
20368 The &%host_find_failed%& option applies only to a definite &"does not exist"&
20369 state; if a host lookup gets a temporary error, delivery is deferred unless the
20370 generic &%pass_on_timeout%& option is set.
20371
20372
20373 .option hosts_randomize manualroute boolean false
20374 .cindex "randomized host list"
20375 .cindex "host" "list of; randomized"
20376 If this option is set, the order of the items in a host list in a routing rule
20377 is randomized each time the list is used, unless an option in the routing rule
20378 overrides (see below). Randomizing the order of a host list can be used to do
20379 crude load sharing. However, if more than one mail address is routed by the
20380 same router to the same host list, the host lists are considered to be the same
20381 (even though they may be randomized into different orders) for the purpose of
20382 deciding whether to batch the deliveries into a single SMTP transaction.
20383
20384 When &%hosts_randomize%& is true, a host list may be split
20385 into groups whose order is separately randomized. This makes it possible to
20386 set up MX-like behaviour. The boundaries between groups are indicated by an
20387 item that is just &`+`& in the host list. For example:
20388 .code
20389 route_list = * host1:host2:host3:+:host4:host5
20390 .endd
20391 The order of the first three hosts and the order of the last two hosts is
20392 randomized for each use, but the first three always end up before the last two.
20393 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored. If a
20394 randomized host list is passed to an &(smtp)& transport that also has
20395 &%hosts_randomize set%&, the list is not re-randomized.
20396
20397
20398 .option route_data manualroute string&!! unset
20399 If this option is set, it must expand to yield the data part of a routing rule.
20400 Typically, the expansion string includes a lookup based on the domain. For
20401 example:
20402 .code
20403 route_data = ${lookup{$domain}dbm{/etc/routes}}
20404 .endd
20405 If the expansion is forced to fail, or the result is an empty string, the
20406 router declines. Other kinds of expansion failure cause delivery to be
20407 deferred.
20408
20409
20410 .option route_list manualroute "string list" unset
20411 This string is a list of routing rules, in the form defined below. Note that,
20412 unlike most string lists, the items are separated by semicolons. This is so
20413 that they may contain colon-separated host lists.
20414
20415
20416 .option same_domain_copy_routing manualroute boolean false
20417 .cindex "address" "copying routing"
20418 Addresses with the same domain are normally routed by the &(manualroute)&
20419 router to the same list of hosts. However, this cannot be presumed, because the
20420 router options and preconditions may refer to the local part of the address. By
20421 default, therefore, Exim routes each address in a message independently. DNS
20422 servers run caches, so repeated DNS lookups are not normally expensive, and in
20423 any case, personal messages rarely have more than a few recipients.
20424
20425 If you are running mailing lists with large numbers of subscribers at the same
20426 domain, and you are using a &(manualroute)& router which is independent of the
20427 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
20428 lookups for identical domains in one message. In this case, when
20429 &(manualroute)& routes an address to a remote transport, any other unrouted
20430 addresses in the message that have the same domain are automatically given the
20431 same routing without processing them independently. However, this is only done
20432 if &%headers_add%& and &%headers_remove%& are unset.
20433
20434
20435
20436
20437 .section "Routing rules in route_list" "SECID120"
20438 The value of &%route_list%& is a string consisting of a sequence of routing
20439 rules, separated by semicolons. If a semicolon is needed in a rule, it can be
20440 entered as two semicolons. Alternatively, the list separator can be changed as
20441 described (for colon-separated lists) in section &<<SECTlistconstruct>>&.
20442 Empty rules are ignored. The format of each rule is
20443 .display
20444 <&'domain pattern'&>  <&'list of hosts'&>  <&'options'&>
20445 .endd
20446 The following example contains two rules, each with a simple domain pattern and
20447 no options:
20448 .code
20449 route_list = \
20450   dict.ref.example  mail-1.ref.example:mail-2.ref.example ; \
20451   thes.ref.example  mail-3.ref.example:mail-4.ref.example
20452 .endd
20453 The three parts of a rule are separated by white space. The pattern and the
20454 list of hosts can be enclosed in quotes if necessary, and if they are, the
20455 usual quoting rules apply. Each rule in a &%route_list%& must start with a
20456 single domain pattern, which is the only mandatory item in the rule. The
20457 pattern is in the same format as one item in a domain list (see section
20458 &<<SECTdomainlist>>&),
20459 except that it may not be the name of an interpolated file.
20460 That is, it may be wildcarded, or a regular expression, or a file or database
20461 lookup (with semicolons doubled, because of the use of semicolon as a separator
20462 in a &%route_list%&).
20463
20464 The rules in &%route_list%& are searched in order until one of the patterns
20465 matches the domain that is being routed. The list of hosts and then options are
20466 then used as described below. If there is no match, the router declines. When
20467 &%route_list%& is set, &%route_data%& must not be set.
20468
20469
20470
20471 .section "Routing rules in route_data" "SECID121"
20472 The use of &%route_list%& is convenient when there are only a small number of
20473 routing rules. For larger numbers, it is easier to use a file or database to
20474 hold the routing information, and use the &%route_data%& option instead.
20475 The value of &%route_data%& is a list of hosts, followed by (optional) options.
20476 Most commonly, &%route_data%& is set as a string that contains an
20477 expansion lookup. For example, suppose we place two routing rules in a file
20478 like this:
20479 .code
20480 dict.ref.example:  mail-1.ref.example:mail-2.ref.example
20481 thes.ref.example:  mail-3.ref.example:mail-4.ref.example
20482 .endd
20483 This data can be accessed by setting
20484 .code
20485 route_data = ${lookup{$domain}lsearch{/the/file/name}}
20486 .endd
20487 Failure of the lookup results in an empty string, causing the router to
20488 decline. However, you do not have to use a lookup in &%route_data%&. The only
20489 requirement is that the result of expanding the string is a list of hosts,
20490 possibly followed by options, separated by white space. The list of hosts must
20491 be enclosed in quotes if it contains white space.
20492
20493
20494
20495
20496 .section "Format of the list of hosts" "SECID122"
20497 A list of hosts, whether obtained via &%route_data%& or &%route_list%&, is
20498 always separately expanded before use. If the expansion fails, the router
20499 declines. The result of the expansion must be a colon-separated list of names
20500 and/or IP addresses, optionally also including ports.
20501 If the list is written with spaces, it must be protected with quotes.
20502 The format of each item
20503 in the list is described in the next section. The list separator can be changed
20504 as described in section &<<SECTlistsepchange>>&.
20505
20506 If the list of hosts was obtained from a &%route_list%& item, the following
20507 variables are set during its expansion:
20508
20509 .ilist
20510 .cindex "numerical variables (&$1$& &$2$&  etc)" "in &(manualroute)& router"
20511 If the domain was matched against a regular expression, the numeric variables
20512 &$1$&, &$2$&, etc. may be set. For example:
20513 .code
20514 route_list = ^domain(\d+)   host-$1.text.example
20515 .endd
20516 .next
20517 &$0$& is always set to the entire domain.
20518 .next
20519 &$1$& is also set when partial matching is done in a file lookup.
20520
20521 .next
20522 .vindex "&$value$&"
20523 If the pattern that matched the domain was a lookup item, the data that was
20524 looked up is available in the expansion variable &$value$&. For example:
20525 .code
20526 route_list = lsearch;;/some/file.routes  $value
20527 .endd
20528 .endlist
20529
20530 Note the doubling of the semicolon in the pattern that is necessary because
20531 semicolon is the default route list separator.
20532
20533
20534
20535 .section "Format of one host item" "SECTformatonehostitem"
20536 Each item in the list of hosts can be either a host name or an IP address,
20537 optionally with an attached port number, or it can be a single "+"
20538 (see &%hosts_randomize%&).
20539 When no port is given, an IP address
20540 is not enclosed in brackets. When a port is specified, it overrides the port
20541 specification on the transport. The port is separated from the name or address
20542 by a colon. This leads to some complications:
20543
20544 .ilist
20545 Because colon is the default separator for the list of hosts, either
20546 the colon that specifies a port must be doubled, or the list separator must
20547 be changed. The following two examples have the same effect:
20548 .code
20549 route_list = * "host1.tld::1225 : host2.tld::1226"
20550 route_list = * "<+ host1.tld:1225 + host2.tld:1226"
20551 .endd
20552 .next
20553 When IPv6 addresses are involved, it gets worse, because they contain
20554 colons of their own. To make this case easier, it is permitted to
20555 enclose an IP address (either v4 or v6) in square brackets if a port
20556 number follows. For example:
20557 .code
20558 route_list = * "</ [10.1.1.1]:1225 / [::1]:1226"
20559 .endd
20560 .endlist
20561
20562 .section "How the list of hosts is used" "SECThostshowused"
20563 When an address is routed to an &(smtp)& transport by &(manualroute)&, each of
20564 the hosts is tried, in the order specified, when carrying out the SMTP
20565 delivery. However, the order can be changed by setting the &%hosts_randomize%&
20566 option, either on the router (see section &<<SECTprioptman>>& above), or on the
20567 transport.
20568
20569 Hosts may be listed by name or by IP address. An unadorned name in the list of
20570 hosts is interpreted as a host name. A name that is followed by &`/MX`& is
20571 interpreted as an indirection to a sublist of hosts obtained by looking up MX
20572 records in the DNS. For example:
20573 .code
20574 route_list = *  x.y.z:p.q.r/MX:e.f.g
20575 .endd
20576 If this feature is used with a port specifier, the port must come last. For
20577 example:
20578 .code
20579 route_list = *  dom1.tld/mx::1225
20580 .endd
20581 If the &%hosts_randomize%& option is set, the order of the items in the list is
20582 randomized before any lookups are done. Exim then scans the list; for any name
20583 that is not followed by &`/MX`& it looks up an IP address. If this turns out to
20584 be an interface on the local host and the item is not the first in the list,
20585 Exim discards it and any subsequent items. If it is the first item, what
20586 happens is controlled by the
20587 .oindex "&%self%&" "in &(manualroute)& router"
20588 &%self%& option of the router.
20589
20590 A name on the list that is followed by &`/MX`& is replaced with the list of
20591 hosts obtained by looking up MX records for the name. This is always a DNS
20592 lookup; the &%bydns%& and &%byname%& options (see section &<<SECThowoptused>>&
20593 below) are not relevant here. The order of these hosts is determined by the
20594 preference values in the MX records, according to the usual rules. Because
20595 randomizing happens before the MX lookup, it does not affect the order that is
20596 defined by MX preferences.
20597
20598 If the local host is present in the sublist obtained from MX records, but is
20599 not the most preferred host in that list, it and any equally or less
20600 preferred hosts are removed before the sublist is inserted into the main list.
20601
20602 If the local host is the most preferred host in the MX list, what happens
20603 depends on where in the original list of hosts the &`/MX`& item appears. If it
20604 is not the first item (that is, there are previous hosts in the main list),
20605 Exim discards this name and any subsequent items in the main list.
20606
20607 If the MX item is first in the list of hosts, and the local host is the
20608 most preferred host, what happens is controlled by the &%self%& option of the
20609 router.
20610
20611 DNS failures when lookup up the MX records are treated in the same way as DNS
20612 failures when looking up IP addresses: &%pass_on_timeout%& and
20613 &%host_find_failed%& are used when relevant.
20614
20615 The generic &%ignore_target_hosts%& option applies to all hosts in the list,
20616 whether obtained from an MX lookup or not.
20617
20618
20619
20620 .section "How the options are used" "SECThowoptused"
20621 The options are a sequence of words, space-separated.
20622 One of the words can be the name of a transport; this overrides the
20623 &%transport%& option on the router for this particular routing rule only. The
20624 other words (if present) control randomization of the list of hosts on a
20625 per-rule basis, and how the IP addresses of the hosts are to be found when
20626 routing to a remote transport. These options are as follows:
20627
20628 .ilist
20629 &%randomize%&: randomize the order of the hosts in this list, overriding the
20630 setting of &%hosts_randomize%& for this routing rule only.
20631 .next
20632 &%no_randomize%&: do not randomize the order of the hosts in this list,
20633 overriding the setting of &%hosts_randomize%& for this routing rule only.
20634 .next
20635 &%byname%&: use &[getipnodebyname()]& (&[gethostbyname()]& on older systems) to
20636 find IP addresses. This function may ultimately cause a DNS lookup, but it may
20637 also look in &_/etc/hosts_& or other sources of information.
20638 .next
20639 &%bydns%&: look up address records for the hosts directly in the DNS; fail if
20640 no address records are found. If there is a temporary DNS error (such as a
20641 timeout), delivery is deferred.
20642 .next
20643 &%ipv4_only%&: in direct DNS lookups, look up only A records.
20644 .next
20645 &%ipv4_prefer%&: in direct DNS lookups, sort A records before AAAA records.
20646 .endlist
20647
20648 For example:
20649 .code
20650 route_list = domain1  host1:host2:host3  randomize bydns;\
20651              domain2  host4:host5
20652 .endd
20653 If neither &%byname%& nor &%bydns%& is given, Exim behaves as follows: First, a
20654 DNS lookup is done. If this yields anything other than HOST_NOT_FOUND, that
20655 result is used. Otherwise, Exim goes on to try a call to &[getipnodebyname()]&
20656 or &[gethostbyname()]&, and the result of the lookup is the result of that
20657 call.
20658
20659 &*Warning*&: It has been discovered that on some systems, if a DNS lookup
20660 called via &[getipnodebyname()]& times out, HOST_NOT_FOUND is returned
20661 instead of TRY_AGAIN. That is why the default action is to try a DNS
20662 lookup first. Only if that gives a definite &"no such host"& is the local
20663 function called.
20664
20665 &*Compatibility*&: From Exim 4.85 until fixed for 4.90, there was an
20666 inadvertent constraint that a transport name as an option had to be the last
20667 option specified.
20668
20669
20670
20671 If no IP address for a host can be found, what happens is controlled by the
20672 &%host_find_failed%& option.
20673
20674 .vindex "&$host$&"
20675 When an address is routed to a local transport, IP addresses are not looked up.
20676 The host list is passed to the transport in the &$host$& variable.
20677
20678
20679
20680 .section "Manualroute examples" "SECID123"
20681 In some of the examples that follow, the presence of the &%remote_smtp%&
20682 transport, as defined in the default configuration file, is assumed:
20683
20684 .ilist
20685 .cindex "smart host" "example router"
20686 The &(manualroute)& router can be used to forward all external mail to a
20687 &'smart host'&. If you have set up, in the main part of the configuration, a
20688 named domain list that contains your local domains, for example:
20689 .code
20690 domainlist local_domains = my.domain.example
20691 .endd
20692 You can arrange for all other domains to be routed to a smart host by making
20693 your first router something like this:
20694 .code
20695 smart_route:
20696   driver = manualroute
20697   domains = !+local_domains
20698   transport = remote_smtp
20699   route_list = * smarthost.ref.example
20700 .endd
20701 This causes all non-local addresses to be sent to the single host
20702 &'smarthost.ref.example'&. If a colon-separated list of smart hosts is given,
20703 they are tried in order
20704 (but you can use &%hosts_randomize%& to vary the order each time).
20705 Another way of configuring the same thing is this:
20706 .code
20707 smart_route:
20708   driver = manualroute
20709   transport = remote_smtp
20710   route_list = !+local_domains  smarthost.ref.example
20711 .endd
20712 There is no difference in behaviour between these two routers as they stand.
20713 However, they behave differently if &%no_more%& is added to them. In the first
20714 example, the router is skipped if the domain does not match the &%domains%&
20715 precondition; the following router is always tried. If the router runs, it
20716 always matches the domain and so can never decline. Therefore, &%no_more%&
20717 would have no effect. In the second case, the router is never skipped; it
20718 always runs. However, if it doesn't match the domain, it declines. In this case
20719 &%no_more%& would prevent subsequent routers from running.
20720
20721 .next
20722 .cindex "mail hub example"
20723 A &'mail hub'& is a host which receives mail for a number of domains via MX
20724 records in the DNS and delivers it via its own private routing mechanism. Often
20725 the final destinations are behind a firewall, with the mail hub being the one
20726 machine that can connect to machines both inside and outside the firewall. The
20727 &(manualroute)& router is usually used on a mail hub to route incoming messages
20728 to the correct hosts. For a small number of domains, the routing can be inline,
20729 using the &%route_list%& option, but for a larger number a file or database
20730 lookup is easier to manage.
20731
20732 If the domain names are in fact the names of the machines to which the mail is
20733 to be sent by the mail hub, the configuration can be quite simple. For
20734 example:
20735 .code
20736 hub_route:
20737   driver = manualroute
20738   transport = remote_smtp
20739   route_list = *.rhodes.tvs.example  $domain
20740 .endd
20741 This configuration routes domains that match &`*.rhodes.tvs.example`& to hosts
20742 whose names are the same as the mail domains. A similar approach can be taken
20743 if the host name can be obtained from the domain name by a string manipulation
20744 that the expansion facilities can handle. Otherwise, a lookup based on the
20745 domain can be used to find the host:
20746 .code
20747 through_firewall:
20748   driver = manualroute
20749   transport = remote_smtp
20750   route_data = ${lookup {$domain} cdb {/internal/host/routes}}
20751 .endd
20752 The result of the lookup must be the name or IP address of the host (or
20753 hosts) to which the address is to be routed. If the lookup fails, the route
20754 data is empty, causing the router to decline. The address then passes to the
20755 next router.
20756
20757 .next
20758 .cindex "batched SMTP output example"
20759 .cindex "SMTP" "batched outgoing; example"
20760 You can use &(manualroute)& to deliver messages to pipes or files in batched
20761 SMTP format for onward transportation by some other means. This is one way of
20762 storing mail for a dial-up host when it is not connected. The route list entry
20763 can be as simple as a single domain name in a configuration like this:
20764 .code
20765 save_in_file:
20766   driver = manualroute
20767   transport = batchsmtp_appendfile
20768   route_list = saved.domain.example
20769 .endd
20770 though often a pattern is used to pick up more than one domain. If there are
20771 several domains or groups of domains with different transport requirements,
20772 different transports can be listed in the routing information:
20773 .code
20774 save_in_file:
20775   driver = manualroute
20776   route_list = \
20777     *.saved.domain1.example  $domain  batch_appendfile; \
20778     *.saved.domain2.example  \
20779       ${lookup{$domain}dbm{/domain2/hosts}{$value}fail} \
20780       batch_pipe
20781 .endd
20782 .vindex "&$domain$&"
20783 .vindex "&$host$&"
20784 The first of these just passes the domain in the &$host$& variable, which
20785 doesn't achieve much (since it is also in &$domain$&), but the second does a
20786 file lookup to find a value to pass, causing the router to decline to handle
20787 the address if the lookup fails.
20788
20789 .next
20790 .cindex "UUCP" "example of router for"
20791 Routing mail directly to UUCP software is a specific case of the use of
20792 &(manualroute)& in a gateway to another mail environment. This is an example of
20793 one way it can be done:
20794 .code
20795 # Transport
20796 uucp:
20797   driver = pipe
20798   user = nobody
20799   command = /usr/local/bin/uux -r - \
20800     ${substr_-5:$host}!rmail ${local_part}
20801   return_fail_output = true
20802
20803 # Router
20804 uucphost:
20805   transport = uucp
20806   driver = manualroute
20807   route_data = \
20808     ${lookup{$domain}lsearch{/usr/local/exim/uucphosts}}
20809 .endd
20810 The file &_/usr/local/exim/uucphosts_& contains entries like
20811 .code
20812 darksite.ethereal.example:           darksite.UUCP
20813 .endd
20814 It can be set up more simply without adding and removing &".UUCP"& but this way
20815 makes clear the distinction between the domain name
20816 &'darksite.ethereal.example'& and the UUCP host name &'darksite'&.
20817 .endlist
20818 .ecindex IIDmanrou1
20819 .ecindex IIDmanrou2
20820
20821
20822
20823
20824
20825
20826
20827
20828 . ////////////////////////////////////////////////////////////////////////////
20829 . ////////////////////////////////////////////////////////////////////////////
20830
20831 .chapter "The queryprogram router" "CHAPdriverlast"
20832 .scindex IIDquerou1 "&(queryprogram)& router"
20833 .scindex IIDquerou2 "routers" "&(queryprogram)&"
20834 .cindex "routing" "by external program"
20835 The &(queryprogram)& router routes an address by running an external command
20836 and acting on its output. This is an expensive way to route, and is intended
20837 mainly for use in lightly-loaded systems, or for performing experiments.
20838 However, if it is possible to use the precondition options (&%domains%&,
20839 &%local_parts%&, etc) to skip this router for most addresses, it could sensibly
20840 be used in special cases, even on a busy host. There are the following private
20841 options:
20842 .cindex "options" "&(queryprogram)& router"
20843
20844 .option command queryprogram string&!! unset
20845 This option must be set. It specifies the command that is to be run. The
20846 command is split up into a command name and arguments, and then each is
20847 expanded separately (exactly as for a &(pipe)& transport, described in chapter
20848 &<<CHAPpipetransport>>&).
20849
20850
20851 .option command_group queryprogram string unset
20852 .cindex "gid (group id)" "in &(queryprogram)& router"
20853 This option specifies a gid to be set when running the command while routing an
20854 address for deliver. It must be set if &%command_user%& specifies a numerical
20855 uid. If it begins with a digit, it is interpreted as the numerical value of the
20856 gid. Otherwise it is looked up using &[getgrnam()]&.
20857
20858
20859 .option command_user queryprogram string unset
20860 .cindex "uid (user id)" "for &(queryprogram)&"
20861 This option must be set. It specifies the uid which is set when running the
20862 command while routing an address for delivery. If the value begins with a digit,
20863 it is interpreted as the numerical value of the uid. Otherwise, it is looked up
20864 using &[getpwnam()]& to obtain a value for the uid and, if &%command_group%& is
20865 not set, a value for the gid also.
20866
20867 &*Warning:*& Changing uid and gid is possible only when Exim is running as
20868 root, which it does during a normal delivery in a conventional configuration.
20869 However, when an address is being verified during message reception, Exim is
20870 usually running as the Exim user, not as root. If the &(queryprogram)& router
20871 is called from a non-root process, Exim cannot change uid or gid before running
20872 the command. In this circumstance the command runs under the current uid and
20873 gid.
20874
20875
20876 .option current_directory queryprogram string /
20877 This option specifies an absolute path which is made the current directory
20878 before running the command.
20879
20880
20881 .option timeout queryprogram time 1h
20882 If the command does not complete within the timeout period, its process group
20883 is killed and the message is frozen. A value of zero time specifies no
20884 timeout.
20885
20886
20887 The standard output of the command is connected to a pipe, which is read when
20888 the command terminates. It should consist of a single line of output,
20889 containing up to five fields, separated by white space. The maximum length of
20890 the line is 1023 characters. Longer lines are silently truncated. The first
20891 field is one of the following words (case-insensitive):
20892
20893 .ilist
20894 &'Accept'&: routing succeeded; the remaining fields specify what to do (see
20895 below).
20896 .next
20897 &'Decline'&: the router declines; pass the address to the next router, unless
20898 &%no_more%& is set.
20899 .next
20900 &'Fail'&: routing failed; do not pass the address to any more routers. Any
20901 subsequent text on the line is an error message. If the router is run as part
20902 of address verification during an incoming SMTP message, the message is
20903 included in the SMTP response.
20904 .next
20905 &'Defer'&: routing could not be completed at this time; try again later. Any
20906 subsequent text on the line is an error message which is logged. It is not
20907 included in any SMTP response.
20908 .next
20909 &'Freeze'&: the same as &'defer'&, except that the message is frozen.
20910 .next
20911 &'Pass'&: pass the address to the next router (or the router specified by
20912 &%pass_router%&), overriding &%no_more%&.
20913 .next
20914 &'Redirect'&: the message is redirected. The remainder of the line is a list of
20915 new addresses, which are routed independently, starting with the first router,
20916 or the router specified by &%redirect_router%&, if set.
20917 .endlist
20918
20919 When the first word is &'accept'&, the remainder of the line consists of a
20920 number of keyed data values, as follows (split into two lines here, to fit on
20921 the page):
20922 .code
20923 ACCEPT TRANSPORT=<transport> HOSTS=<list of hosts>
20924 LOOKUP=byname|bydns DATA=<text>
20925 .endd
20926 The data items can be given in any order, and all are optional. If no transport
20927 is included, the transport specified by the generic &%transport%& option is
20928 used. The list of hosts and the lookup type are needed only if the transport is
20929 an &(smtp)& transport that does not itself supply a list of hosts.
20930
20931 The format of the list of hosts is the same as for the &(manualroute)& router.
20932 As well as host names and IP addresses with optional port numbers, as described
20933 in section &<<SECTformatonehostitem>>&, it may contain names followed by
20934 &`/MX`& to specify sublists of hosts that are obtained by looking up MX records
20935 (see section &<<SECThostshowused>>&).
20936
20937 If the lookup type is not specified, Exim behaves as follows when trying to
20938 find an IP address for each host: First, a DNS lookup is done. If this yields
20939 anything other than HOST_NOT_FOUND, that result is used. Otherwise, Exim
20940 goes on to try a call to &[getipnodebyname()]& or &[gethostbyname()]&, and the
20941 result of the lookup is the result of that call.
20942
20943 .vindex "&$address_data$&"
20944 If the DATA field is set, its value is placed in the &$address_data$&
20945 variable. For example, this return line
20946 .code
20947 accept hosts=x1.y.example:x2.y.example data="rule1"
20948 .endd
20949 routes the address to the default transport, passing a list of two hosts. When
20950 the transport runs, the string &"rule1"& is in &$address_data$&.
20951 .ecindex IIDquerou1
20952 .ecindex IIDquerou2
20953
20954
20955
20956
20957 . ////////////////////////////////////////////////////////////////////////////
20958 . ////////////////////////////////////////////////////////////////////////////
20959
20960 .chapter "The redirect router" "CHAPredirect"
20961 .scindex IIDredrou1 "&(redirect)& router"
20962 .scindex IIDredrou2 "routers" "&(redirect)&"
20963 .cindex "alias file" "in a &(redirect)& router"
20964 .cindex "address redirection" "&(redirect)& router"
20965 The &(redirect)& router handles several kinds of address redirection. Its most
20966 common uses are for resolving local part aliases from a central alias file
20967 (usually called &_/etc/aliases_&) and for handling users' personal &_.forward_&
20968 files, but it has many other potential uses. The incoming address can be
20969 redirected in several different ways:
20970
20971 .ilist
20972 It can be replaced by one or more new addresses which are themselves routed
20973 independently.
20974 .next
20975 It can be routed to be delivered to a given file or directory.
20976 .next
20977 It can be routed to be delivered to a specified pipe command.
20978 .next
20979 It can cause an automatic reply to be generated.
20980 .next
20981 It can be forced to fail, optionally with a custom error message.
20982 .next
20983 It can be temporarily deferred, optionally with a custom message.
20984 .next
20985 It can be discarded.
20986 .endlist
20987
20988 The generic &%transport%& option must not be set for &(redirect)& routers.
20989 However, there are some private options which define transports for delivery to
20990 files and pipes, and for generating autoreplies. See the &%file_transport%&,
20991 &%pipe_transport%& and &%reply_transport%& descriptions below.
20992
20993 If success DSNs have been requested
20994 .cindex "DSN" "success"
20995 .cindex "Delivery Status Notification" "success"
20996 redirection triggers one and the DSN options are not passed any further.
20997
20998
20999
21000 .section "Redirection data" "SECID124"
21001 The router operates by interpreting a text string which it obtains either by
21002 expanding the contents of the &%data%& option, or by reading the entire
21003 contents of a file whose name is given in the &%file%& option. These two
21004 options are mutually exclusive. The first is commonly used for handling system
21005 aliases, in a configuration like this:
21006 .code
21007 system_aliases:
21008   driver = redirect
21009   data = ${lookup{$local_part}lsearch{/etc/aliases}}
21010 .endd
21011 If the lookup fails, the expanded string in this example is empty. When the
21012 expansion of &%data%& results in an empty string, the router declines. A forced
21013 expansion failure also causes the router to decline; other expansion failures
21014 cause delivery to be deferred.
21015
21016 A configuration using &%file%& is commonly used for handling users'
21017 &_.forward_& files, like this:
21018 .code
21019 userforward:
21020   driver = redirect
21021   check_local_user
21022   file = $home/.forward
21023   no_verify
21024 .endd
21025 If the file does not exist, or causes no action to be taken (for example, it is
21026 empty or consists only of comments), the router declines. &*Warning*&: This
21027 is not the case when the file contains syntactically valid items that happen to
21028 yield empty addresses, for example, items containing only RFC 2822 address
21029 comments.
21030
21031 .cindex "tainted data" "in filenames"
21032 .cindex redirect "tainted data"
21033 Tainted data may not be used for a filename.
21034
21035 &*Warning*&: It is unwise to use &$local_part$& or &$domain$&
21036 directly for redirection,
21037 as they are provided by a potential attacker.
21038 In the examples above, &$local_part$& is used for looking up data held locally
21039 on the system, and not used directly (the second example derives &$home$& via
21040 the passsword file or database, using &$local_part$&).
21041
21042
21043
21044 .section "Forward files and address verification" "SECID125"
21045 .cindex "address redirection" "while verifying"
21046 It is usual to set &%no_verify%& on &(redirect)& routers which handle users'
21047 &_.forward_& files, as in the example above. There are two reasons for this:
21048
21049 .ilist
21050 When Exim is receiving an incoming SMTP message from a remote host, it is
21051 running under the Exim uid, not as root. Exim is unable to change uid to read
21052 the file as the user, and it may not be able to read it as the Exim user. So in
21053 practice the router may not be able to operate.
21054 .next
21055 However, even when the router can operate, the existence of a &_.forward_& file
21056 is unimportant when verifying an address. What should be checked is whether the
21057 local part is a valid user name or not. Cutting out the redirection processing
21058 saves some resources.
21059 .endlist
21060
21061
21062
21063
21064
21065
21066 .section "Interpreting redirection data" "SECID126"
21067 .cindex "Sieve filter" "specifying in redirection data"
21068 .cindex "filter" "specifying in redirection data"
21069 The contents of the data string, whether obtained from &%data%& or &%file%&,
21070 can be interpreted in two different ways:
21071
21072 .ilist
21073 If the &%allow_filter%& option is set true, and the data begins with the text
21074 &"#Exim filter"& or &"#Sieve filter"&, it is interpreted as a list of
21075 &'filtering'& instructions in the form of an Exim or Sieve filter file,
21076 respectively. Details of the syntax and semantics of filter files are described
21077 in a separate document entitled &'Exim's interfaces to mail filtering'&; this
21078 document is intended for use by end users.
21079 .next
21080 Otherwise, the data must be a comma-separated list of redirection items, as
21081 described in the next section.
21082 .endlist
21083
21084 When a message is redirected to a file (a &"mail folder"&), the filename given
21085 in a non-filter redirection list must always be an absolute path. A filter may
21086 generate a relative path &-- how this is handled depends on the transport's
21087 configuration. See section &<<SECTfildiropt>>& for a discussion of this issue
21088 for the &(appendfile)& transport.
21089
21090
21091
21092 .section "Items in a non-filter redirection list" "SECTitenonfilred"
21093 .cindex "address redirection" "non-filter list items"
21094 When the redirection data is not an Exim or Sieve filter, for example, if it
21095 comes from a conventional alias or forward file, it consists of a list of
21096 addresses, filenames, pipe commands, or certain special items (see section
21097 &<<SECTspecitredli>>& below). The special items can be individually enabled or
21098 disabled by means of options whose names begin with &%allow_%& or &%forbid_%&,
21099 depending on their default values. The items in the list are separated by
21100 commas or newlines.
21101 If a comma is required in an item, the entire item must be enclosed in double
21102 quotes.
21103
21104 Lines starting with a # character are comments, and are ignored, and # may
21105 also appear following a comma, in which case everything between the # and the
21106 next newline character is ignored.
21107
21108 If an item is entirely enclosed in double quotes, these are removed. Otherwise
21109 double quotes are retained because some forms of mail address require their use
21110 (but never to enclose the entire address). In the following description,
21111 &"item"& refers to what remains after any surrounding double quotes have been
21112 removed.
21113
21114 .vindex "&$local_part$&"
21115 &*Warning*&: If you use an Exim expansion to construct a redirection address,
21116 and the expansion contains a reference to &$local_part$&, you should make use
21117 of the &%quote_local_part%& expansion operator, in case the local part contains
21118 special characters. For example, to redirect all mail for the domain
21119 &'obsolete.example'&, retaining the existing local part, you could use this
21120 setting:
21121 .code
21122 data = ${quote_local_part:$local_part}@newdomain.example
21123 .endd
21124
21125
21126 .section "Redirecting to a local mailbox" "SECTredlocmai"
21127 .cindex "routing" "loops in"
21128 .cindex "loop" "while routing, avoidance of"
21129 .cindex "address redirection" "to local mailbox"
21130 A redirection item may safely be the same as the address currently under
21131 consideration. This does not cause a routing loop, because a router is
21132 automatically skipped if any ancestor of the address that is being processed
21133 is the same as the current address and was processed by the current router.
21134 Such an address is therefore passed to the following routers, so it is handled
21135 as if there were no redirection. When making this loop-avoidance test, the
21136 complete local part, including any prefix or suffix, is used.
21137
21138 .cindex "address redirection" "local part without domain"
21139 Specifying the same local part without a domain is a common usage in personal
21140 filter files when the user wants to have messages delivered to the local
21141 mailbox and also forwarded elsewhere. For example, the user whose login is
21142 &'cleo'& might have a &_.forward_& file containing this:
21143 .code
21144 cleo, cleopatra@egypt.example
21145 .endd
21146 .cindex "backslash in alias file"
21147 .cindex "alias file" "backslash in"
21148 For compatibility with other MTAs, such unqualified local parts may be
21149 preceded by &"\"&, but this is not a requirement for loop prevention. However,
21150 it does make a difference if more than one domain is being handled
21151 synonymously.
21152
21153 If an item begins with &"\"& and the rest of the item parses as a valid RFC
21154 2822 address that does not include a domain, the item is qualified using the
21155 domain of the incoming address. In the absence of a leading &"\"&, unqualified
21156 addresses are qualified using the value in &%qualify_recipient%&, but you can
21157 force the incoming domain to be used by setting &%qualify_preserve_domain%&.
21158
21159 Care must be taken if there are alias names for local users.
21160 Consider an MTA handling a single local domain where the system alias file
21161 contains:
21162 .code
21163 Sam.Reman: spqr
21164 .endd
21165 Now suppose that Sam (whose login id is &'spqr'&) wants to save copies of
21166 messages in the local mailbox, and also forward copies elsewhere. He creates
21167 this forward file:
21168 .code
21169 Sam.Reman, spqr@reme.elsewhere.example
21170 .endd
21171 With these settings, an incoming message addressed to &'Sam.Reman'& fails. The
21172 &(redirect)& router for system aliases does not process &'Sam.Reman'& the
21173 second time round, because it has previously routed it,
21174 and the following routers presumably cannot handle the alias. The forward file
21175 should really contain
21176 .code
21177 spqr, spqr@reme.elsewhere.example
21178 .endd
21179 but because this is such a common error, the &%check_ancestor%& option (see
21180 below) exists to provide a way to get round it. This is normally set on a
21181 &(redirect)& router that is handling users' &_.forward_& files.
21182
21183
21184
21185 .section "Special items in redirection lists" "SECTspecitredli"
21186 In addition to addresses, the following types of item may appear in redirection
21187 lists (that is, in non-filter redirection data):
21188
21189 .ilist
21190 .cindex "pipe" "in redirection list"
21191 .cindex "address redirection" "to pipe"
21192 An item is treated as a pipe command if it begins with &"|"& and does not parse
21193 as a valid RFC 2822 address that includes a domain. A transport for running the
21194 command must be specified by the &%pipe_transport%& option.
21195 Normally, either the router or the transport specifies a user and a group under
21196 which to run the delivery. The default is to use the Exim user and group.
21197
21198 Single or double quotes can be used for enclosing the individual arguments of
21199 the pipe command; no interpretation of escapes is done for single quotes. If
21200 the command contains a comma character, it is necessary to put the whole item
21201 in double quotes, for example:
21202 .code
21203 "|/some/command ready,steady,go"
21204 .endd
21205 since items in redirection lists are terminated by commas. Do not, however,
21206 quote just the command. An item such as
21207 .code
21208 |"/some/command ready,steady,go"
21209 .endd
21210 is interpreted as a pipe with a rather strange command name, and no arguments.
21211
21212 Note that the above example assumes that the text comes from a lookup source
21213 of some sort, so that the quotes are part of the data.  If composing a
21214 redirect router with a &%data%& option directly specifying this command, the
21215 quotes will be used by the configuration parser to define the extent of one
21216 string, but will not be passed down into the redirect router itself.  There
21217 are two main approaches to get around this: escape quotes to be part of the
21218 data itself, or avoid using this mechanism and instead create a custom
21219 transport with the &%command%& option set and reference that transport from
21220 an &%accept%& router.
21221
21222 .next
21223 .cindex "file" "in redirection list"
21224 .cindex "address redirection" "to file"
21225 An item is interpreted as a path name if it begins with &"/"& and does not
21226 parse as a valid RFC 2822 address that includes a domain. For example,
21227 .code
21228 /home/world/minbari
21229 .endd
21230 is treated as a filename, but
21231 .code
21232 /s=molari/o=babylon/@x400gate.way
21233 .endd
21234 is treated as an address. For a filename, a transport must be specified using
21235 the &%file_transport%& option. However, if the generated path name ends with a
21236 forward slash character, it is interpreted as a directory name rather than a
21237 filename, and &%directory_transport%& is used instead.
21238
21239 Normally, either the router or the transport specifies a user and a group under
21240 which to run the delivery. The default is to use the Exim user and group.
21241
21242 .cindex "&_/dev/null_&"
21243 However, if a redirection item is the path &_/dev/null_&, delivery to it is
21244 bypassed at a high level, and the log entry shows &"**bypassed**"&
21245 instead of a transport name. In this case the user and group are not used.
21246
21247 .next
21248 .cindex "included address list"
21249 .cindex "address redirection" "included external list"
21250 If an item is of the form
21251 .code
21252 :include:<path name>
21253 .endd
21254 a list of further items is taken from the given file and included at that
21255 point. &*Note*&: Such a file can not be a filter file; it is just an
21256 out-of-line addition to the list. The items in the included list are separated
21257 by commas or newlines and are not subject to expansion. If this is the first
21258 item in an alias list in an &(lsearch)& file, a colon must be used to terminate
21259 the alias name. This example is incorrect:
21260 .code
21261 list1    :include:/opt/lists/list1
21262 .endd
21263 It must be given as
21264 .code
21265 list1:   :include:/opt/lists/list1
21266 .endd
21267 .cindex "tainted data" "in filenames"
21268 .cindex redirect "tainted data"
21269 Tainted data may not be used for a filename.
21270 .next
21271 .cindex "address redirection" "to black hole"
21272 .cindex "delivery" "discard"
21273 .cindex "delivery" "blackhole"
21274 .cindex "black hole"
21275 .cindex "abandoning mail"
21276 Sometimes you want to throw away mail to a particular local part.  Making the
21277 &%data%& option expand to an empty string does not work, because that causes
21278 the router to decline. Instead, the alias item
21279 .code
21280 :blackhole:
21281 .endd
21282 can be used. It does what its name implies. No delivery is
21283 done, and no error message is generated. This has the same effect as specifying
21284 &_/dev/null_& as a destination, but it can be independently disabled.
21285
21286 &*Warning*&: If &':blackhole:'& appears anywhere in a redirection list, no
21287 delivery is done for the original local part, even if other redirection items
21288 are present. If you are generating a multi-item list (for example, by reading a
21289 database) and need the ability to provide a no-op item, you must use
21290 &_/dev/null_&.
21291
21292 .next
21293 .cindex "delivery" "forcing failure"
21294 .cindex "delivery" "forcing deferral"
21295 .cindex "failing delivery" "forcing"
21296 .cindex "deferred delivery, forcing"
21297 .cindex "customizing" "failure message"
21298 An attempt to deliver a particular address can be deferred or forced to fail by
21299 redirection items of the form
21300 .code
21301 :defer:
21302 :fail:
21303 .endd
21304 respectively. When a redirection list contains such an item, it applies
21305 to the entire redirection; any other items in the list are ignored. Any
21306 text following &':fail:'& or &':defer:'& is placed in the error text
21307 associated with the failure. For example, an alias file might contain:
21308 .code
21309 X.Employee:  :fail: Gone away, no forwarding address
21310 .endd
21311 In the case of an address that is being verified from an ACL or as the subject
21312 of a
21313 .cindex "VRFY" "error text, display of"
21314 VRFY command, the text is included in the SMTP error response by
21315 default.
21316 .cindex "EXPN" "error text, display of"
21317 The text is not included in the response to an EXPN command. In non-SMTP cases
21318 the text is included in the error message that Exim generates.
21319
21320 .cindex "SMTP" "error codes"
21321 By default, Exim sends a 451 SMTP code for a &':defer:'&, and 550 for
21322 &':fail:'&. However, if the message starts with three digits followed by a
21323 space, optionally followed by an extended code of the form &'n.n.n'&, also
21324 followed by a space, and the very first digit is the same as the default error
21325 code, the code from the message is used instead. If the very first digit is
21326 incorrect, a panic error is logged, and the default code is used. You can
21327 suppress the use of the supplied code in a redirect router by setting the
21328 &%forbid_smtp_code%& option true. In this case, any SMTP code is quietly
21329 ignored.
21330
21331 .vindex "&$acl_verify_message$&"
21332 In an ACL, an explicitly provided message overrides the default, but the
21333 default message is available in the variable &$acl_verify_message$& and can
21334 therefore be included in a custom message if this is desired.
21335
21336 Normally the error text is the rest of the redirection list &-- a comma does
21337 not terminate it &-- but a newline does act as a terminator. Newlines are not
21338 normally present in alias expansions. In &(lsearch)& lookups they are removed
21339 as part of the continuation process, but they may exist in other kinds of
21340 lookup and in &':include:'& files.
21341
21342 During routing for message delivery (as opposed to verification), a redirection
21343 containing &':fail:'& causes an immediate failure of the incoming address,
21344 whereas &':defer:'& causes the message to remain in the queue so that a
21345 subsequent delivery attempt can happen at a later time. If an address is
21346 deferred for too long, it will ultimately fail, because the normal retry
21347 rules still apply.
21348
21349 .next
21350 .cindex "alias file" "exception to default"
21351 Sometimes it is useful to use a single-key search type with a default (see
21352 chapter &<<CHAPfdlookup>>&) to look up aliases. However, there may be a need
21353 for exceptions to the default. These can be handled by aliasing them to
21354 &':unknown:'&. This differs from &':fail:'& in that it causes the &(redirect)&
21355 router to decline, whereas &':fail:'& forces routing to fail. A lookup which
21356 results in an empty redirection list has the same effect.
21357 .endlist
21358
21359
21360 .section "Duplicate addresses" "SECTdupaddr"
21361 .cindex "duplicate addresses"
21362 .cindex "address duplicate, discarding"
21363 .cindex "pipe" "duplicated"
21364 Exim removes duplicate addresses from the list to which it is delivering, so as
21365 to deliver just one copy to each address. This does not apply to deliveries
21366 routed to pipes by different immediate parent addresses, but an indirect
21367 aliasing scheme of the type
21368 .code
21369 pipe:       |/some/command $local_part
21370 localpart1: pipe
21371 localpart2: pipe
21372 .endd
21373 does not work with a message that is addressed to both local parts, because
21374 when the second is aliased to the intermediate local part &"pipe"& it gets
21375 discarded as being the same as a previously handled address. However, a scheme
21376 such as
21377 .code
21378 localpart1: |/some/command $local_part
21379 localpart2: |/some/command $local_part
21380 .endd
21381 does result in two different pipe deliveries, because the immediate parents of
21382 the pipes are distinct.
21383
21384
21385
21386 .section "Repeated redirection expansion" "SECID128"
21387 .cindex "repeated redirection expansion"
21388 .cindex "address redirection" "repeated for each delivery attempt"
21389 When a message cannot be delivered to all of its recipients immediately,
21390 leading to two or more delivery attempts, redirection expansion is carried out
21391 afresh each time for those addresses whose children were not all previously
21392 delivered. If redirection is being used as a mailing list, this can lead to new
21393 members of the list receiving copies of old messages. The &%one_time%& option
21394 can be used to avoid this.
21395
21396
21397 .section "Errors in redirection lists" "SECID129"
21398 .cindex "address redirection" "errors"
21399 If &%skip_syntax_errors%& is set, a malformed address that causes a parsing
21400 error is skipped, and an entry is written to the main log. This may be useful
21401 for mailing lists that are automatically managed. Otherwise, if an error is
21402 detected while generating the list of new addresses, the original address is
21403 deferred. See also &%syntax_errors_to%&.
21404
21405
21406
21407 .section "Private options for the redirect router" "SECID130"
21408
21409 .cindex "options" "&(redirect)& router"
21410 The private options for the &(redirect)& router are as follows:
21411
21412
21413 .option allow_defer redirect boolean false
21414 Setting this option allows the use of &':defer:'& in non-filter redirection
21415 data, or the &%defer%& command in an Exim filter file.
21416
21417
21418 .option allow_fail redirect boolean false
21419 .cindex "failing delivery" "from filter"
21420 If this option is true, the &':fail:'& item can be used in a redirection list,
21421 and the &%fail%& command may be used in an Exim filter file.
21422
21423
21424 .option allow_filter redirect boolean false
21425 .cindex "filter" "enabling use of"
21426 .cindex "Sieve filter" "enabling use of"
21427 Setting this option allows Exim to interpret redirection data that starts with
21428 &"#Exim filter"& or &"#Sieve filter"& as a set of filtering instructions. There
21429 are some features of Exim filter files that some administrators may wish to
21430 lock out; see the &%forbid_filter_%&&'xxx'& options below.
21431
21432 It is also possible to lock out Exim filters or Sieve filters while allowing
21433 the other type; see &%forbid_exim_filter%& and &%forbid_sieve_filter%&.
21434
21435
21436 The filter is run using the uid and gid set by the generic &%user%& and
21437 &%group%& options. These take their defaults from the password data if
21438 &%check_local_user%& is set, so in the normal case of users' personal filter
21439 files, the filter is run as the relevant user. When &%allow_filter%& is set
21440 true, Exim insists that either &%check_local_user%& or &%user%& is set.
21441
21442
21443
21444 .option allow_freeze redirect boolean false
21445 .cindex "freezing messages" "allowing in filter"
21446 Setting this option allows the use of the &%freeze%& command in an Exim filter.
21447 This command is more normally encountered in system filters, and is disabled by
21448 default for redirection filters because it isn't something you usually want to
21449 let ordinary users do.
21450
21451
21452
21453 .option check_ancestor redirect boolean false
21454 This option is concerned with handling generated addresses that are the same
21455 as some address in the list of redirection ancestors of the current address.
21456 Although it is turned off by default in the code, it is set in the default
21457 configuration file for handling users' &_.forward_& files. It is recommended
21458 for this use of the &(redirect)& router.
21459
21460 When &%check_ancestor%& is set, if a generated address (including the domain)
21461 is the same as any ancestor of the current address, it is replaced by a copy of
21462 the current address. This helps in the case where local part A is aliased to B,
21463 and B has a &_.forward_& file pointing back to A. For example, within a single
21464 domain, the local part &"Joe.Bloggs"& is aliased to &"jb"& and
21465 &_&~jb/.forward_& contains:
21466 .code
21467 \Joe.Bloggs, <other item(s)>
21468 .endd
21469 Without the &%check_ancestor%& setting, either local part (&"jb"& or
21470 &"joe.bloggs"&) gets processed once by each router and so ends up as it was
21471 originally. If &"jb"& is the real mailbox name, mail to &"jb"& gets delivered
21472 (having been turned into &"joe.bloggs"& by the &_.forward_& file and back to
21473 &"jb"& by the alias), but mail to &"joe.bloggs"& fails. Setting
21474 &%check_ancestor%& on the &(redirect)& router that handles the &_.forward_&
21475 file prevents it from turning &"jb"& back into &"joe.bloggs"& when that was the
21476 original address. See also the &%repeat_use%& option below.
21477
21478
21479 .option check_group redirect boolean "see below"
21480 When the &%file%& option is used, the group owner of the file is checked only
21481 when this option is set. The permitted groups are those listed in the
21482 &%owngroups%& option, together with the user's default group if
21483 &%check_local_user%& is set. If the file has the wrong group, routing is
21484 deferred. The default setting for this option is true if &%check_local_user%&
21485 is set and the &%modemask%& option permits the group write bit, or if the
21486 &%owngroups%& option is set. Otherwise it is false, and no group check occurs.
21487
21488
21489
21490 .option check_owner redirect boolean "see below"
21491 When the &%file%& option is used, the owner of the file is checked only when
21492 this option is set. If &%check_local_user%& is set, the local user is
21493 permitted; otherwise the owner must be one of those listed in the &%owners%&
21494 option. The default value for this option is true if &%check_local_user%& or
21495 &%owners%& is set. Otherwise the default is false, and no owner check occurs.
21496
21497
21498 .option data redirect string&!! unset
21499 This option is mutually exclusive with &%file%&. One or other of them must be
21500 set, but not both. The contents of &%data%& are expanded, and then used as the
21501 list of forwarding items, or as a set of filtering instructions. If the
21502 expansion is forced to fail, or the result is an empty string or a string that
21503 has no effect (consists entirely of comments), the router declines.
21504
21505 When filtering instructions are used, the string must begin with &"#Exim
21506 filter"&, and all comments in the string, including this initial one, must be
21507 terminated with newline characters. For example:
21508 .code
21509 data = #Exim filter\n\
21510        if $h_to: contains Exim then save $home/mail/exim endif
21511 .endd
21512 If you are reading the data from a database where newlines cannot be included,
21513 you can use the &${sg}$& expansion item to turn the escape string of your
21514 choice into a newline.
21515
21516
21517 .option directory_transport redirect string&!! unset
21518 A &(redirect)& router sets up a direct delivery to a directory when a path name
21519 ending with a slash is specified as a new &"address"&. The transport used is
21520 specified by this option, which, after expansion, must be the name of a
21521 configured transport. This should normally be an &(appendfile)& transport.
21522
21523
21524 .option file redirect string&!! unset
21525 This option specifies the name of a file that contains the redirection data. It
21526 is mutually exclusive with the &%data%& option. The string is expanded before
21527 use; if the expansion is forced to fail, the router declines. Other expansion
21528 failures cause delivery to be deferred. The result of a successful expansion
21529 must be an absolute path. The entire file is read and used as the redirection
21530 data. If the data is an empty string or a string that has no effect (consists
21531 entirely of comments), the router declines.
21532
21533 .cindex "NFS" "checking for file existence"
21534 If the attempt to open the file fails with a &"does not exist"& error, Exim
21535 runs a check on the containing directory,
21536 unless &%ignore_enotdir%& is true (see below).
21537 If the directory does not appear to exist, delivery is deferred. This can
21538 happen when users' &_.forward_& files are in NFS-mounted directories, and there
21539 is a mount problem. If the containing directory does exist, but the file does
21540 not, the router declines.
21541
21542
21543 .option file_transport redirect string&!! unset
21544 .vindex "&$address_file$&"
21545 A &(redirect)& router sets up a direct delivery to a file when a path name not
21546 ending in a slash is specified as a new &"address"&. The transport used is
21547 specified by this option, which, after expansion, must be the name of a
21548 configured transport. This should normally be an &(appendfile)& transport. When
21549 it is running, the filename is in &$address_file$&.
21550
21551
21552 .option filter_prepend_home redirect boolean true
21553 When this option is true, if a &(save)& command in an Exim filter specifies a
21554 relative path, and &$home$& is defined, it is automatically prepended to the
21555 relative path. If this option is set false, this action does not happen. The
21556 relative path is then passed to the transport unmodified.
21557
21558
21559 .option forbid_blackhole redirect boolean false
21560 .cindex "restricting access to features"
21561 .cindex "filter" "locking out certain features"
21562 If this option is true, the &':blackhole:'& item may not appear in a
21563 redirection list.
21564
21565
21566 .option forbid_exim_filter redirect boolean false
21567 .cindex "restricting access to features"
21568 .cindex "filter" "locking out certain features"
21569 If this option is set true, only Sieve filters are permitted when
21570 &%allow_filter%& is true.
21571
21572
21573
21574
21575 .option forbid_file redirect boolean false
21576 .cindex "restricting access to features"
21577 .cindex "delivery" "to file; forbidding"
21578 .cindex "filter" "locking out certain features"
21579 .cindex "Sieve filter" "forbidding delivery to a file"
21580 .cindex "Sieve filter" "&""keep""& facility; disabling"
21581 If this option is true, this router may not generate a new address that
21582 specifies delivery to a local file or directory, either from a filter or from a
21583 conventional forward file. This option is forced to be true if &%one_time%& is
21584 set. It applies to Sieve filters as well as to Exim filters, but if true, it
21585 locks out the Sieve's &"keep"& facility.
21586
21587
21588 .option forbid_filter_dlfunc redirect boolean false
21589 .cindex "restricting access to features"
21590 .cindex "filter" "locking out certain features"
21591 If this option is true, string expansions in Exim filters are not allowed to
21592 make use of the &%dlfunc%& expansion facility to run dynamically loaded
21593 functions.
21594
21595 .option forbid_filter_existstest redirect boolean false
21596 .cindex "restricting access to features"
21597 .cindex "filter" "locking out certain features"
21598 .cindex "expansion" "statting a file"
21599 If this option is true, string expansions in Exim filters are not allowed to
21600 make use of the &%exists%& condition or the &%stat%& expansion item.
21601
21602 .option forbid_filter_logwrite redirect boolean false
21603 .cindex "restricting access to features"
21604 .cindex "filter" "locking out certain features"
21605 If this option is true, use of the logging facility in Exim filters is not
21606 permitted. Logging is in any case available only if the filter is being run
21607 under some unprivileged uid (which is normally the case for ordinary users'
21608 &_.forward_& files).
21609
21610
21611 .option forbid_filter_lookup redirect boolean false
21612 .cindex "restricting access to features"
21613 .cindex "filter" "locking out certain features"
21614 If this option is true, string expansions in Exim filter files are not allowed
21615 to make use of &%lookup%& items.
21616
21617
21618 .option forbid_filter_perl redirect boolean false
21619 .cindex "restricting access to features"
21620 .cindex "filter" "locking out certain features"
21621 This option has an effect only if Exim is built with embedded Perl support. If
21622 it is true, string expansions in Exim filter files are not allowed to make use
21623 of the embedded Perl support.
21624
21625
21626 .option forbid_filter_readfile redirect boolean false
21627 .cindex "restricting access to features"
21628 .cindex "filter" "locking out certain features"
21629 If this option is true, string expansions in Exim filter files are not allowed
21630 to make use of &%readfile%& items.
21631
21632
21633 .option forbid_filter_readsocket redirect boolean false
21634 .cindex "restricting access to features"
21635 .cindex "filter" "locking out certain features"
21636 If this option is true, string expansions in Exim filter files are not allowed
21637 to make use of &%readsocket%& items.
21638
21639
21640 .option forbid_filter_reply redirect boolean false
21641 .cindex "restricting access to features"
21642 .cindex "filter" "locking out certain features"
21643 If this option is true, this router may not generate an automatic reply
21644 message. Automatic replies can be generated only from Exim or Sieve filter
21645 files, not from traditional forward files. This option is forced to be true if
21646 &%one_time%& is set.
21647
21648
21649 .option forbid_filter_run redirect boolean false
21650 .cindex "restricting access to features"
21651 .cindex "filter" "locking out certain features"
21652 If this option is true, string expansions in Exim filter files are not allowed
21653 to make use of &%run%& items.
21654
21655
21656 .option forbid_include redirect boolean false
21657 .cindex "restricting access to features"
21658 .cindex "filter" "locking out certain features"
21659 If this option is true, items of the form
21660 .code
21661 :include:<path name>
21662 .endd
21663 are not permitted in non-filter redirection lists.
21664
21665
21666 .option forbid_pipe redirect boolean false
21667 .cindex "restricting access to features"
21668 .cindex "filter" "locking out certain features"
21669 .cindex "delivery" "to pipe; forbidding"
21670 If this option is true, this router may not generate a new address which
21671 specifies delivery to a pipe, either from an Exim filter or from a conventional
21672 forward file. This option is forced to be true if &%one_time%& is set.
21673
21674
21675 .option forbid_sieve_filter redirect boolean false
21676 .cindex "restricting access to features"
21677 .cindex "filter" "locking out certain features"
21678 If this option is set true, only Exim filters are permitted when
21679 &%allow_filter%& is true.
21680
21681
21682 .cindex "SMTP" "error codes"
21683 .option forbid_smtp_code redirect boolean false
21684 If this option is set true, any SMTP error codes that are present at the start
21685 of messages specified for &`:defer:`& or &`:fail:`& are quietly ignored, and
21686 the default codes (451 and 550, respectively) are always used.
21687
21688
21689
21690
21691 .option hide_child_in_errmsg redirect boolean false
21692 .cindex "bounce message" "redirection details; suppressing"
21693 If this option is true, it prevents Exim from quoting a child address if it
21694 generates a bounce or delay message for it. Instead it says &"an address
21695 generated from <&'the top level address'&>"&. Of course, this applies only to
21696 bounces generated locally. If a message is forwarded to another host, &'its'&
21697 bounce may well quote the generated address.
21698
21699
21700 .option ignore_eacces redirect boolean false
21701 .cindex "EACCES"
21702 If this option is set and an attempt to open a redirection file yields the
21703 EACCES error (permission denied), the &(redirect)& router behaves as if the
21704 file did not exist.
21705
21706
21707 .option ignore_enotdir redirect boolean false
21708 .cindex "ENOTDIR"
21709 If this option is set and an attempt to open a redirection file yields the
21710 ENOTDIR error (something on the path is not a directory), the &(redirect)&
21711 router behaves as if the file did not exist.
21712
21713 Setting &%ignore_enotdir%& has another effect as well: When a &(redirect)&
21714 router that has the &%file%& option set discovers that the file does not exist
21715 (the ENOENT error), it tries to &[stat()]& the parent directory, as a check
21716 against unmounted NFS directories. If the parent can not be statted, delivery
21717 is deferred. However, it seems wrong to do this check when &%ignore_enotdir%&
21718 is set, because that option tells Exim to ignore &"something on the path is not
21719 a directory"& (the ENOTDIR error). This is a confusing area, because it seems
21720 that some operating systems give ENOENT where others give ENOTDIR.
21721
21722
21723
21724 .option include_directory redirect string unset
21725 If this option is set, the path names of any &':include:'& items in a
21726 redirection list must start with this directory.
21727
21728
21729 .option modemask redirect "octal integer" 022
21730 This specifies mode bits which must not be set for a file specified by the
21731 &%file%& option. If any of the forbidden bits are set, delivery is deferred.
21732
21733
21734 .option one_time redirect boolean false
21735 .cindex "one-time aliasing/forwarding expansion"
21736 .cindex "alias file" "one-time expansion"
21737 .cindex "forward file" "one-time expansion"
21738 .cindex "mailing lists" "one-time expansion"
21739 .cindex "address redirection" "one-time expansion"
21740 Sometimes the fact that Exim re-evaluates aliases and reprocesses redirection
21741 files each time it tries to deliver a message causes a problem when one or more
21742 of the generated addresses fails be delivered at the first attempt. The problem
21743 is not one of duplicate delivery &-- Exim is clever enough to handle that &--
21744 but of what happens when the redirection list changes during the time that the
21745 message is on Exim's queue. This is particularly true in the case of mailing
21746 lists, where new subscribers might receive copies of messages that were posted
21747 before they subscribed.
21748
21749 If &%one_time%& is set and any addresses generated by the router fail to
21750 deliver at the first attempt, the failing addresses are added to the message as
21751 &"top level"& addresses, and the parent address that generated them is marked
21752 &"delivered"&. Thus, redirection does not happen again at the next delivery
21753 attempt.
21754
21755 &*Warning 1*&: Any header line addition or removal that is specified by this
21756 router would be lost if delivery did not succeed at the first attempt. For this
21757 reason, the &%headers_add%& and &%headers_remove%& generic options are not
21758 permitted when &%one_time%& is set.
21759
21760 &*Warning 2*&: To ensure that the router generates only addresses (as opposed
21761 to pipe or file deliveries or auto-replies) &%forbid_file%&, &%forbid_pipe%&,
21762 and &%forbid_filter_reply%& are forced to be true when &%one_time%& is set.
21763
21764 &*Warning 3*&: The &%unseen%& generic router option may not be set with
21765 &%one_time%&.
21766
21767 The original top-level address is remembered with each of the generated
21768 addresses, and is output in any log messages. However, any intermediate parent
21769 addresses are not recorded. This makes a difference to the log only if
21770 &%all_parents%& log selector is set. It is expected that &%one_time%& will
21771 typically be used for mailing lists, where there is normally just one level of
21772 expansion.
21773
21774
21775 .option owners redirect "string list" unset
21776 .cindex "ownership" "alias file"
21777 .cindex "ownership" "forward file"
21778 .cindex "alias file" "ownership"
21779 .cindex "forward file" "ownership"
21780 This specifies a list of permitted owners for the file specified by &%file%&.
21781 This list is in addition to the local user when &%check_local_user%& is set.
21782 See &%check_owner%& above.
21783
21784
21785 .option owngroups redirect "string list" unset
21786 This specifies a list of permitted groups for the file specified by &%file%&.
21787 The list is in addition to the local user's primary group when
21788 &%check_local_user%& is set. See &%check_group%& above.
21789
21790
21791 .option pipe_transport redirect string&!! unset
21792 .vindex "&$address_pipe$&"
21793 A &(redirect)& router sets up a direct delivery to a pipe when a string
21794 starting with a vertical bar character is specified as a new &"address"&. The
21795 transport used is specified by this option, which, after expansion, must be the
21796 name of a configured transport. This should normally be a &(pipe)& transport.
21797 When the transport is run, the pipe command is in &$address_pipe$&.
21798
21799
21800 .option qualify_domain redirect string&!! unset
21801 .vindex "&$qualify_recipient$&"
21802 If this option is set, and an unqualified address (one without a domain) is
21803 generated, and that address would normally be qualified by the global setting
21804 in &%qualify_recipient%&, it is instead qualified with the domain specified by
21805 expanding this string. If the expansion fails, the router declines. If you want
21806 to revert to the default, you can have the expansion generate
21807 &$qualify_recipient$&.
21808
21809 This option applies to all unqualified addresses generated by Exim filters,
21810 but for traditional &_.forward_& files, it applies only to addresses that are
21811 not preceded by a backslash. Sieve filters cannot generate unqualified
21812 addresses.
21813
21814 .option qualify_preserve_domain redirect boolean false
21815 .cindex "domain" "in redirection; preserving"
21816 .cindex "preserving domain in redirection"
21817 .cindex "address redirection" "domain; preserving"
21818 If this option is set, the router's local &%qualify_domain%& option must not be
21819 set (a configuration error occurs if it is). If an unqualified address (one
21820 without a domain) is generated, it is qualified with the domain of the parent
21821 address (the immediately preceding ancestor) instead of the global
21822 &%qualify_recipient%& value. In the case of a traditional &_.forward_& file,
21823 this applies whether or not the address is preceded by a backslash.
21824
21825
21826 .option repeat_use redirect boolean true
21827 If this option is set false, the router is skipped for a child address that has
21828 any ancestor that was routed by this router. This test happens before any of
21829 the other preconditions are tested. Exim's default anti-looping rules skip
21830 only when the ancestor is the same as the current address. See also
21831 &%check_ancestor%& above and the generic &%redirect_router%& option.
21832
21833
21834 .option reply_transport redirect string&!! unset
21835 A &(redirect)& router sets up an automatic reply when a &%mail%& or
21836 &%vacation%& command is used in a filter file. The transport used is specified
21837 by this option, which, after expansion, must be the name of a configured
21838 transport. This should normally be an &(autoreply)& transport. Other transports
21839 are unlikely to do anything sensible or useful.
21840
21841
21842 .option rewrite redirect boolean true
21843 .cindex "address redirection" "disabling rewriting"
21844 If this option is set false, addresses generated by the router are not
21845 subject to address rewriting. Otherwise, they are treated like new addresses
21846 and are rewritten according to the global rewriting rules.
21847
21848
21849 .option sieve_subaddress redirect string&!! unset
21850 The value of this option is passed to a Sieve filter to specify the
21851 :subaddress part of an address.
21852
21853 .option sieve_useraddress redirect string&!! unset
21854 The value of this option is passed to a Sieve filter to specify the :user part
21855 of an address. However, if it is unset, the entire original local part
21856 (including any prefix or suffix) is used for :user.
21857
21858
21859 .option sieve_vacation_directory redirect string&!! unset
21860 .cindex "Sieve filter" "vacation directory"
21861 To enable the &"vacation"& extension for Sieve filters, you must set
21862 &%sieve_vacation_directory%& to the directory where vacation databases are held
21863 (do not put anything else in that directory), and ensure that the
21864 &%reply_transport%& option refers to an &(autoreply)& transport. Each user
21865 needs their own directory; Exim will create it if necessary.
21866
21867
21868
21869 .option skip_syntax_errors redirect boolean false
21870 .cindex "forward file" "broken"
21871 .cindex "address redirection" "broken files"
21872 .cindex "alias file" "broken"
21873 .cindex "broken alias or forward files"
21874 .cindex "ignoring faulty addresses"
21875 .cindex "skipping faulty addresses"
21876 .cindex "error" "skipping bad syntax"
21877 If &%skip_syntax_errors%& is set, syntactically malformed addresses in
21878 non-filter redirection data are skipped, and each failing address is logged. If
21879 &%syntax_errors_to%& is set, a message is sent to the address it defines,
21880 giving details of the failures. If &%syntax_errors_text%& is set, its contents
21881 are expanded and placed at the head of the error message generated by
21882 &%syntax_errors_to%&. Usually it is appropriate to set &%syntax_errors_to%& to
21883 be the same address as the generic &%errors_to%& option. The
21884 &%skip_syntax_errors%& option is often used when handling mailing lists.
21885
21886 If all the addresses in a redirection list are skipped because of syntax
21887 errors, the router declines to handle the original address, and it is passed to
21888 the following routers.
21889
21890 If &%skip_syntax_errors%& is set when an Exim filter is interpreted, any syntax
21891 error in the filter causes filtering to be abandoned without any action being
21892 taken. The incident is logged, and the router declines to handle the address,
21893 so it is passed to the following routers.
21894
21895 .cindex "Sieve filter" "syntax errors in"
21896 Syntax errors in a Sieve filter file cause the &"keep"& action to occur. This
21897 action is specified by RFC 3028. The values of &%skip_syntax_errors%&,
21898 &%syntax_errors_to%&, and &%syntax_errors_text%& are not used.
21899
21900 &%skip_syntax_errors%& can be used to specify that errors in users' forward
21901 lists or filter files should not prevent delivery. The &%syntax_errors_to%&
21902 option, used with an address that does not get redirected, can be used to
21903 notify users of these errors, by means of a router like this:
21904 .code
21905 userforward:
21906   driver = redirect
21907   allow_filter
21908   check_local_user
21909   file = $home/.forward
21910   file_transport = address_file
21911   pipe_transport = address_pipe
21912   reply_transport = address_reply
21913   no_verify
21914   skip_syntax_errors
21915   syntax_errors_to = real-$local_part@$domain
21916   syntax_errors_text = \
21917    This is an automatically generated message. An error has\n\
21918    been found in your .forward file. Details of the error are\n\
21919    reported below. While this error persists, you will receive\n\
21920    a copy of this message for every message that is addressed\n\
21921    to you. If your .forward file is a filter file, or if it is\n\
21922    a non-filter file containing no valid forwarding addresses,\n\
21923    a copy of each incoming message will be put in your normal\n\
21924    mailbox. If a non-filter file contains at least one valid\n\
21925    forwarding address, forwarding to the valid addresses will\n\
21926    happen, and those will be the only deliveries that occur.
21927 .endd
21928 You also need a router to ensure that local addresses that are prefixed by
21929 &`real-`& are recognized, but not forwarded or filtered. For example, you could
21930 put this immediately before the &(userforward)& router:
21931 .code
21932 real_localuser:
21933   driver = accept
21934   check_local_user
21935   local_part_prefix = real-
21936   transport = local_delivery
21937 .endd
21938 For security, it would probably be a good idea to restrict the use of this
21939 router to locally-generated messages, using a condition such as this:
21940 .code
21941   condition = ${if match {$sender_host_address}\
21942                          {\N^(|127\.0\.0\.1)$\N}}
21943 .endd
21944
21945
21946 .option syntax_errors_text redirect string&!! unset
21947 See &%skip_syntax_errors%& above.
21948
21949
21950 .option syntax_errors_to redirect string unset
21951 See &%skip_syntax_errors%& above.
21952 .ecindex IIDredrou1
21953 .ecindex IIDredrou2
21954
21955
21956
21957
21958
21959
21960 . ////////////////////////////////////////////////////////////////////////////
21961 . ////////////////////////////////////////////////////////////////////////////
21962
21963 .chapter "Environment for running local transports" "CHAPenvironment" &&&
21964          "Environment for local transports"
21965 .scindex IIDenvlotra1 "local transports" "environment for"
21966 .scindex IIDenvlotra2 "environment" "local transports"
21967 .scindex IIDenvlotra3 "transport" "local; environment for"
21968 Local transports handle deliveries to files and pipes. (The &(autoreply)&
21969 transport can be thought of as similar to a pipe.) Exim always runs transports
21970 in subprocesses, under specified uids and gids. Typical deliveries to local
21971 mailboxes run under the uid and gid of the local user.
21972
21973 Exim also sets a specific current directory while running the transport; for
21974 some transports a home directory setting is also relevant. The &(pipe)&
21975 transport is the only one that sets up environment variables; see section
21976 &<<SECTpipeenv>>& for details.
21977
21978 The values used for the uid, gid, and the directories may come from several
21979 different places. In many cases, the router that handles the address associates
21980 settings with that address as a result of its &%check_local_user%&, &%group%&,
21981 or &%user%& options. However, values may also be given in the transport's own
21982 configuration, and these override anything that comes from the router.
21983
21984
21985
21986 .section "Concurrent deliveries" "SECID131"
21987 .cindex "concurrent deliveries"
21988 .cindex "simultaneous deliveries"
21989 If two different messages for the same local recipient arrive more or less
21990 simultaneously, the two delivery processes are likely to run concurrently. When
21991 the &(appendfile)& transport is used to write to a file, Exim applies locking
21992 rules to stop concurrent processes from writing to the same file at the same
21993 time.
21994
21995 However, when you use a &(pipe)& transport, it is up to you to arrange any
21996 locking that is needed. Here is a silly example:
21997 .code
21998 my_transport:
21999   driver = pipe
22000   command = /bin/sh -c 'cat >>/some/file'
22001 .endd
22002 This is supposed to write the message at the end of the file. However, if two
22003 messages arrive at the same time, the file will be scrambled. You can use the
22004 &%exim_lock%& utility program (see section &<<SECTmailboxmaint>>&) to lock a
22005 file using the same algorithm that Exim itself uses.
22006
22007
22008
22009
22010 .section "Uids and gids" "SECTenvuidgid"
22011 .cindex "local transports" "uid and gid"
22012 .cindex "transport" "local; uid and gid"
22013 All transports have the options &%group%& and &%user%&. If &%group%& is set, it
22014 overrides any group that the router set in the address, even if &%user%& is not
22015 set for the transport. This makes it possible, for example, to run local mail
22016 delivery under the uid of the recipient (set by the router), but in a special
22017 group (set by the transport). For example:
22018 .code
22019 # Routers ...
22020 # User/group are set by check_local_user in this router
22021 local_users:
22022   driver = accept
22023   check_local_user
22024   transport = group_delivery
22025
22026 # Transports ...
22027 # This transport overrides the group
22028 group_delivery:
22029   driver = appendfile
22030   file = /var/spool/mail/$local_part_data
22031   group = mail
22032 .endd
22033 If &%user%& is set for a transport, its value overrides what is set in the
22034 address by the router. If &%user%& is non-numeric and &%group%& is not set, the
22035 gid associated with the user is used. If &%user%& is numeric, &%group%& must be
22036 set.
22037
22038 .oindex "&%initgroups%&"
22039 When the uid is taken from the transport's configuration, the &[initgroups()]&
22040 function is called for the groups associated with that uid if the
22041 &%initgroups%& option is set for the transport. When the uid is not specified
22042 by the transport, but is associated with the address by a router, the option
22043 for calling &[initgroups()]& is taken from the router configuration.
22044
22045 .cindex "&(pipe)& transport" "uid for"
22046 The &(pipe)& transport contains the special option &%pipe_as_creator%&. If this
22047 is set and &%user%& is not set, the uid of the process that called Exim to
22048 receive the message is used, and if &%group%& is not set, the corresponding
22049 original gid is also used.
22050
22051 This is the detailed preference order for obtaining a gid; the first of the
22052 following that is set is used:
22053
22054 .ilist
22055 A &%group%& setting of the transport;
22056 .next
22057 A &%group%& setting of the router;
22058 .next
22059 A gid associated with a user setting of the router, either as a result of
22060 &%check_local_user%& or an explicit non-numeric &%user%& setting;
22061 .next
22062 The group associated with a non-numeric &%user%& setting of the transport;
22063 .next
22064 In a &(pipe)& transport, the creator's gid if &%deliver_as_creator%& is set and
22065 the uid is the creator's uid;
22066 .next
22067 The Exim gid if the Exim uid is being used as a default.
22068 .endlist
22069
22070 If, for example, the user is specified numerically on the router and there are
22071 no group settings, no gid is available. In this situation, an error occurs.
22072 This is different for the uid, for which there always is an ultimate default.
22073 The first of the following that is set is used:
22074
22075 .ilist
22076 A &%user%& setting of the transport;
22077 .next
22078 In a &(pipe)& transport, the creator's uid if &%deliver_as_creator%& is set;
22079 .next
22080 A &%user%& setting of the router;
22081 .next
22082 A &%check_local_user%& setting of the router;
22083 .next
22084 The Exim uid.
22085 .endlist
22086
22087 Of course, an error will still occur if the uid that is chosen is on the
22088 &%never_users%& list.
22089
22090
22091
22092
22093
22094 .section "Current and home directories" "SECID132"
22095 .cindex "current directory for local transport"
22096 .cindex "home directory" "for local transport"
22097 .cindex "transport" "local; home directory for"
22098 .cindex "transport" "local; current directory for"
22099 Routers may set current and home directories for local transports by means of
22100 the &%transport_current_directory%& and &%transport_home_directory%& options.
22101 However, if the transport's &%current_directory%& or &%home_directory%& options
22102 are set, they override the router's values. In detail, the home directory
22103 for a local transport is taken from the first of these values that is set:
22104
22105 .ilist
22106 The &%home_directory%& option on the transport;
22107 .next
22108 The &%transport_home_directory%& option on the router;
22109 .next
22110 The password data if &%check_local_user%& is set on the router;
22111 .next
22112 The &%router_home_directory%& option on the router.
22113 .endlist
22114
22115 The current directory is taken from the first of these values that is set:
22116
22117 .ilist
22118 The &%current_directory%& option on the transport;
22119 .next
22120 The &%transport_current_directory%& option on the router.
22121 .endlist
22122
22123
22124 If neither the router nor the transport sets a current directory, Exim uses the
22125 value of the home directory, if it is set. Otherwise it sets the current
22126 directory to &_/_& before running a local transport.
22127
22128
22129
22130 .section "Expansion variables derived from the address" "SECID133"
22131 .vindex "&$domain$&"
22132 .vindex "&$local_part$&"
22133 .vindex "&$original_domain$&"
22134 Normally a local delivery is handling a single address, and in that case the
22135 variables such as &$domain$& and &$local_part$& are set during local
22136 deliveries. However, in some circumstances more than one address may be handled
22137 at once (for example, while writing batch SMTP for onward transmission by some
22138 other means). In this case, the variables associated with the local part are
22139 never set, &$domain$& is set only if all the addresses have the same domain,
22140 and &$original_domain$& is never set.
22141 .ecindex IIDenvlotra1
22142 .ecindex IIDenvlotra2
22143 .ecindex IIDenvlotra3
22144
22145
22146
22147
22148
22149
22150
22151 . ////////////////////////////////////////////////////////////////////////////
22152 . ////////////////////////////////////////////////////////////////////////////
22153
22154 .chapter "Generic options for transports" "CHAPtransportgeneric"
22155 .scindex IIDgenoptra1 "generic options" "transport"
22156 .scindex IIDgenoptra2 "options" "generic; for transports"
22157 .scindex IIDgenoptra3 "transport" "generic options for"
22158 The following generic options apply to all transports:
22159
22160
22161 .option body_only transports boolean false
22162 .cindex "transport" "body only"
22163 .cindex "message" "transporting body only"
22164 .cindex "body of message" "transporting"
22165 If this option is set, the message's headers are not transported. It is
22166 mutually exclusive with &%headers_only%&. If it is used with the &(appendfile)&
22167 or &(pipe)& transports, the settings of &%message_prefix%& and
22168 &%message_suffix%& should be checked, because this option does not
22169 automatically suppress them.
22170
22171
22172 .option current_directory transports string&!! unset
22173 .cindex "transport" "current directory for"
22174 This specifies the current directory that is to be set while running the
22175 transport, overriding any value that may have been set by the router.
22176 If the expansion fails for any reason, including forced failure, an error is
22177 logged, and delivery is deferred.
22178
22179
22180 .option disable_logging transports boolean false
22181 If this option is set true, nothing is logged for any
22182 deliveries by the transport or for any
22183 transport errors. You should not set this option unless you really, really know
22184 what you are doing.
22185
22186
22187 .option debug_print transports string&!! unset
22188 .cindex "testing" "variables in drivers"
22189 If this option is set and debugging is enabled (see the &%-d%& command line
22190 option), the string is expanded and included in the debugging output when the
22191 transport is run.
22192 If expansion of the string fails, the error message is written to the debugging
22193 output, and Exim carries on processing.
22194 This facility is provided to help with checking out the values of variables and
22195 so on when debugging driver configurations. For example, if a &%headers_add%&
22196 option is not working properly, &%debug_print%& could be used to output the
22197 variables it references. A newline is added to the text if it does not end with
22198 one.
22199 The variables &$transport_name$& and &$router_name$& contain the name of the
22200 transport and the router that called it.
22201
22202 .option delivery_date_add transports boolean false
22203 .cindex "&'Delivery-date:'& header line"
22204 If this option is true, a &'Delivery-date:'& header is added to the message.
22205 This gives the actual time the delivery was made. As this is not a standard
22206 header, Exim has a configuration option (&%delivery_date_remove%&) which
22207 requests its removal from incoming messages, so that delivered messages can
22208 safely be resent to other recipients.
22209
22210
22211 .option driver transports string unset
22212 This specifies which of the available transport drivers is to be used.
22213 There is no default, and this option must be set for every transport.
22214
22215
22216 .option envelope_to_add transports boolean false
22217 .cindex "&'Envelope-to:'& header line"
22218 If this option is true, an &'Envelope-to:'& header is added to the message.
22219 This gives the original address(es) in the incoming envelope that caused this
22220 delivery to happen. More than one address may be present if the transport is
22221 configured to handle several addresses at once, or if more than one original
22222 address was redirected to the same final address. As this is not a standard
22223 header, Exim has a configuration option (&%envelope_to_remove%&) which requests
22224 its removal from incoming messages, so that delivered messages can safely be
22225 resent to other recipients.
22226
22227
22228 .option event_action transports string&!! unset
22229 .cindex events
22230 This option declares a string to be expanded for Exim's events mechanism.
22231 For details see chapter &<<CHAPevents>>&.
22232
22233
22234 .option group transports string&!! "Exim group"
22235 .cindex "transport" "group; specifying"
22236 This option specifies a gid for running the transport process, overriding any
22237 value that the router supplies, and also overriding any value associated with
22238 &%user%& (see below).
22239
22240
22241 .option headers_add transports list&!! unset
22242 .cindex "header lines" "adding in transport"
22243 .cindex "transport" "header lines; adding"
22244 This option specifies a list of text headers,
22245 newline-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
22246 which are (separately) expanded and added to the header
22247 portion of a message as it is transported, as described in section
22248 &<<SECTheadersaddrem>>&. Additional header lines can also be specified by
22249 routers. If the result of the expansion is an empty string, or if the expansion
22250 is forced to fail, no action is taken. Other expansion failures are treated as
22251 errors and cause the delivery to be deferred.
22252
22253 Unlike most options, &%headers_add%& can be specified multiple times
22254 for a transport; all listed headers are added.
22255
22256
22257 .option headers_only transports boolean false
22258 .cindex "transport" "header lines only"
22259 .cindex "message" "transporting headers only"
22260 .cindex "header lines" "transporting"
22261 If this option is set, the message's body is not transported. It is mutually
22262 exclusive with &%body_only%&. If it is used with the &(appendfile)& or &(pipe)&
22263 transports, the settings of &%message_prefix%& and &%message_suffix%& should be
22264 checked, since this option does not automatically suppress them.
22265
22266
22267 .option headers_remove transports list&!! unset
22268 .cindex "header lines" "removing"
22269 .cindex "transport" "header lines; removing"
22270 This option specifies a list of text headers,
22271 colon-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
22272 to be removed from the message.
22273 However, the option has no effect when an address is just being verified.
22274 Each list item is separately expanded.
22275 If the result of the expansion is an empty string, or if the expansion
22276 is forced to fail, no action is taken. Other expansion failures are treated as
22277 errors and cause the delivery to be deferred.
22278 If an item ends in *, it will match any header with the given prefix.
22279
22280 Matching headers are omitted from the message as it is transported, as described
22281 in section &<<SECTheadersaddrem>>&. Header removal can also be specified by
22282 routers.
22283
22284 Unlike most options, &%headers_remove%& can be specified multiple times
22285 for a transport; all listed headers are removed.
22286
22287 &*Warning*&: Because of the separate expansion of the list items,
22288 items that contain a list separator must have it doubled.
22289 To avoid this, change the list separator (&<<SECTlistsepchange>>&).
22290
22291
22292
22293 .option headers_rewrite transports string unset
22294 .cindex "transport" "header lines; rewriting"
22295 .cindex "rewriting" "at transport time"
22296 This option allows addresses in header lines to be rewritten at transport time,
22297 that is, as the message is being copied to its destination. The contents of the
22298 option are a colon-separated list of rewriting rules. Each rule is in exactly
22299 the same form as one of the general rewriting rules that are applied when a
22300 message is received. These are described in chapter &<<CHAPrewrite>>&. For
22301 example,
22302 .code
22303 headers_rewrite = a@b c@d f : \
22304                   x@y w@z
22305 .endd
22306 changes &'a@b'& into &'c@d'& in &'From:'& header lines, and &'x@y'& into
22307 &'w@z'& in all address-bearing header lines. The rules are applied to the
22308 header lines just before they are written out at transport time, so they affect
22309 only those copies of the message that pass through the transport. However, only
22310 the message's original header lines, and any that were added by a system
22311 filter, are rewritten. If a router or transport adds header lines, they are not
22312 affected by this option. These rewriting rules are &'not'& applied to the
22313 envelope. You can change the return path using &%return_path%&, but you cannot
22314 change envelope recipients at this time.
22315
22316
22317 .option home_directory transports string&!! unset
22318 .cindex "transport" "home directory for"
22319 .vindex "&$home$&"
22320 This option specifies a home directory setting for a local transport,
22321 overriding any value that may be set by the router. The home directory is
22322 placed in &$home$& while expanding the transport's private options. It is also
22323 used as the current directory if no current directory is set by the
22324 &%current_directory%& option on the transport or the
22325 &%transport_current_directory%& option on the router. If the expansion fails
22326 for any reason, including forced failure, an error is logged, and delivery is
22327 deferred.
22328
22329
22330 .option initgroups transports boolean false
22331 .cindex "additional groups"
22332 .cindex "groups" "additional"
22333 .cindex "transport" "group; additional"
22334 If this option is true and the uid for the delivery process is provided by the
22335 transport, the &[initgroups()]& function is called when running the transport
22336 to ensure that any additional groups associated with the uid are set up.
22337
22338
22339 .option max_parallel transports integer&!! unset
22340 .cindex limit "transport parallelism"
22341 .cindex transport "parallel processes"
22342 .cindex transport "concurrency limit"
22343 .cindex "delivery" "parallelism for transport"
22344 If this option is set and expands to an integer greater than zero
22345 it limits the number of concurrent runs of the transport.
22346 The control does not apply to shadow transports.
22347
22348 .cindex "hints database" "transport concurrency control"
22349 Exim implements this control by means of a hints database in which a record is
22350 incremented whenever a transport process is being created. The record
22351 is decremented and possibly removed when the process terminates.
22352 Obviously there is scope for
22353 records to get left lying around if there is a system or program crash. To
22354 guard against this, Exim ignores any records that are more than six hours old.
22355
22356 If you use this option, you should also arrange to delete the
22357 relevant hints database whenever your system reboots. The names of the files
22358 start with &_misc_& and they are kept in the &_spool/db_& directory. There
22359 may be one or two files, depending on the type of DBM in use. The same files
22360 are used for ETRN and smtp transport serialization.
22361
22362
22363 .option message_size_limit transports string&!! 0
22364 .cindex "limit" "message size per transport"
22365 .cindex "size" "of message, limit"
22366 .cindex "transport" "message size; limiting"
22367 This option controls the size of messages passed through the transport. It is
22368 expanded before use; the result of the expansion must be a sequence of decimal
22369 digits, optionally followed by K or M. If the expansion fails for any reason,
22370 including forced failure, or if the result is not of the required form,
22371 delivery is deferred. If the value is greater than zero and the size of a
22372 message exceeds this limit, the address is failed. If there is any chance that
22373 the resulting bounce message could be routed to the same transport, you should
22374 ensure that &%return_size_limit%& is less than the transport's
22375 &%message_size_limit%&, as otherwise the bounce message will fail to get
22376 delivered.
22377
22378
22379
22380 .option rcpt_include_affixes transports boolean false
22381 .cindex "prefix" "for local part, including in envelope"
22382 .cindex "suffix for local part" "including in envelope"
22383 .cindex "local part" "prefix"
22384 .cindex "local part" "suffix"
22385 When this option is false (the default), and an address that has had any
22386 affixes (prefixes or suffixes) removed from the local part is delivered by any
22387 form of SMTP or LMTP, the affixes are not included. For example, if a router
22388 that contains
22389 .code
22390 local_part_prefix = *-
22391 .endd
22392 routes the address &'abc-xyz@some.domain'& to an SMTP transport, the envelope
22393 is delivered with
22394 .code
22395 RCPT TO:<xyz@some.domain>
22396 .endd
22397 This is also the case when an ACL-time callout is being used to verify a
22398 recipient address. However, if &%rcpt_include_affixes%& is set true, the
22399 whole local part is included in the RCPT command. This option applies to BSMTP
22400 deliveries by the &(appendfile)& and &(pipe)& transports as well as to the
22401 &(lmtp)& and &(smtp)& transports.
22402
22403
22404 .option retry_use_local_part transports boolean "see below"
22405 .cindex "hints database" "retry keys"
22406 When a delivery suffers a temporary failure, a retry record is created
22407 in Exim's hints database. For remote deliveries, the key for the retry record
22408 is based on the name and/or IP address of the failing remote host. For local
22409 deliveries, the key is normally the entire address, including both the local
22410 part and the domain. This is suitable for most common cases of local delivery
22411 temporary failure &-- for example, exceeding a mailbox quota should delay only
22412 deliveries to that mailbox, not to the whole domain.
22413
22414 However, in some special cases you may want to treat a temporary local delivery
22415 as a failure associated with the domain, and not with a particular local part.
22416 (For example, if you are storing all mail for some domain in files.) You can do
22417 this by setting &%retry_use_local_part%& false.
22418
22419 For all the local transports, its default value is true. For remote transports,
22420 the default value is false for tidiness, but changing the value has no effect
22421 on a remote transport in the current implementation.
22422
22423
22424 .option return_path transports string&!! unset
22425 .cindex "envelope sender"
22426 .cindex "envelope from"
22427 .cindex "transport" "return path; changing"
22428 .cindex "return path" "changing in transport"
22429 If this option is set, the string is expanded at transport time and replaces
22430 the existing return path (envelope sender) value in the copy of the message
22431 that is being delivered. An empty return path is permitted. This feature is
22432 designed for remote deliveries, where the value of this option is used in the
22433 SMTP MAIL command. If you set &%return_path%& for a local transport, the
22434 only effect is to change the address that is placed in the &'Return-path:'&
22435 header line, if one is added to the message (see the next option).
22436
22437 &*Note:*& A changed return path is not logged unless you add
22438 &%return_path_on_delivery%& to the log selector.
22439
22440 .vindex "&$return_path$&"
22441 The expansion can refer to the existing value via &$return_path$&. This is
22442 either the message's envelope sender, or an address set by the
22443 &%errors_to%& option on a router. If the expansion is forced to fail, no
22444 replacement occurs; if it fails for another reason, delivery is deferred. This
22445 option can be used to support VERP (Variable Envelope Return Paths) &-- see
22446 section &<<SECTverp>>&.
22447
22448 &*Note*&: If a delivery error is detected locally, including the case when a
22449 remote server rejects a message at SMTP time, the bounce message is not sent to
22450 the value of this option. It is sent to the previously set errors address.
22451 This defaults to the incoming sender address, but can be changed by setting
22452 &%errors_to%& in a router.
22453
22454
22455
22456 .option return_path_add transports boolean false
22457 .cindex "&'Return-path:'& header line"
22458 If this option is true, a &'Return-path:'& header is added to the message.
22459 Although the return path is normally available in the prefix line of BSD
22460 mailboxes, this is commonly not displayed by MUAs, and so the user does not
22461 have easy access to it.
22462
22463 RFC 2821 states that the &'Return-path:'& header is added to a message &"when
22464 the delivery SMTP server makes the final delivery"&. This implies that this
22465 header should not be present in incoming messages. Exim has a configuration
22466 option, &%return_path_remove%&, which requests removal of this header from
22467 incoming messages, so that delivered messages can safely be resent to other
22468 recipients.
22469
22470
22471 .option shadow_condition transports string&!! unset
22472 See &%shadow_transport%& below.
22473
22474
22475 .option shadow_transport transports string unset
22476 .cindex "shadow transport"
22477 .cindex "transport" "shadow"
22478 A local transport may set the &%shadow_transport%& option to the name of
22479 another local transport. Shadow remote transports are not supported.
22480
22481 Whenever a delivery to the main transport succeeds, and either
22482 &%shadow_condition%& is unset, or its expansion does not result in the empty
22483 string or one of the strings &"0"& or &"no"& or &"false"&, the message is also
22484 passed to the shadow transport, with the same delivery address or addresses. If
22485 expansion fails, no action is taken except that non-forced expansion failures
22486 cause a log line to be written.
22487
22488 The result of the shadow transport is discarded and does not affect the
22489 subsequent processing of the message. Only a single level of shadowing is
22490 provided; the &%shadow_transport%& option is ignored on any transport when it
22491 is running as a shadow. Options concerned with output from pipes are also
22492 ignored. The log line for the successful delivery has an item added on the end,
22493 of the form
22494 .code
22495 ST=<shadow transport name>
22496 .endd
22497 If the shadow transport did not succeed, the error message is put in
22498 parentheses afterwards. Shadow transports can be used for a number of different
22499 purposes, including keeping more detailed log information than Exim normally
22500 provides, and implementing automatic acknowledgment policies based on message
22501 headers that some sites insist on.
22502
22503
22504 .option transport_filter transports string&!! unset
22505 .cindex "transport" "filter"
22506 .cindex "filter" "transport filter"
22507 This option sets up a filtering (in the Unix shell sense) process for messages
22508 at transport time. It should not be confused with mail filtering as set up by
22509 individual users or via a system filter.
22510 If unset, or expanding to an empty string, no filtering is done.
22511
22512 When the message is about to be written out, the command specified by
22513 &%transport_filter%& is started up in a separate, parallel process, and
22514 the entire message, including the header lines, is passed to it on its standard
22515 input (this in fact is done from a third process, to avoid deadlock). The
22516 command must be specified as an absolute path.
22517
22518 The lines of the message that are written to the transport filter are
22519 terminated by newline (&"\n"&). The message is passed to the filter before any
22520 SMTP-specific processing, such as turning &"\n"& into &"\r\n"& and escaping
22521 lines beginning with a dot, and also before any processing implied by the
22522 settings of &%check_string%& and &%escape_string%& in the &(appendfile)& or
22523 &(pipe)& transports.
22524
22525 The standard error for the filter process is set to the same destination as its
22526 standard output; this is read and written to the message's ultimate
22527 destination. The process that writes the message to the filter, the
22528 filter itself, and the original process that reads the result and delivers it
22529 are all run in parallel, like a shell pipeline.
22530
22531 The filter can perform any transformations it likes, but of course should take
22532 care not to break RFC 2822 syntax. Exim does not check the result, except to
22533 test for a final newline when SMTP is in use. All messages transmitted over
22534 SMTP must end with a newline, so Exim supplies one if it is missing.
22535
22536 .cindex "content scanning" "per user"
22537 A transport filter can be used to provide content-scanning on a per-user basis
22538 at delivery time if the only required effect of the scan is to modify the
22539 message. For example, a content scan could insert a new header line containing
22540 a spam score. This could be interpreted by a filter in the user's MUA. It is
22541 not possible to discard a message at this stage.
22542
22543 .cindex "SIZE" "ESMTP extension"
22544 A problem might arise if the filter increases the size of a message that is
22545 being sent down an SMTP connection. If the receiving SMTP server has indicated
22546 support for the SIZE parameter, Exim will have sent the size of the message
22547 at the start of the SMTP session. If what is actually sent is substantially
22548 more, the server might reject the message. This can be worked round by setting
22549 the &%size_addition%& option on the &(smtp)& transport, either to allow for
22550 additions to the message, or to disable the use of SIZE altogether.
22551
22552 .vindex "&$pipe_addresses$&"
22553 The value of the &%transport_filter%& option is the command string for starting
22554 the filter, which is run directly from Exim, not under a shell. The string is
22555 parsed by Exim in the same way as a command string for the &(pipe)& transport:
22556 Exim breaks it up into arguments and then expands each argument separately (see
22557 section &<<SECThowcommandrun>>&). Any kind of expansion failure causes delivery
22558 to be deferred. The special argument &$pipe_addresses$& is replaced by a number
22559 of arguments, one for each address that applies to this delivery. (This isn't
22560 an ideal name for this feature here, but as it was already implemented for the
22561 &(pipe)& transport, it seemed sensible not to change it.)
22562
22563 .vindex "&$host$&"
22564 .vindex "&$host_address$&"
22565 The expansion variables &$host$& and &$host_address$& are available when the
22566 transport is a remote one. They contain the name and IP address of the host to
22567 which the message is being sent. For example:
22568 .code
22569 transport_filter = /some/directory/transport-filter.pl \
22570   $host $host_address $sender_address $pipe_addresses
22571 .endd
22572
22573 Two problems arise if you want to use more complicated expansion items to
22574 generate transport filter commands, both of which due to the fact that the
22575 command is split up &'before'& expansion.
22576 .ilist
22577 If an expansion item contains white space, you must quote it, so that it is all
22578 part of the same command item. If the entire option setting is one such
22579 expansion item, you have to take care what kind of quoting you use. For
22580 example:
22581 .code
22582 transport_filter = '/bin/cmd${if eq{$host}{a.b.c}{1}{2}}'
22583 .endd
22584 This runs the command &(/bin/cmd1)& if the host name is &'a.b.c'&, and
22585 &(/bin/cmd2)& otherwise. If double quotes had been used, they would have been
22586 stripped by Exim when it read the option's value. When the value is used, if
22587 the single quotes were missing, the line would be split into two items,
22588 &`/bin/cmd${if`& and &`eq{$host}{a.b.c}{1}{2}`&, and an error would occur when
22589 Exim tried to expand the first one.
22590 .next
22591 Except for the special case of &$pipe_addresses$& that is mentioned above, an
22592 expansion cannot generate multiple arguments, or a command name followed by
22593 arguments. Consider this example:
22594 .code
22595 transport_filter = ${lookup{$host}lsearch{/a/file}\
22596                     {$value}{/bin/cat}}
22597 .endd
22598 The result of the lookup is interpreted as the name of the command, even
22599 if it contains white space. The simplest way round this is to use a shell:
22600 .code
22601 transport_filter = /bin/sh -c ${lookup{$host}lsearch{/a/file}\
22602                                {$value}{/bin/cat}}
22603 .endd
22604 .endlist
22605
22606 The filter process is run under the same uid and gid as the normal delivery.
22607 For remote deliveries this is the Exim uid/gid by default. The command should
22608 normally yield a zero return code. Transport filters are not supposed to fail.
22609 A non-zero code is taken to mean that the transport filter encountered some
22610 serious problem. Delivery of the message is deferred; the message remains on
22611 the queue and is tried again later. It is not possible to cause a message to be
22612 bounced from a transport filter.
22613
22614 If a transport filter is set on an autoreply transport, the original message is
22615 passed through the filter as it is being copied into the newly generated
22616 message, which happens if the &%return_message%& option is set.
22617
22618
22619 .option transport_filter_timeout transports time 5m
22620 .cindex "transport" "filter, timeout"
22621 When Exim is reading the output of a transport filter, it applies a timeout
22622 that can be set by this option. Exceeding the timeout is normally treated as a
22623 temporary delivery failure. However, if a transport filter is used with a
22624 &(pipe)& transport, a timeout in the transport filter is treated in the same
22625 way as a timeout in the pipe command itself. By default, a timeout is a hard
22626 error, but if the &(pipe)& transport's &%timeout_defer%& option is set true, it
22627 becomes a temporary error.
22628
22629
22630 .option user transports string&!! "Exim user"
22631 .cindex "uid (user id)" "local delivery"
22632 .cindex "transport" "user, specifying"
22633 This option specifies the user under whose uid the delivery process is to be
22634 run, overriding any uid that may have been set by the router. If the user is
22635 given as a name, the uid is looked up from the password data, and the
22636 associated group is taken as the value of the gid to be used if the &%group%&
22637 option is not set.
22638
22639 For deliveries that use local transports, a user and group are normally
22640 specified explicitly or implicitly (for example, as a result of
22641 &%check_local_user%&) by the router or transport.
22642
22643 .cindex "hints database" "access by remote transport"
22644 For remote transports, you should leave this option unset unless you really are
22645 sure you know what you are doing. When a remote transport is running, it needs
22646 to be able to access Exim's hints databases, because each host may have its own
22647 retry data.
22648 .ecindex IIDgenoptra1
22649 .ecindex IIDgenoptra2
22650 .ecindex IIDgenoptra3
22651
22652
22653
22654
22655
22656
22657 . ////////////////////////////////////////////////////////////////////////////
22658 . ////////////////////////////////////////////////////////////////////////////
22659
22660 .chapter "Address batching in local transports" "CHAPbatching" &&&
22661          "Address batching"
22662 .cindex "transport" "local; address batching in"
22663 The only remote transport (&(smtp)&) is normally configured to handle more than
22664 one address at a time, so that when several addresses are routed to the same
22665 remote host, just one copy of the message is sent. Local transports, however,
22666 normally handle one address at a time. That is, a separate instance of the
22667 transport is run for each address that is routed to the transport. A separate
22668 copy of the message is delivered each time.
22669
22670 .cindex "batched local delivery"
22671 .oindex "&%batch_max%&"
22672 .oindex "&%batch_id%&"
22673 In special cases, it may be desirable to handle several addresses at once in a
22674 local transport, for example:
22675
22676 .ilist
22677 In an &(appendfile)& transport, when storing messages in files for later
22678 delivery by some other means, a single copy of the message with multiple
22679 recipients saves space.
22680 .next
22681 In an &(lmtp)& transport, when delivering over &"local SMTP"& to some process,
22682 a single copy saves time, and is the normal way LMTP is expected to work.
22683 .next
22684 In a &(pipe)& transport, when passing the message
22685 to a scanner program or
22686 to some other delivery mechanism such as UUCP, multiple recipients may be
22687 acceptable.
22688 .endlist
22689
22690 These three local transports all have the same options for controlling multiple
22691 (&"batched"&) deliveries, namely &%batch_max%& and &%batch_id%&. To save
22692 repeating the information for each transport, these options are described here.
22693
22694 The &%batch_max%& option specifies the maximum number of addresses that can be
22695 delivered together in a single run of the transport. Its default value is one
22696 (no batching). When more than one address is routed to a transport that has a
22697 &%batch_max%& value greater than one, the addresses are delivered in a batch
22698 (that is, in a single run of the transport with multiple recipients), subject
22699 to certain conditions:
22700
22701 .ilist
22702 .vindex "&$local_part$&"
22703 If any of the transport's options contain a reference to &$local_part$&, no
22704 batching is possible.
22705 .next
22706 .vindex "&$domain$&"
22707 If any of the transport's options contain a reference to &$domain$&, only
22708 addresses with the same domain are batched.
22709 .next
22710 .cindex "customizing" "batching condition"
22711 If &%batch_id%& is set, it is expanded for each address, and only those
22712 addresses with the same expanded value are batched. This allows you to specify
22713 customized batching conditions. Failure of the expansion for any reason,
22714 including forced failure, disables batching, but it does not stop the delivery
22715 from taking place.
22716 .next
22717 Batched addresses must also have the same errors address (where to send
22718 delivery errors), the same header additions and removals, the same user and
22719 group for the transport, and if a host list is present, the first host must
22720 be the same.
22721 .endlist
22722
22723 In the case of the &(appendfile)& and &(pipe)& transports, batching applies
22724 both when the file or pipe command is specified in the transport, and when it
22725 is specified by a &(redirect)& router, but all the batched addresses must of
22726 course be routed to the same file or pipe command. These two transports have an
22727 option called &%use_bsmtp%&, which causes them to deliver the message in
22728 &"batched SMTP"& format, with the envelope represented as SMTP commands. The
22729 &%check_string%& and &%escape_string%& options are forced to the values
22730 .code
22731 check_string = "."
22732 escape_string = ".."
22733 .endd
22734 when batched SMTP is in use. A full description of the batch SMTP mechanism is
22735 given in section &<<SECTbatchSMTP>>&. The &(lmtp)& transport does not have a
22736 &%use_bsmtp%& option, because it always delivers using the SMTP protocol.
22737
22738 .cindex "&'Envelope-to:'& header line"
22739 If the generic &%envelope_to_add%& option is set for a batching transport, the
22740 &'Envelope-to:'& header that is added to the message contains all the addresses
22741 that are being processed together. If you are using a batching &(appendfile)&
22742 transport without &%use_bsmtp%&, the only way to preserve the recipient
22743 addresses is to set the &%envelope_to_add%& option.
22744
22745 .cindex "&(pipe)& transport" "with multiple addresses"
22746 .vindex "&$pipe_addresses$&"
22747 If you are using a &(pipe)& transport without BSMTP, and setting the
22748 transport's &%command%& option, you can include &$pipe_addresses$& as part of
22749 the command. This is not a true variable; it is a bit of magic that causes each
22750 of the recipient addresses to be inserted into the command as a separate
22751 argument. This provides a way of accessing all the addresses that are being
22752 delivered in the batch. &*Note:*& This is not possible for pipe commands that
22753 are specified by a &(redirect)& router.
22754
22755
22756
22757
22758 . ////////////////////////////////////////////////////////////////////////////
22759 . ////////////////////////////////////////////////////////////////////////////
22760
22761 .chapter "The appendfile transport" "CHAPappendfile"
22762 .scindex IIDapptra1 "&(appendfile)& transport"
22763 .scindex IIDapptra2 "transports" "&(appendfile)&"
22764 .cindex "directory creation"
22765 .cindex "creating directories"
22766 The &(appendfile)& transport delivers a message by appending it to an existing
22767 file, or by creating an entirely new file in a specified directory. Single
22768 files to which messages are appended can be in the traditional Unix mailbox
22769 format, or optionally in the MBX format supported by the Pine MUA and
22770 University of Washington IMAP daemon, &'inter alia'&. When each message is
22771 being delivered as a separate file, &"maildir"& format can optionally be used
22772 to give added protection against failures that happen part-way through the
22773 delivery. A third form of separate-file delivery known as &"mailstore"& is also
22774 supported. For all file formats, Exim attempts to create as many levels of
22775 directory as necessary, provided that &%create_directory%& is set.
22776
22777 The code for the optional formats is not included in the Exim binary by
22778 default. It is necessary to set SUPPORT_MBX, SUPPORT_MAILDIR and/or
22779 SUPPORT_MAILSTORE in &_Local/Makefile_& to have the appropriate code
22780 included.
22781
22782 .cindex "quota" "system"
22783 Exim recognizes system quota errors, and generates an appropriate message. Exim
22784 also supports its own quota control within the transport, for use when the
22785 system facility is unavailable or cannot be used for some reason.
22786
22787 If there is an error while appending to a file (for example, quota exceeded or
22788 partition filled), Exim attempts to reset the file's length and last
22789 modification time back to what they were before. If there is an error while
22790 creating an entirely new file, the new file is removed.
22791
22792 Before appending to a file, a number of security checks are made, and the
22793 file is locked. A detailed description is given below, after the list of
22794 private options.
22795
22796 The &(appendfile)& transport is most commonly used for local deliveries to
22797 users' mailboxes. However, it can also be used as a pseudo-remote transport for
22798 putting messages into files for remote delivery by some means other than Exim.
22799 &"Batch SMTP"& format is often used in this case (see the &%use_bsmtp%&
22800 option).
22801
22802
22803
22804 .section "The file and directory options" "SECTfildiropt"
22805 The &%file%& option specifies a single file, to which the message is appended;
22806 the &%directory%& option specifies a directory, in which a new file containing
22807 the message is created. Only one of these two options can be set, and for
22808 normal deliveries to mailboxes, one of them &'must'& be set.
22809
22810 .vindex "&$address_file$&"
22811 .vindex "&$local_part$&"
22812 However, &(appendfile)& is also used for delivering messages to files or
22813 directories whose names (or parts of names) are obtained from alias,
22814 forwarding, or filtering operations (for example, a &%save%& command in a
22815 user's Exim filter). When such a transport is running, &$local_part$& contains
22816 the local part that was aliased or forwarded, and &$address_file$& contains the
22817 name (or partial name) of the file or directory generated by the redirection
22818 operation. There are two cases:
22819
22820 .ilist
22821 If neither &%file%& nor &%directory%& is set, the redirection operation
22822 must specify an absolute path (one that begins with &`/`&). This is the most
22823 common case when users with local accounts use filtering to sort mail into
22824 different folders. See for example, the &(address_file)& transport in the
22825 default configuration. If the path ends with a slash, it is assumed to be the
22826 name of a directory. A delivery to a directory can also be forced by setting
22827 &%maildir_format%& or &%mailstore_format%&.
22828 .next
22829 If &%file%& or &%directory%& is set for a delivery from a redirection, it is
22830 used to determine the file or directory name for the delivery. Normally, the
22831 contents of &$address_file$& are used in some way in the string expansion.
22832 .endlist
22833 .cindex "tainted data" "in filenames"
22834 .cindex appendfile "tainted data"
22835 Tainted data may not be used for a file or directory name.
22836 This means that, for instance, &$local_part$& cannot be used directly
22837 as a component of a path.  It can however be used as the key for a lookup
22838 which returns a path (or component).
22839
22840
22841 .cindex "Sieve filter" "configuring &(appendfile)&"
22842 .cindex "Sieve filter" "relative mailbox path handling"
22843 As an example of the second case, consider an environment where users do not
22844 have home directories. They may be permitted to use Exim filter commands of the
22845 form:
22846 .code
22847 save folder23
22848 .endd
22849 or Sieve filter commands of the form:
22850 .code
22851 require "fileinto";
22852 fileinto "folder23";
22853 .endd
22854 In this situation, the expansion of &%file%& or &%directory%& in the transport
22855 must transform the relative path into an appropriate absolute filename. In the
22856 case of Sieve filters, the name &'inbox'& must be handled. It is the name that
22857 is used as a result of a &"keep"& action in the filter. This example shows one
22858 way of handling this requirement:
22859 .code
22860 file = ${if eq{$address_file}{inbox} \
22861             {/var/mail/$local_part_data} \
22862             {${if eq{${substr_0_1:$address_file}}{/} \
22863                   {$address_file} \
22864                   {$home/mail/$address_file} \
22865             }} \
22866        }
22867 .endd
22868 With this setting of &%file%&, &'inbox'& refers to the standard mailbox
22869 location, absolute paths are used without change, and other folders are in the
22870 &_mail_& directory within the home directory.
22871
22872 &*Note 1*&: While processing an Exim filter, a relative path such as
22873 &_folder23_& is turned into an absolute path if a home directory is known to
22874 the router. In particular, this is the case if &%check_local_user%& is set. If
22875 you want to prevent this happening at routing time, you can set
22876 &%router_home_directory%& empty. This forces the router to pass the relative
22877 path to the transport.
22878
22879 &*Note 2*&: An absolute path in &$address_file$& is not treated specially;
22880 the &%file%& or &%directory%& option is still used if it is set.
22881
22882
22883
22884
22885 .section "Private options for appendfile" "SECID134"
22886 .cindex "options" "&(appendfile)& transport"
22887
22888
22889
22890 .option allow_fifo appendfile boolean false
22891 .cindex "fifo (named pipe)"
22892 .cindex "named pipe (fifo)"
22893 .cindex "pipe" "named (fifo)"
22894 Setting this option permits delivery to named pipes (FIFOs) as well as to
22895 regular files. If no process is reading the named pipe at delivery time, the
22896 delivery is deferred.
22897
22898
22899 .option allow_symlink appendfile boolean false
22900 .cindex "symbolic link" "to mailbox"
22901 .cindex "mailbox" "symbolic link"
22902 By default, &(appendfile)& will not deliver if the path name for the file is
22903 that of a symbolic link. Setting this option relaxes that constraint, but there
22904 are security issues involved in the use of symbolic links. Be sure you know
22905 what you are doing if you set this. Details of exactly what this option affects
22906 are included in the discussion which follows this list of options.
22907
22908
22909 .option batch_id appendfile string&!! unset
22910 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
22911 However, batching is automatically disabled for &(appendfile)& deliveries that
22912 happen as a result of forwarding or aliasing or other redirection directly to a
22913 file.
22914
22915
22916 .option batch_max appendfile integer 1
22917 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
22918
22919
22920 .option check_group appendfile boolean false
22921 When this option is set, the group owner of the file defined by the &%file%&
22922 option is checked to see that it is the same as the group under which the
22923 delivery process is running. The default setting is false because the default
22924 file mode is 0600, which means that the group is irrelevant.
22925
22926
22927 .option check_owner appendfile boolean true
22928 When this option is set, the owner of the file defined by the &%file%& option
22929 is checked to ensure that it is the same as the user under which the delivery
22930 process is running.
22931
22932
22933 .option check_string appendfile string "see below"
22934 .cindex "&""From""& line"
22935 As &(appendfile)& writes the message, the start of each line is tested for
22936 matching &%check_string%&, and if it does, the initial matching characters are
22937 replaced by the contents of &%escape_string%&. The value of &%check_string%& is
22938 a literal string, not a regular expression, and the case of any letters it
22939 contains is significant.
22940
22941 If &%use_bsmtp%& is set the values of &%check_string%& and &%escape_string%&
22942 are forced to &"."& and &".."& respectively, and any settings in the
22943 configuration are ignored. Otherwise, they default to &"From&~"& and
22944 &">From&~"& when the &%file%& option is set, and unset when any of the
22945 &%directory%&, &%maildir%&, or &%mailstore%& options are set.
22946
22947 The default settings, along with &%message_prefix%& and &%message_suffix%&, are
22948 suitable for traditional &"BSD"& mailboxes, where a line beginning with
22949 &"From&~"& indicates the start of a new message. All four options need changing
22950 if another format is used. For example, to deliver to mailboxes in MMDF format:
22951 .cindex "MMDF format mailbox"
22952 .cindex "mailbox" "MMDF format"
22953 .code
22954 check_string = "\1\1\1\1\n"
22955 escape_string = "\1\1\1\1 \n"
22956 message_prefix = "\1\1\1\1\n"
22957 message_suffix = "\1\1\1\1\n"
22958 .endd
22959 .option create_directory appendfile boolean true
22960 .cindex "directory creation"
22961 When this option is true, Exim attempts to create any missing superior
22962 directories for the file that it is about to write. A created directory's mode
22963 is given by the &%directory_mode%& option.
22964
22965 The group ownership of a newly created directory is highly dependent on the
22966 operating system (and possibly the file system) that is being used. For
22967 example, in Solaris, if the parent directory has the setgid bit set, its group
22968 is propagated to the child; if not, the currently set group is used. However,
22969 in FreeBSD, the parent's group is always used.
22970
22971
22972
22973 .option create_file appendfile string anywhere
22974 This option constrains the location of files and directories that are created
22975 by this transport. It applies to files defined by the &%file%& option and
22976 directories defined by the &%directory%& option. In the case of maildir
22977 delivery, it applies to the top level directory, not the maildir directories
22978 beneath.
22979
22980 The option must be set to one of the words &"anywhere"&, &"inhome"&, or
22981 &"belowhome"&. In the second and third cases, a home directory must have been
22982 set for the transport. This option is not useful when an explicit filename is
22983 given for normal mailbox deliveries. It is intended for the case when filenames
22984 are generated from users' &_.forward_& files. These are usually handled
22985 by an &(appendfile)& transport called &%address_file%&. See also
22986 &%file_must_exist%&.
22987
22988
22989 .option directory appendfile string&!! unset
22990 This option is mutually exclusive with the &%file%& option, but one of &%file%&
22991 or &%directory%& must be set, unless the delivery is the direct result of a
22992 redirection (see section &<<SECTfildiropt>>&).
22993
22994 When &%directory%& is set, the string is expanded, and the message is delivered
22995 into a new file or files in or below the given directory, instead of being
22996 appended to a single mailbox file. A number of different formats are provided
22997 (see &%maildir_format%& and &%mailstore_format%&), and see section
22998 &<<SECTopdir>>& for further details of this form of delivery.
22999
23000
23001 .option directory_file appendfile string&!! "see below"
23002 .cindex "base62"
23003 .vindex "&$inode$&"
23004 When &%directory%& is set, but neither &%maildir_format%& nor
23005 &%mailstore_format%& is set, &(appendfile)& delivers each message into a file
23006 whose name is obtained by expanding this string. The default value is:
23007 .code
23008 q${base62:$tod_epoch}-$inode
23009 .endd
23010 This generates a unique name from the current time, in base 62 form, and the
23011 inode of the file. The variable &$inode$& is available only when expanding this
23012 option.
23013
23014
23015 .option directory_mode appendfile "octal integer" 0700
23016 If &(appendfile)& creates any directories as a result of the
23017 &%create_directory%& option, their mode is specified by this option.
23018
23019
23020 .option escape_string appendfile string "see description"
23021 See &%check_string%& above.
23022
23023
23024 .option file appendfile string&!! unset
23025 This option is mutually exclusive with the &%directory%& option, but one of
23026 &%file%& or &%directory%& must be set, unless the delivery is the direct result
23027 of a redirection (see section &<<SECTfildiropt>>&). The &%file%& option
23028 specifies a single file, to which the message is appended. One or more of
23029 &%use_fcntl_lock%&, &%use_flock_lock%&, or &%use_lockfile%& must be set with
23030 &%file%&.
23031
23032 .cindex "NFS" "lock file"
23033 .cindex "locking files"
23034 .cindex "lock files"
23035 If you are using more than one host to deliver over NFS into the same
23036 mailboxes, you should always use lock files.
23037
23038 The string value is expanded for each delivery, and must yield an absolute
23039 path. The most common settings of this option are variations on one of these
23040 examples:
23041 .code
23042 file = /var/spool/mail/$local_part_data
23043 file = /home/$local_part_data/inbox
23044 file = $home/inbox
23045 .endd
23046 .cindex "&""sticky""& bit"
23047 In the first example, all deliveries are done into the same directory. If Exim
23048 is configured to use lock files (see &%use_lockfile%& below) it must be able to
23049 create a file in the directory, so the &"sticky"& bit must be turned on for
23050 deliveries to be possible, or alternatively the &%group%& option can be used to
23051 run the delivery under a group id which has write access to the directory.
23052
23053
23054
23055 .option file_format appendfile string unset
23056 .cindex "file" "mailbox; checking existing format"
23057 This option requests the transport to check the format of an existing file
23058 before adding to it. The check consists of matching a specific string at the
23059 start of the file. The value of the option consists of an even number of
23060 colon-separated strings. The first of each pair is the test string, and the
23061 second is the name of a transport. If the transport associated with a matched
23062 string is not the current transport, control is passed over to the other
23063 transport. For example, suppose the standard &(local_delivery)& transport has
23064 this added to it:
23065 .code
23066 file_format = "From       : local_delivery :\
23067                \1\1\1\1\n : local_mmdf_delivery"
23068 .endd
23069 Mailboxes that begin with &"From"& are still handled by this transport, but if
23070 a mailbox begins with four binary ones followed by a newline, control is passed
23071 to a transport called &%local_mmdf_delivery%&, which presumably is configured
23072 to do the delivery in MMDF format. If a mailbox does not exist or is empty, it
23073 is assumed to match the current transport. If the start of a mailbox doesn't
23074 match any string, or if the transport named for a given string is not defined,
23075 delivery is deferred.
23076
23077
23078 .option file_must_exist appendfile boolean false
23079 If this option is true, the file specified by the &%file%& option must exist.
23080 A temporary error occurs if it does not, causing delivery to be deferred.
23081 If this option is false, the file is created if it does not exist.
23082
23083
23084 .option lock_fcntl_timeout appendfile time 0s
23085 .cindex "timeout" "mailbox locking"
23086 .cindex "mailbox" "locking, blocking and non-blocking"
23087 .cindex "locking files"
23088 By default, the &(appendfile)& transport uses non-blocking calls to &[fcntl()]&
23089 when locking an open mailbox file. If the call fails, the delivery process
23090 sleeps for &%lock_interval%& and tries again, up to &%lock_retries%& times.
23091 Non-blocking calls are used so that the file is not kept open during the wait
23092 for the lock; the reason for this is to make it as safe as possible for
23093 deliveries over NFS in the case when processes might be accessing an NFS
23094 mailbox without using a lock file. This should not be done, but
23095 misunderstandings and hence misconfigurations are not unknown.
23096
23097 On a busy system, however, the performance of a non-blocking lock approach is
23098 not as good as using a blocking lock with a timeout. In this case, the waiting
23099 is done inside the system call, and Exim's delivery process acquires the lock
23100 and can proceed as soon as the previous lock holder releases it.
23101
23102 If &%lock_fcntl_timeout%& is set to a non-zero time, blocking locks, with that
23103 timeout, are used. There may still be some retrying: the maximum number of
23104 retries is
23105 .code
23106 (lock_retries * lock_interval) / lock_fcntl_timeout
23107 .endd
23108 rounded up to the next whole number. In other words, the total time during
23109 which &(appendfile)& is trying to get a lock is roughly the same, unless
23110 &%lock_fcntl_timeout%& is set very large.
23111
23112 You should consider setting this option if you are getting a lot of delayed
23113 local deliveries because of errors of the form
23114 .code
23115 failed to lock mailbox /some/file (fcntl)
23116 .endd
23117
23118 .option lock_flock_timeout appendfile time 0s
23119 This timeout applies to file locking when using &[flock()]& (see
23120 &%use_flock%&); the timeout operates in a similar manner to
23121 &%lock_fcntl_timeout%&.
23122
23123
23124 .option lock_interval appendfile time 3s
23125 This specifies the time to wait between attempts to lock the file. See below
23126 for details of locking.
23127
23128
23129 .option lock_retries appendfile integer 10
23130 This specifies the maximum number of attempts to lock the file. A value of zero
23131 is treated as 1. See below for details of locking.
23132
23133
23134 .option lockfile_mode appendfile "octal integer" 0600
23135 This specifies the mode of the created lock file, when a lock file is being
23136 used (see &%use_lockfile%& and &%use_mbx_lock%&).
23137
23138
23139 .option lockfile_timeout appendfile time 30m
23140 .cindex "timeout" "mailbox locking"
23141 When a lock file is being used (see &%use_lockfile%&), if a lock file already
23142 exists and is older than this value, it is assumed to have been left behind by
23143 accident, and Exim attempts to remove it.
23144
23145
23146 .option mailbox_filecount appendfile string&!! unset
23147 .cindex "mailbox" "specifying size of"
23148 .cindex "size" "of mailbox"
23149 If this option is set, it is expanded, and the result is taken as the current
23150 number of files in the mailbox. It must be a decimal number, optionally
23151 followed by K or M. This provides a way of obtaining this information from an
23152 external source that maintains the data.
23153
23154
23155 .option mailbox_size appendfile string&!! unset
23156 .cindex "mailbox" "specifying size of"
23157 .cindex "size" "of mailbox"
23158 If this option is set, it is expanded, and the result is taken as the current
23159 size the mailbox. It must be a decimal number, optionally followed by K or M.
23160 This provides a way of obtaining this information from an external source that
23161 maintains the data. This is likely to be helpful for maildir deliveries where
23162 it is computationally expensive to compute the size of a mailbox.
23163
23164
23165
23166 .option maildir_format appendfile boolean false
23167 .cindex "maildir format" "specifying"
23168 If this option is set with the &%directory%& option, the delivery is into a new
23169 file, in the &"maildir"& format that is used by other mail software. When the
23170 transport is activated directly from a &(redirect)& router (for example, the
23171 &(address_file)& transport in the default configuration), setting
23172 &%maildir_format%& causes the path received from the router to be treated as a
23173 directory, whether or not it ends with &`/`&. This option is available only if
23174 SUPPORT_MAILDIR is present in &_Local/Makefile_&. See section
23175 &<<SECTmaildirdelivery>>& below for further details.
23176
23177
23178 .option maildir_quota_directory_regex appendfile string "See below"
23179 .cindex "maildir format" "quota; directories included in"
23180 .cindex "quota" "maildir; directories included in"
23181 This option is relevant only when &%maildir_use_size_file%& is set. It defines
23182 a regular expression for specifying directories, relative to the quota
23183 directory (see &%quota_directory%&), that should be included in the quota
23184 calculation. The default value is:
23185 .code
23186 maildir_quota_directory_regex = ^(?:cur|new|\..*)$
23187 .endd
23188 This includes the &_cur_& and &_new_& directories, and any maildir++ folders
23189 (directories whose names begin with a dot). If you want to exclude the
23190 &_Trash_&
23191 folder from the count (as some sites do), you need to change this setting to
23192 .code
23193 maildir_quota_directory_regex = ^(?:cur|new|\.(?!Trash).*)$
23194 .endd
23195 This uses a negative lookahead in the regular expression to exclude the
23196 directory whose name is &_.Trash_&. When a directory is excluded from quota
23197 calculations, quota processing is bypassed for any messages that are delivered
23198 directly into that directory.
23199
23200
23201 .option maildir_retries appendfile integer 10
23202 This option specifies the number of times to retry when writing a file in
23203 &"maildir"& format. See section &<<SECTmaildirdelivery>>& below.
23204
23205
23206 .option maildir_tag appendfile string&!! unset
23207 This option applies only to deliveries in maildir format, and is described in
23208 section &<<SECTmaildirdelivery>>& below.
23209
23210
23211 .option maildir_use_size_file appendfile&!! boolean false
23212 .cindex "maildir format" "&_maildirsize_& file"
23213 The result of string expansion for this option must be a valid boolean value.
23214 If it is true, it enables support for &_maildirsize_& files. Exim
23215 creates a &_maildirsize_& file in a maildir if one does not exist, taking the
23216 quota from the &%quota%& option of the transport. If &%quota%& is unset, the
23217 value is zero. See &%maildir_quota_directory_regex%& above and section
23218 &<<SECTmaildirdelivery>>& below for further details.
23219
23220 .option maildirfolder_create_regex appendfile string unset
23221 .cindex "maildir format" "&_maildirfolder_& file"
23222 .cindex "&_maildirfolder_&, creating"
23223 The value of this option is a regular expression. If it is unset, it has no
23224 effect. Otherwise, before a maildir delivery takes place, the pattern is
23225 matched against the name of the maildir directory, that is, the directory
23226 containing the &_new_& and &_tmp_& subdirectories that will be used for the
23227 delivery. If there is a match, Exim checks for the existence of a file called
23228 &_maildirfolder_& in the directory, and creates it if it does not exist.
23229 See section &<<SECTmaildirdelivery>>& for more details.
23230
23231
23232 .option mailstore_format appendfile boolean false
23233 .cindex "mailstore format" "specifying"
23234 If this option is set with the &%directory%& option, the delivery is into two
23235 new files in  &"mailstore"& format. The option is available only if
23236 SUPPORT_MAILSTORE is present in &_Local/Makefile_&. See section &<<SECTopdir>>&
23237 below for further details.
23238
23239
23240 .option mailstore_prefix appendfile string&!! unset
23241 This option applies only to deliveries in mailstore format, and is described in
23242 section &<<SECTopdir>>& below.
23243
23244
23245 .option mailstore_suffix appendfile string&!! unset
23246 This option applies only to deliveries in mailstore format, and is described in
23247 section &<<SECTopdir>>& below.
23248
23249
23250 .option mbx_format appendfile boolean false
23251 .cindex "locking files"
23252 .cindex "file" "locking"
23253 .cindex "file" "MBX format"
23254 .cindex "MBX format, specifying"
23255 This option is available only if Exim has been compiled with SUPPORT_MBX
23256 set in &_Local/Makefile_&. If &%mbx_format%& is set with the &%file%& option,
23257 the message is appended to the mailbox file in MBX format instead of
23258 traditional Unix format. This format is supported by Pine4 and its associated
23259 IMAP and POP daemons, by means of the &'c-client'& library that they all use.
23260
23261 &*Note*&: The &%message_prefix%& and &%message_suffix%& options are not
23262 automatically changed by the use of &%mbx_format%&. They should normally be set
23263 empty when using MBX format, so this option almost always appears in this
23264 combination:
23265 .code
23266 mbx_format = true
23267 message_prefix =
23268 message_suffix =
23269 .endd
23270 If none of the locking options are mentioned in the configuration,
23271 &%use_mbx_lock%& is assumed and the other locking options default to false. It
23272 is possible to specify the other kinds of locking with &%mbx_format%&, but
23273 &%use_fcntl_lock%& and &%use_mbx_lock%& are mutually exclusive. MBX locking
23274 interworks with &'c-client'&, providing for shared access to the mailbox. It
23275 should not be used if any program that does not use this form of locking is
23276 going to access the mailbox, nor should it be used if the mailbox file is NFS
23277 mounted, because it works only when the mailbox is accessed from a single host.
23278
23279 If you set &%use_fcntl_lock%& with an MBX-format mailbox, you cannot use
23280 the standard version of &'c-client'&, because as long as it has a mailbox open
23281 (this means for the whole of a Pine or IMAP session), Exim will not be able to
23282 append messages to it.
23283
23284
23285 .option message_prefix appendfile string&!! "see below"
23286 .cindex "&""From""& line"
23287 The string specified here is expanded and output at the start of every message.
23288 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
23289 in which case it is:
23290 .code
23291 message_prefix = "From ${if def:return_path{$return_path}\
23292   {MAILER-DAEMON}} $tod_bsdinbox\n"
23293 .endd
23294 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
23295 &`\n`& to &`\r\n`& in &%message_prefix%&.
23296
23297 .option message_suffix appendfile string&!! "see below"
23298 The string specified here is expanded and output at the end of every message.
23299 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
23300 in which case it is a single newline character. The suffix can be suppressed by
23301 setting
23302 .code
23303 message_suffix =
23304 .endd
23305 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
23306 &`\n`& to &`\r\n`& in &%message_suffix%&.
23307
23308 .option mode appendfile "octal integer" 0600
23309 If the output file is created, it is given this mode. If it already exists and
23310 has wider permissions, they are reduced to this mode. If it has narrower
23311 permissions, an error occurs unless &%mode_fail_narrower%& is false. However,
23312 if the delivery is the result of a &%save%& command in a filter file specifying
23313 a particular mode, the mode of the output file is always forced to take that
23314 value, and this option is ignored.
23315
23316
23317 .option mode_fail_narrower appendfile boolean true
23318 This option applies in the case when an existing mailbox file has a narrower
23319 mode than that specified by the &%mode%& option. If &%mode_fail_narrower%& is
23320 true, the delivery is deferred (&"mailbox has the wrong mode"&); otherwise Exim
23321 continues with the delivery attempt, using the existing mode of the file.
23322
23323
23324 .option notify_comsat appendfile boolean false
23325 If this option is true, the &'comsat'& daemon is notified after every
23326 successful delivery to a user mailbox. This is the daemon that notifies logged
23327 on users about incoming mail.
23328
23329
23330 .option quota appendfile string&!! unset
23331 .cindex "quota" "imposed by Exim"
23332 This option imposes a limit on the size of the file to which Exim is appending,
23333 or to the total space used in the directory tree when the &%directory%& option
23334 is set. In the latter case, computation of the space used is expensive, because
23335 all the files in the directory (and any sub-directories) have to be
23336 individually inspected and their sizes summed. (See &%quota_size_regex%& and
23337 &%maildir_use_size_file%& for ways to avoid this in environments where users
23338 have no shell access to their mailboxes).
23339
23340 As there is no interlock against two simultaneous deliveries into a
23341 multi-file mailbox, it is possible for the quota to be overrun in this case.
23342 For single-file mailboxes, of course, an interlock is a necessity.
23343
23344 A file's size is taken as its &'used'& value. Because of blocking effects, this
23345 may be a lot less than the actual amount of disk space allocated to the file.
23346 If the sizes of a number of files are being added up, the rounding effect can
23347 become quite noticeable, especially on systems that have large block sizes.
23348 Nevertheless, it seems best to stick to the &'used'& figure, because this is
23349 the obvious value which users understand most easily.
23350
23351 The value of the option is expanded, and must then be a numerical value
23352 (decimal point allowed), optionally followed by one of the letters K, M, or G,
23353 for kilobytes, megabytes, or gigabytes, optionally followed by a slash
23354 and further option modifiers. If Exim is running on a system with
23355 large file support (Linux and FreeBSD have this), mailboxes larger than 2G can
23356 be handled.
23357
23358 The option modifier &%no_check%& can be used to force delivery even if the over
23359 quota condition is met. The quota gets updated as usual.
23360
23361 &*Note*&: A value of zero is interpreted as &"no quota"&.
23362
23363 The expansion happens while Exim is running as root, before it changes uid for
23364 the delivery. This means that files that are inaccessible to the end user can
23365 be used to hold quota values that are looked up in the expansion. When delivery
23366 fails because this quota is exceeded, the handling of the error is as for
23367 system quota failures.
23368
23369 By default, Exim's quota checking mimics system quotas, and restricts the
23370 mailbox to the specified maximum size, though the value is not accurate to the
23371 last byte, owing to separator lines and additional headers that may get added
23372 during message delivery. When a mailbox is nearly full, large messages may get
23373 refused even though small ones are accepted, because the size of the current
23374 message is added to the quota when the check is made. This behaviour can be
23375 changed by setting &%quota_is_inclusive%& false. When this is done, the check
23376 for exceeding the quota does not include the current message. Thus, deliveries
23377 continue until the quota has been exceeded; thereafter, no further messages are
23378 delivered. See also &%quota_warn_threshold%&.
23379
23380
23381 .option quota_directory appendfile string&!! unset
23382 This option defines the directory to check for quota purposes when delivering
23383 into individual files. The default is the delivery directory, or, if a file
23384 called &_maildirfolder_& exists in a maildir directory, the parent of the
23385 delivery directory.
23386
23387
23388 .option quota_filecount appendfile string&!! 0
23389 This option applies when the &%directory%& option is set. It limits the total
23390 number of files in the directory (compare the inode limit in system quotas). It
23391 can only be used if &%quota%& is also set. The value is expanded; an expansion
23392 failure causes delivery to be deferred. A value of zero is interpreted as
23393 &"no quota"&.
23394
23395 The option modifier &%no_check%& can be used to force delivery even if the over
23396 quota condition is met. The quota gets updated as usual.
23397
23398 .option quota_is_inclusive appendfile boolean true
23399 See &%quota%& above.
23400
23401
23402 .option quota_size_regex appendfile string unset
23403 This option applies when one of the delivery modes that writes a separate file
23404 for each message is being used. When Exim wants to find the size of one of
23405 these files in order to test the quota, it first checks &%quota_size_regex%&.
23406 If this is set to a regular expression that matches the filename, and it
23407 captures one string, that string is interpreted as a representation of the
23408 file's size. The value of &%quota_size_regex%& is not expanded.
23409
23410 This feature is useful only when users have no shell access to their mailboxes
23411 &-- otherwise they could defeat the quota simply by renaming the files. This
23412 facility can be used with maildir deliveries, by setting &%maildir_tag%& to add
23413 the file length to the filename. For example:
23414 .code
23415 maildir_tag = ,S=$message_size
23416 quota_size_regex = ,S=(\d+)
23417 .endd
23418 An alternative to &$message_size$& is &$message_linecount$&, which contains the
23419 number of lines in the message.
23420
23421 The regular expression should not assume that the length is at the end of the
23422 filename (even though &%maildir_tag%& puts it there) because maildir MUAs
23423 sometimes add other information onto the ends of message filenames.
23424
23425 Section &<<SECID136>>& contains further information.
23426
23427 This option should not be used when other message-handling software
23428 may duplicate messages by making hardlinks to the files.  When that is done Exim
23429 will count the message size once for each filename, in contrast with the actual
23430 disk usage.  When the option is not set, calculating total usage requires
23431 a system-call per file to get the size; the number of links is then available also
23432 as is used to adjust the effective size.
23433
23434
23435 .option quota_warn_message appendfile string&!! "see below"
23436 See below for the use of this option. If it is not set when
23437 &%quota_warn_threshold%& is set, it defaults to
23438 .code
23439 quota_warn_message = "\
23440   To: $local_part@$domain\n\
23441   Subject: Your mailbox\n\n\
23442   This message is automatically created \
23443   by mail delivery software.\n\n\
23444   The size of your mailbox has exceeded \
23445   a warning threshold that is\n\
23446   set by the system administrator.\n"
23447 .endd
23448
23449
23450 .option quota_warn_threshold appendfile string&!! 0
23451 .cindex "quota" "warning threshold"
23452 .cindex "mailbox" "size warning"
23453 .cindex "size" "of mailbox"
23454 This option is expanded in the same way as &%quota%& (see above). If the
23455 resulting value is greater than zero, and delivery of the message causes the
23456 size of the file or total space in the directory tree to cross the given
23457 threshold, a warning message is sent. If &%quota%& is also set, the threshold
23458 may be specified as a percentage of it by following the value with a percent
23459 sign. For example:
23460 .code
23461 quota = 10M
23462 quota_warn_threshold = 75%
23463 .endd
23464 If &%quota%& is not set, a setting of &%quota_warn_threshold%& that ends with a
23465 percent sign is ignored.
23466
23467 The warning message itself is specified by the &%quota_warn_message%& option,
23468 and it must start with a &'To:'& header line containing the recipient(s) of the
23469 warning message. These do not necessarily have to include the recipient(s) of
23470 the original message. A &'Subject:'& line should also normally be supplied. You
23471 can include any other header lines that you want. If you do not include a
23472 &'From:'& line, the default is:
23473 .code
23474 From: Mail Delivery System <mailer-daemon@$qualify_domain_sender>
23475 .endd
23476 .oindex &%errors_reply_to%&
23477 If you supply a &'Reply-To:'& line, it overrides the global &%errors_reply_to%&
23478 option.
23479
23480 The &%quota%& option does not have to be set in order to use this option; they
23481 are independent of one another except when the threshold is specified as a
23482 percentage.
23483
23484
23485 .option use_bsmtp appendfile boolean false
23486 .cindex "envelope from"
23487 .cindex "envelope sender"
23488 If this option is set true, &(appendfile)& writes messages in &"batch SMTP"&
23489 format, with the envelope sender and recipient(s) included as SMTP commands. If
23490 you want to include a leading HELO command with such messages, you can do
23491 so by setting the &%message_prefix%& option. See section &<<SECTbatchSMTP>>&
23492 for details of batch SMTP.
23493
23494
23495 .option use_crlf appendfile boolean false
23496 .cindex "carriage return"
23497 .cindex "linefeed"
23498 This option causes lines to be terminated with the two-character CRLF sequence
23499 (carriage return, linefeed) instead of just a linefeed character. In the case
23500 of batched SMTP, the byte sequence written to the file is then an exact image
23501 of what would be sent down a real SMTP connection.
23502
23503 &*Note:*& The contents of the &%message_prefix%& and &%message_suffix%& options
23504 (which are used to supply the traditional &"From&~"& and blank line separators
23505 in Berkeley-style mailboxes) are written verbatim, so must contain their own
23506 carriage return characters if these are needed. In cases where these options
23507 have non-empty defaults, the values end with a single linefeed, so they must be
23508 changed to end with &`\r\n`& if &%use_crlf%& is set.
23509
23510
23511 .option use_fcntl_lock appendfile boolean "see below"
23512 This option controls the use of the &[fcntl()]& function to lock a file for
23513 exclusive use when a message is being appended. It is set by default unless
23514 &%use_flock_lock%& is set. Otherwise, it should be turned off only if you know
23515 that all your MUAs use lock file locking. When both &%use_fcntl_lock%& and
23516 &%use_flock_lock%& are unset, &%use_lockfile%& must be set.
23517
23518
23519 .option use_flock_lock appendfile boolean false
23520 This option is provided to support the use of &[flock()]& for file locking, for
23521 the few situations where it is needed. Most modern operating systems support
23522 &[fcntl()]& and &[lockf()]& locking, and these two functions interwork with
23523 each other. Exim uses &[fcntl()]& locking by default.
23524
23525 This option is required only if you are using an operating system where
23526 &[flock()]& is used by programs that access mailboxes (typically MUAs), and
23527 where &[flock()]& does not correctly interwork with &[fcntl()]&. You can use
23528 both &[fcntl()]& and &[flock()]& locking simultaneously if you want.
23529
23530 .cindex "Solaris" "&[flock()]& support"
23531 Not all operating systems provide &[flock()]&. Some versions of Solaris do not
23532 have it (and some, I think, provide a not quite right version built on top of
23533 &[lockf()]&). If the OS does not have &[flock()]&, Exim will be built without
23534 the ability to use it, and any attempt to do so will cause a configuration
23535 error.
23536
23537 &*Warning*&: &[flock()]& locks do not work on NFS files (unless &[flock()]&
23538 is just being mapped onto &[fcntl()]& by the OS).
23539
23540
23541 .option use_lockfile appendfile boolean "see below"
23542 If this option is turned off, Exim does not attempt to create a lock file when
23543 appending to a mailbox file. In this situation, the only locking is by
23544 &[fcntl()]&. You should only turn &%use_lockfile%& off if you are absolutely
23545 sure that every MUA that is ever going to look at your users' mailboxes uses
23546 &[fcntl()]& rather than a lock file, and even then only when you are not
23547 delivering over NFS from more than one host.
23548
23549 .cindex "NFS" "lock file"
23550 In order to append to an NFS file safely from more than one host, it is
23551 necessary to take out a lock &'before'& opening the file, and the lock file
23552 achieves this. Otherwise, even with &[fcntl()]& locking, there is a risk of
23553 file corruption.
23554
23555 The &%use_lockfile%& option is set by default unless &%use_mbx_lock%& is set.
23556 It is not possible to turn both &%use_lockfile%& and &%use_fcntl_lock%& off,
23557 except when &%mbx_format%& is set.
23558
23559
23560 .option use_mbx_lock appendfile boolean "see below"
23561 This option is available only if Exim has been compiled with SUPPORT_MBX
23562 set in &_Local/Makefile_&. Setting the option specifies that special MBX
23563 locking rules be used. It is set by default if &%mbx_format%& is set and none
23564 of the locking options are mentioned in the configuration. The locking rules
23565 are the same as are used by the &'c-client'& library that underlies Pine and
23566 the IMAP4 and POP daemons that come with it (see the discussion below). The
23567 rules allow for shared access to the mailbox. However, this kind of locking
23568 does not work when the mailbox is NFS mounted.
23569
23570 You can set &%use_mbx_lock%& with either (or both) of &%use_fcntl_lock%& and
23571 &%use_flock_lock%& to control what kind of locking is used in implementing the
23572 MBX locking rules. The default is to use &[fcntl()]& if &%use_mbx_lock%& is set
23573 without &%use_fcntl_lock%& or &%use_flock_lock%&.
23574
23575
23576
23577
23578 .section "Operational details for appending" "SECTopappend"
23579 .cindex "appending to a file"
23580 .cindex "file" "appending"
23581 Before appending to a file, the following preparations are made:
23582
23583 .ilist
23584 If the name of the file is &_/dev/null_&, no action is taken, and a success
23585 return is given.
23586
23587 .next
23588 .cindex "directory creation"
23589 If any directories on the file's path are missing, Exim creates them if the
23590 &%create_directory%& option is set. A created directory's mode is given by the
23591 &%directory_mode%& option.
23592
23593 .next
23594 If &%file_format%& is set, the format of an existing file is checked. If this
23595 indicates that a different transport should be used, control is passed to that
23596 transport.
23597
23598 .next
23599 .cindex "file" "locking"
23600 .cindex "locking files"
23601 .cindex "NFS" "lock file"
23602 If &%use_lockfile%& is set, a lock file is built in a way that will work
23603 reliably over NFS, as follows:
23604
23605 .olist
23606 Create a &"hitching post"& file whose name is that of the lock file with the
23607 current time, primary host name, and process id added, by opening for writing
23608 as a new file. If this fails with an access error, delivery is deferred.
23609 .next
23610 Close the hitching post file, and hard link it to the lock filename.
23611 .next
23612 If the call to &[link()]& succeeds, creation of the lock file has succeeded.
23613 Unlink the hitching post name.
23614 .next
23615 Otherwise, use &[stat()]& to get information about the hitching post file, and
23616 then unlink hitching post name. If the number of links is exactly two, creation
23617 of the lock file succeeded but something (for example, an NFS server crash and
23618 restart) caused this fact not to be communicated to the &[link()]& call.
23619 .next
23620 If creation of the lock file failed, wait for &%lock_interval%& and try again,
23621 up to &%lock_retries%& times. However, since any program that writes to a
23622 mailbox should complete its task very quickly, it is reasonable to time out old
23623 lock files that are normally the result of user agent and system crashes. If an
23624 existing lock file is older than &%lockfile_timeout%& Exim attempts to unlink
23625 it before trying again.
23626 .endlist olist
23627
23628 .next
23629 A call is made to &[lstat()]& to discover whether the main file exists, and if
23630 so, what its characteristics are. If &[lstat()]& fails for any reason other
23631 than non-existence, delivery is deferred.
23632
23633 .next
23634 .cindex "symbolic link" "to mailbox"
23635 .cindex "mailbox" "symbolic link"
23636 If the file does exist and is a symbolic link, delivery is deferred, unless the
23637 &%allow_symlink%& option is set, in which case the ownership of the link is
23638 checked, and then &[stat()]& is called to find out about the real file, which
23639 is then subjected to the checks below. The check on the top-level link
23640 ownership prevents one user creating a link for another's mailbox in a sticky
23641 directory, though allowing symbolic links in this case is definitely not a good
23642 idea. If there is a chain of symbolic links, the intermediate ones are not
23643 checked.
23644
23645 .next
23646 If the file already exists but is not a regular file, or if the file's owner
23647 and group (if the group is being checked &-- see &%check_group%& above) are
23648 different from the user and group under which the delivery is running,
23649 delivery is deferred.
23650
23651 .next
23652 If the file's permissions are more generous than specified, they are reduced.
23653 If they are insufficient, delivery is deferred, unless &%mode_fail_narrower%&
23654 is set false, in which case the delivery is tried using the existing
23655 permissions.
23656
23657 .next
23658 The file's inode number is saved, and the file is then opened for appending.
23659 If this fails because the file has vanished, &(appendfile)& behaves as if it
23660 hadn't existed (see below). For any other failures, delivery is deferred.
23661
23662 .next
23663 If the file is opened successfully, check that the inode number hasn't
23664 changed, that it is still a regular file, and that the owner and permissions
23665 have not changed. If anything is wrong, defer delivery and freeze the message.
23666
23667 .next
23668 If the file did not exist originally, defer delivery if the &%file_must_exist%&
23669 option is set. Otherwise, check that the file is being created in a permitted
23670 directory if the &%create_file%& option is set (deferring on failure), and then
23671 open for writing as a new file, with the O_EXCL and O_CREAT options,
23672 except when dealing with a symbolic link (the &%allow_symlink%& option must be
23673 set). In this case, which can happen if the link points to a non-existent file,
23674 the file is opened for writing using O_CREAT but not O_EXCL, because
23675 that prevents link following.
23676
23677 .next
23678 .cindex "loop" "while file testing"
23679 If opening fails because the file exists, obey the tests given above for
23680 existing files. However, to avoid looping in a situation where the file is
23681 being continuously created and destroyed, the exists/not-exists loop is broken
23682 after 10 repetitions, and the message is then frozen.
23683
23684 .next
23685 If opening fails with any other error, defer delivery.
23686
23687 .next
23688 .cindex "file" "locking"
23689 .cindex "locking files"
23690 Once the file is open, unless both &%use_fcntl_lock%& and &%use_flock_lock%&
23691 are false, it is locked using &[fcntl()]& or &[flock()]& or both. If
23692 &%use_mbx_lock%& is false, an exclusive lock is requested in each case.
23693 However, if &%use_mbx_lock%& is true, Exim takes out a shared lock on the open
23694 file, and an exclusive lock on the file whose name is
23695 .code
23696 /tmp/.<device-number>.<inode-number>
23697 .endd
23698 using the device and inode numbers of the open mailbox file, in accordance with
23699 the MBX locking rules. This file is created with a mode that is specified by
23700 the &%lockfile_mode%& option.
23701
23702 If Exim fails to lock the file, there are two possible courses of action,
23703 depending on the value of the locking timeout. This is obtained from
23704 &%lock_fcntl_timeout%& or &%lock_flock_timeout%&, as appropriate.
23705
23706 If the timeout value is zero, the file is closed, Exim waits for
23707 &%lock_interval%&, and then goes back and re-opens the file as above and tries
23708 to lock it again. This happens up to &%lock_retries%& times, after which the
23709 delivery is deferred.
23710
23711 If the timeout has a value greater than zero, blocking calls to &[fcntl()]& or
23712 &[flock()]& are used (with the given timeout), so there has already been some
23713 waiting involved by the time locking fails. Nevertheless, Exim does not give up
23714 immediately. It retries up to
23715 .code
23716 (lock_retries * lock_interval) / <timeout>
23717 .endd
23718 times (rounded up).
23719 .endlist
23720
23721 At the end of delivery, Exim closes the file (which releases the &[fcntl()]&
23722 and/or &[flock()]& locks) and then deletes the lock file if one was created.
23723
23724
23725 .section "Operational details for delivery to a new file" "SECTopdir"
23726 .cindex "delivery" "to single file"
23727 .cindex "&""From""& line"
23728 When the &%directory%& option is set instead of &%file%&, each message is
23729 delivered into a newly-created file or set of files. When &(appendfile)& is
23730 activated directly from a &(redirect)& router, neither &%file%& nor
23731 &%directory%& is normally set, because the path for delivery is supplied by the
23732 router. (See for example, the &(address_file)& transport in the default
23733 configuration.) In this case, delivery is to a new file if either the path name
23734 ends in &`/`&, or the &%maildir_format%& or &%mailstore_format%& option is set.
23735
23736 No locking is required while writing the message to a new file, so the various
23737 locking options of the transport are ignored. The &"From"& line that by default
23738 separates messages in a single file is not normally needed, nor is the escaping
23739 of message lines that start with &"From"&, and there is no need to ensure a
23740 newline at the end of each message. Consequently, the default values for
23741 &%check_string%&, &%message_prefix%&, and &%message_suffix%& are all unset when
23742 any of &%directory%&, &%maildir_format%&, or &%mailstore_format%& is set.
23743
23744 If Exim is required to check a &%quota%& setting, it adds up the sizes of all
23745 the files in the delivery directory by default. However, you can specify a
23746 different directory by setting &%quota_directory%&. Also, for maildir
23747 deliveries (see below) the &_maildirfolder_& convention is honoured.
23748
23749
23750 .cindex "maildir format"
23751 .cindex "mailstore format"
23752 There are three different ways in which delivery to individual files can be
23753 done, controlled by the settings of the &%maildir_format%& and
23754 &%mailstore_format%& options. Note that code to support maildir or mailstore
23755 formats is not included in the binary unless SUPPORT_MAILDIR or
23756 SUPPORT_MAILSTORE, respectively, is set in &_Local/Makefile_&.
23757
23758 .cindex "directory creation"
23759 In all three cases an attempt is made to create the directory and any necessary
23760 sub-directories if they do not exist, provided that the &%create_directory%&
23761 option is set (the default). The location of a created directory can be
23762 constrained by setting &%create_file%&. A created directory's mode is given by
23763 the &%directory_mode%& option. If creation fails, or if the
23764 &%create_directory%& option is not set when creation is required, delivery is
23765 deferred.
23766
23767
23768
23769 .section "Maildir delivery" "SECTmaildirdelivery"
23770 .cindex "maildir format" "description of"
23771 If the &%maildir_format%& option is true, Exim delivers each message by writing
23772 it to a file whose name is &_tmp/<stime>.H<mtime>P<pid>.<host>_& in the
23773 directory that is defined by the &%directory%& option (the &"delivery
23774 directory"&). If the delivery is successful, the file is renamed into the
23775 &_new_& subdirectory.
23776
23777 In the filename, <&'stime'&> is the current time of day in seconds, and
23778 <&'mtime'&> is the microsecond fraction of the time. After a maildir delivery,
23779 Exim checks that the time-of-day clock has moved on by at least one microsecond
23780 before terminating the delivery process. This guarantees uniqueness for the
23781 filename. However, as a precaution, Exim calls &[stat()]& for the file before
23782 opening it. If any response other than ENOENT (does not exist) is given,
23783 Exim waits 2 seconds and tries again, up to &%maildir_retries%& times.
23784
23785 Before Exim carries out a maildir delivery, it ensures that subdirectories
23786 called &_new_&, &_cur_&, and &_tmp_& exist in the delivery directory. If they
23787 do not exist, Exim tries to create them and any superior directories in their
23788 path, subject to the &%create_directory%& and &%create_file%& options. If the
23789 &%maildirfolder_create_regex%& option is set, and the regular expression it
23790 contains matches the delivery directory, Exim also ensures that a file called
23791 &_maildirfolder_& exists in the delivery directory. If a missing directory or
23792 &_maildirfolder_& file cannot be created, delivery is deferred.
23793
23794 These features make it possible to use Exim to create all the necessary files
23795 and directories in a maildir mailbox, including subdirectories for maildir++
23796 folders. Consider this example:
23797 .code
23798 maildir_format = true
23799 directory = /var/mail/$local_part_data\
23800            ${if eq{$local_part_suffix}{}{}\
23801            {/.${substr_1:$local_part_suffix}}}
23802 maildirfolder_create_regex = /\.[^/]+$
23803 .endd
23804 If &$local_part_suffix$& is empty (there was no suffix for the local part),
23805 delivery is into a toplevel maildir with a name like &_/var/mail/pimbo_& (for
23806 the user called &'pimbo'&). The pattern in &%maildirfolder_create_regex%& does
23807 not match this name, so Exim will not look for or create the file
23808 &_/var/mail/pimbo/maildirfolder_&, though it will create
23809 &_/var/mail/pimbo/{cur,new,tmp}_& if necessary.
23810
23811 However, if &$local_part_suffix$& contains &`-eximusers`& (for example),
23812 delivery is into the maildir++ folder &_/var/mail/pimbo/.eximusers_&, which
23813 does match &%maildirfolder_create_regex%&. In this case, Exim will create
23814 &_/var/mail/pimbo/.eximusers/maildirfolder_& as well as the three maildir
23815 directories &_/var/mail/pimbo/.eximusers/{cur,new,tmp}_&.
23816
23817 &*Warning:*& Take care when setting &%maildirfolder_create_regex%& that it does
23818 not inadvertently match the toplevel maildir directory, because a
23819 &_maildirfolder_& file at top level would completely break quota calculations.
23820
23821 .cindex "quota" "in maildir delivery"
23822 .cindex "maildir++"
23823 If Exim is required to check a &%quota%& setting before a maildir delivery, and
23824 &%quota_directory%& is not set, it looks for a file called &_maildirfolder_& in
23825 the maildir directory (alongside &_new_&, &_cur_&, &_tmp_&). If this exists,
23826 Exim assumes the directory is a maildir++ folder directory, which is one level
23827 down from the user's top level mailbox directory. This causes it to start at
23828 the parent directory instead of the current directory when calculating the
23829 amount of space used.
23830
23831 One problem with delivering into a multi-file mailbox is that it is
23832 computationally expensive to compute the size of the mailbox for quota
23833 checking. Various approaches have been taken to reduce the amount of work
23834 needed. The next two sections describe two of them. A third alternative is to
23835 use some external process for maintaining the size data, and use the expansion
23836 of the &%mailbox_size%& option as a way of importing it into Exim.
23837
23838
23839
23840
23841 .section "Using tags to record message sizes" "SECID135"
23842 If &%maildir_tag%& is set, the string is expanded for each delivery.
23843 When the maildir file is renamed into the &_new_& sub-directory, the
23844 tag is added to its name. However, if adding the tag takes the length of the
23845 name to the point where the test &[stat()]& call fails with ENAMETOOLONG,
23846 the tag is dropped and the maildir file is created with no tag.
23847
23848
23849 .vindex "&$message_size$&"
23850 Tags can be used to encode the size of files in their names; see
23851 &%quota_size_regex%& above for an example. The expansion of &%maildir_tag%&
23852 happens after the message has been written. The value of the &$message_size$&
23853 variable is set to the number of bytes actually written. If the expansion is
23854 forced to fail, the tag is ignored, but a non-forced failure causes delivery to
23855 be deferred. The expanded tag may contain any printing characters except &"/"&.
23856 Non-printing characters in the string are ignored; if the resulting string is
23857 empty, it is ignored. If it starts with an alphanumeric character, a leading
23858 colon is inserted; this default has not proven to be the path that popular
23859 maildir implementations have chosen (but changing it in Exim would break
23860 backwards compatibility).
23861
23862 For one common implementation, you might set:
23863 .code
23864 maildir_tag = ,S=${message_size}
23865 .endd
23866 but you should check the documentation of the other software to be sure.
23867
23868 It is advisable to also set &%quota_size_regex%& when setting &%maildir_tag%&
23869 as this allows Exim to extract the size from your tag, instead of having to
23870 &[stat()]& each message file.
23871
23872
23873 .section "Using a maildirsize file" "SECID136"
23874 .cindex "quota" "in maildir delivery"
23875 .cindex "maildir format" "&_maildirsize_& file"
23876 If &%maildir_use_size_file%& is true, Exim implements the maildir++ rules for
23877 storing quota and message size information in a file called &_maildirsize_&
23878 within the toplevel maildir directory. If this file does not exist, Exim
23879 creates it, setting the quota from the &%quota%& option of the transport. If
23880 the maildir directory itself does not exist, it is created before any attempt
23881 to write a &_maildirsize_& file.
23882
23883 The &_maildirsize_& file is used to hold information about the sizes of
23884 messages in the maildir, thus speeding up quota calculations. The quota value
23885 in the file is just a cache; if the quota is changed in the transport, the new
23886 value overrides the cached value when the next message is delivered. The cache
23887 is maintained for the benefit of other programs that access the maildir and
23888 need to know the quota.
23889
23890 If the &%quota%& option in the transport is unset or zero, the &_maildirsize_&
23891 file is maintained (with a zero quota setting), but no quota is imposed.
23892
23893 A regular expression is available for controlling which directories in the
23894 maildir participate in quota calculations when a &_maildirsizefile_& is in use.
23895 See the description of the &%maildir_quota_directory_regex%& option above for
23896 details.
23897
23898
23899 .section "Mailstore delivery" "SECID137"
23900 .cindex "mailstore format" "description of"
23901 If the &%mailstore_format%& option is true, each message is written as two
23902 files in the given directory. A unique base name is constructed from the
23903 message id and the current delivery process, and the files that are written use
23904 this base name plus the suffixes &_.env_& and &_.msg_&. The &_.env_& file
23905 contains the message's envelope, and the &_.msg_& file contains the message
23906 itself. The base name is placed in the variable &$mailstore_basename$&.
23907
23908 During delivery, the envelope is first written to a file with the suffix
23909 &_.tmp_&. The &_.msg_& file is then written, and when it is complete, the
23910 &_.tmp_& file is renamed as the &_.env_& file. Programs that access messages in
23911 mailstore format should wait for the presence of both a &_.msg_& and a &_.env_&
23912 file before accessing either of them. An alternative approach is to wait for
23913 the absence of a &_.tmp_& file.
23914
23915 The envelope file starts with any text defined by the &%mailstore_prefix%&
23916 option, expanded and terminated by a newline if there isn't one. Then follows
23917 the sender address on one line, then all the recipient addresses, one per line.
23918 There can be more than one recipient only if the &%batch_max%& option is set
23919 greater than one. Finally, &%mailstore_suffix%& is expanded and the result
23920 appended to the file, followed by a newline if it does not end with one.
23921
23922 If expansion of &%mailstore_prefix%& or &%mailstore_suffix%& ends with a forced
23923 failure, it is ignored. Other expansion errors are treated as serious
23924 configuration errors, and delivery is deferred. The variable
23925 &$mailstore_basename$& is available for use during these expansions.
23926
23927
23928 .section "Non-special new file delivery" "SECID138"
23929 If neither &%maildir_format%& nor &%mailstore_format%& is set, a single new
23930 file is created directly in the named directory. For example, when delivering
23931 messages into files in batched SMTP format for later delivery to some host (see
23932 section &<<SECTbatchSMTP>>&), a setting such as
23933 .code
23934 directory = /var/bsmtp/$host
23935 .endd
23936 might be used. A message is written to a file with a temporary name, which is
23937 then renamed when the delivery is complete. The final name is obtained by
23938 expanding the contents of the &%directory_file%& option.
23939 .ecindex IIDapptra1
23940 .ecindex IIDapptra2
23941
23942
23943
23944
23945
23946
23947 . ////////////////////////////////////////////////////////////////////////////
23948 . ////////////////////////////////////////////////////////////////////////////
23949
23950 .chapter "The autoreply transport" "CHID8"
23951 .scindex IIDauttra1 "transports" "&(autoreply)&"
23952 .scindex IIDauttra2 "&(autoreply)& transport"
23953 The &(autoreply)& transport is not a true transport in that it does not cause
23954 the message to be transmitted. Instead, it generates a new mail message as an
23955 automatic reply to the incoming message. &'References:'& and
23956 &'Auto-Submitted:'& header lines are included. These are constructed according
23957 to the rules in RFCs 2822 and 3834, respectively.
23958
23959 If the router that passes the message to this transport does not have the
23960 &%unseen%& option set, the original message (for the current recipient) is not
23961 delivered anywhere. However, when the &%unseen%& option is set on the router
23962 that passes the message to this transport, routing of the address continues, so
23963 another router can set up a normal message delivery.
23964
23965
23966 The &(autoreply)& transport is usually run as the result of mail filtering, a
23967 &"vacation"& message being the standard example. However, it can also be run
23968 directly from a router like any other transport. To reduce the possibility of
23969 message cascades, messages created by the &(autoreply)& transport always have
23970 empty envelope sender addresses, like bounce messages.
23971
23972 The parameters of the message to be sent can be specified in the configuration
23973 by options described below. However, these are used only when the address
23974 passed to the transport does not contain its own reply information. When the
23975 transport is run as a consequence of a
23976 &%mail%&
23977 or &%vacation%& command in a filter file, the parameters of the message are
23978 supplied by the filter, and passed with the address. The transport's options
23979 that define the message are then ignored (so they are not usually set in this
23980 case). The message is specified entirely by the filter or by the transport; it
23981 is never built from a mixture of options. However, the &%file_optional%&,
23982 &%mode%&, and &%return_message%& options apply in all cases.
23983
23984 &(Autoreply)& is implemented as a local transport. When used as a result of a
23985 command in a user's filter file, &(autoreply)& normally runs under the uid and
23986 gid of the user, and with appropriate current and home directories (see chapter
23987 &<<CHAPenvironment>>&).
23988
23989 There is a subtle difference between routing a message to a &(pipe)& transport
23990 that generates some text to be returned to the sender, and routing it to an
23991 &(autoreply)& transport. This difference is noticeable only if more than one
23992 address from the same message is so handled. In the case of a pipe, the
23993 separate outputs from the different addresses are gathered up and returned to
23994 the sender in a single message, whereas if &(autoreply)& is used, a separate
23995 message is generated for each address that is passed to it.
23996
23997 Non-printing characters are not permitted in the header lines generated for the
23998 message that &(autoreply)& creates, with the exception of newlines that are
23999 immediately followed by white space. If any non-printing characters are found,
24000 the transport defers.
24001 Whether characters with the top bit set count as printing characters or not is
24002 controlled by the &%print_topbitchars%& global option.
24003
24004 If any of the generic options for manipulating headers (for example,
24005 &%headers_add%&) are set on an &(autoreply)& transport, they apply to the copy
24006 of the original message that is included in the generated message when
24007 &%return_message%& is set. They do not apply to the generated message itself.
24008
24009 .vindex "&$sender_address$&"
24010 If the &(autoreply)& transport receives return code 2 from Exim when it submits
24011 the message, indicating that there were no recipients, it does not treat this
24012 as an error. This means that autoreplies sent to &$sender_address$& when this
24013 is empty (because the incoming message is a bounce message) do not cause
24014 problems. They are just discarded.
24015
24016
24017
24018 .section "Private options for autoreply" "SECID139"
24019 .cindex "options" "&(autoreply)& transport"
24020
24021 .option bcc autoreply string&!! unset
24022 This specifies the addresses that are to receive &"blind carbon copies"& of the
24023 message when the message is specified by the transport.
24024
24025
24026 .option cc autoreply string&!! unset
24027 This specifies recipients of the message and the contents of the &'Cc:'& header
24028 when the message is specified by the transport.
24029
24030
24031 .option file autoreply string&!! unset
24032 The contents of the file are sent as the body of the message when the message
24033 is specified by the transport. If both &%file%& and &%text%& are set, the text
24034 string comes first.
24035
24036
24037 .option file_expand autoreply boolean false
24038 If this is set, the contents of the file named by the &%file%& option are
24039 subjected to string expansion as they are added to the message.
24040
24041
24042 .option file_optional autoreply boolean false
24043 If this option is true, no error is generated if the file named by the &%file%&
24044 option or passed with the address does not exist or cannot be read.
24045
24046
24047 .option from autoreply string&!! unset
24048 This specifies the contents of the &'From:'& header when the message is
24049 specified by the transport.
24050
24051
24052 .option headers autoreply string&!! unset
24053 This specifies additional RFC 2822 headers that are to be added to the message
24054 when the message is specified by the transport. Several can be given by using
24055 &"\n"& to separate them. There is no check on the format.
24056
24057
24058 .option log autoreply string&!! unset
24059 This option names a file in which a record of every message sent is logged when
24060 the message is specified by the transport.
24061
24062
24063 .option mode autoreply "octal integer" 0600
24064 If either the log file or the &"once"& file has to be created, this mode is
24065 used.
24066
24067
24068 .option never_mail autoreply "address list&!!" unset
24069 If any run of the transport creates a message with a recipient that matches any
24070 item in the list, that recipient is quietly discarded. If all recipients are
24071 discarded, no message is created. This applies both when the recipients are
24072 generated by a filter and when they are specified in the transport.
24073
24074
24075
24076 .option once autoreply string&!! unset
24077 This option names a file or DBM database in which a record of each &'To:'&
24078 recipient is kept when the message is specified by the transport. &*Note*&:
24079 This does not apply to &'Cc:'& or &'Bcc:'& recipients.
24080
24081 If &%once%& is unset, or is set to an empty string, the message is always sent.
24082 By default, if &%once%& is set to a non-empty filename, the message
24083 is not sent if a potential recipient is already listed in the database.
24084 However, if the &%once_repeat%& option specifies a time greater than zero, the
24085 message is sent if that much time has elapsed since a message was last sent to
24086 this recipient. A setting of zero time for &%once_repeat%& (the default)
24087 prevents a message from being sent a second time &-- in this case, zero means
24088 infinity.
24089
24090 If &%once_file_size%& is zero, a DBM database is used to remember recipients,
24091 and it is allowed to grow as large as necessary. If &%once_file_size%& is set
24092 greater than zero, it changes the way Exim implements the &%once%& option.
24093 Instead of using a DBM file to record every recipient it sends to, it uses a
24094 regular file, whose size will never get larger than the given value.
24095
24096 In the file, Exim keeps a linear list of recipient addresses and the times at
24097 which they were sent messages. If the file is full when a new address needs to
24098 be added, the oldest address is dropped. If &%once_repeat%& is not set, this
24099 means that a given recipient may receive multiple messages, but at
24100 unpredictable intervals that depend on the rate of turnover of addresses in the
24101 file. If &%once_repeat%& is set, it specifies a maximum time between repeats.
24102
24103
24104 .option once_file_size autoreply integer 0
24105 See &%once%& above.
24106
24107
24108 .option once_repeat autoreply time&!! 0s
24109 See &%once%& above.
24110 After expansion, the value of this option must be a valid time value.
24111
24112
24113 .option reply_to autoreply string&!! unset
24114 This specifies the contents of the &'Reply-To:'& header when the message is
24115 specified by the transport.
24116
24117
24118 .option return_message autoreply boolean false
24119 If this is set, a copy of the original message is returned with the new
24120 message, subject to the maximum size set in the &%return_size_limit%& global
24121 configuration option.
24122
24123
24124 .option subject autoreply string&!! unset
24125 This specifies the contents of the &'Subject:'& header when the message is
24126 specified by the transport. It is tempting to quote the original subject in
24127 automatic responses. For example:
24128 .code
24129 subject = Re: $h_subject:
24130 .endd
24131 There is a danger in doing this, however. It may allow a third party to
24132 subscribe your users to an opt-in mailing list, provided that the list accepts
24133 bounce messages as subscription confirmations. Well-managed lists require a
24134 non-bounce message to confirm a subscription, so the danger is relatively
24135 small.
24136
24137
24138
24139 .option text autoreply string&!! unset
24140 This specifies a single string to be used as the body of the message when the
24141 message is specified by the transport. If both &%text%& and &%file%& are set,
24142 the text comes first.
24143
24144
24145 .option to autoreply string&!! unset
24146 This specifies recipients of the message and the contents of the &'To:'& header
24147 when the message is specified by the transport.
24148 .ecindex IIDauttra1
24149 .ecindex IIDauttra2
24150
24151
24152
24153
24154 . ////////////////////////////////////////////////////////////////////////////
24155 . ////////////////////////////////////////////////////////////////////////////
24156
24157 .chapter "The lmtp transport" "CHAPLMTP"
24158 .cindex "transports" "&(lmtp)&"
24159 .cindex "&(lmtp)& transport"
24160 .cindex "LMTP" "over a pipe"
24161 .cindex "LMTP" "over a socket"
24162 The &(lmtp)& transport runs the LMTP protocol (RFC 2033) over a pipe to a
24163 specified command
24164 or by interacting with a Unix domain socket.
24165 This transport is something of a cross between the &(pipe)& and &(smtp)&
24166 transports. Exim also has support for using LMTP over TCP/IP; this is
24167 implemented as an option for the &(smtp)& transport. Because LMTP is expected
24168 to be of minority interest, the default build-time configure in &_src/EDITME_&
24169 has it commented out. You need to ensure that
24170 .code
24171 TRANSPORT_LMTP=yes
24172 .endd
24173 .cindex "options" "&(lmtp)& transport"
24174 is present in your &_Local/Makefile_& in order to have the &(lmtp)& transport
24175 included in the Exim binary. The private options of the &(lmtp)& transport are
24176 as follows:
24177
24178 .option batch_id lmtp string&!! unset
24179 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
24180
24181
24182 .option batch_max lmtp integer 1
24183 This limits the number of addresses that can be handled in a single delivery.
24184 Most LMTP servers can handle several addresses at once, so it is normally a
24185 good idea to increase this value. See the description of local delivery
24186 batching in chapter &<<CHAPbatching>>&.
24187
24188
24189 .option command lmtp string&!! unset
24190 This option must be set if &%socket%& is not set. The string is a command which
24191 is run in a separate process. It is split up into a command name and list of
24192 arguments, each of which is separately expanded (so expansion cannot change the
24193 number of arguments). The command is run directly, not via a shell. The message
24194 is passed to the new process using the standard input and output to operate the
24195 LMTP protocol.
24196
24197 .option ignore_quota lmtp boolean false
24198 .cindex "LMTP" "ignoring quota errors"
24199 If this option is set true, the string &`IGNOREQUOTA`& is added to RCPT
24200 commands, provided that the LMTP server has advertised support for IGNOREQUOTA
24201 in its response to the LHLO command.
24202
24203 .option socket lmtp string&!! unset
24204 This option must be set if &%command%& is not set. The result of expansion must
24205 be the name of a Unix domain socket. The transport connects to the socket and
24206 delivers the message to it using the LMTP protocol.
24207
24208
24209 .option timeout lmtp time 5m
24210 The transport is aborted if the created process or Unix domain socket does not
24211 respond to LMTP commands or message input within this timeout. Delivery
24212 is deferred, and will be tried again later. Here is an example of a typical
24213 LMTP transport:
24214 .code
24215 lmtp:
24216   driver = lmtp
24217   command = /some/local/lmtp/delivery/program
24218   batch_max = 20
24219   user = exim
24220 .endd
24221 This delivers up to 20 addresses at a time, in a mixture of domains if
24222 necessary, running as the user &'exim'&.
24223
24224
24225
24226 . ////////////////////////////////////////////////////////////////////////////
24227 . ////////////////////////////////////////////////////////////////////////////
24228
24229 .chapter "The pipe transport" "CHAPpipetransport"
24230 .scindex IIDpiptra1 "transports" "&(pipe)&"
24231 .scindex IIDpiptra2 "&(pipe)& transport"
24232 The &(pipe)& transport is used to deliver messages via a pipe to a command
24233 running in another process. One example is the use of &(pipe)& as a
24234 pseudo-remote transport for passing messages to some other delivery mechanism
24235 (such as UUCP). Another is the use by individual users to automatically process
24236 their incoming messages. The &(pipe)& transport can be used in one of the
24237 following ways:
24238
24239 .ilist
24240 .vindex "&$local_part$&"
24241 A router routes one address to a transport in the normal way, and the
24242 transport is configured as a &(pipe)& transport. In this case, &$local_part$&
24243 contains the local part of the address (as usual), and the command that is run
24244 is specified by the &%command%& option on the transport.
24245 .next
24246 .vindex "&$pipe_addresses$&"
24247 If the &%batch_max%& option is set greater than 1 (the default is 1), the
24248 transport can handle more than one address in a single run. In this case, when
24249 more than one address is routed to the transport, &$local_part$& is not set
24250 (because it is not unique). However, the pseudo-variable &$pipe_addresses$&
24251 (described in section &<<SECThowcommandrun>>& below) contains all the addresses
24252 that are routed to the transport.
24253 .next
24254 .vindex "&$address_pipe$&"
24255 A router redirects an address directly to a pipe command (for example, from an
24256 alias or forward file). In this case, &$address_pipe$& contains the text of the
24257 pipe command, and the &%command%& option on the transport is ignored unless
24258 &%force_command%& is set. If only one address is being transported
24259 (&%batch_max%& is not greater than one, or only one address was redirected to
24260 this pipe command), &$local_part$& contains the local part that was redirected.
24261 .endlist
24262
24263
24264 The &(pipe)& transport is a non-interactive delivery method. Exim can also
24265 deliver messages over pipes using the LMTP interactive protocol. This is
24266 implemented by the &(lmtp)& transport.
24267
24268 In the case when &(pipe)& is run as a consequence of an entry in a local user's
24269 &_.forward_& file, the command runs under the uid and gid of that user. In
24270 other cases, the uid and gid have to be specified explicitly, either on the
24271 transport or on the router that handles the address. Current and &"home"&
24272 directories are also controllable. See chapter &<<CHAPenvironment>>& for
24273 details of the local delivery environment and chapter &<<CHAPbatching>>&
24274 for a discussion of local delivery batching.
24275
24276 .cindex "tainted data" "in pipe command"
24277 .cindex pipe "tainted data"
24278 Tainted data may not be used for the command name.
24279
24280
24281 .section "Concurrent delivery" "SECID140"
24282 If two messages arrive at almost the same time, and both are routed to a pipe
24283 delivery, the two pipe transports may be run concurrently. You must ensure that
24284 any pipe commands you set up are robust against this happening. If the commands
24285 write to a file, the &%exim_lock%& utility might be of use.
24286 Alternatively the &%max_parallel%& option could be used with a value
24287 of "1" to enforce serialization.
24288
24289
24290
24291
24292 .section "Returned status and data" "SECID141"
24293 .cindex "&(pipe)& transport" "returned data"
24294 If the command exits with a non-zero return code, the delivery is deemed to
24295 have failed, unless either the &%ignore_status%& option is set (in which case
24296 the return code is treated as zero), or the return code is one of those listed
24297 in the &%temp_errors%& option, which are interpreted as meaning &"try again
24298 later"&. In this case, delivery is deferred. Details of a permanent failure are
24299 logged, but are not included in the bounce message, which merely contains
24300 &"local delivery failed"&.
24301
24302 If the command exits on a signal and the &%freeze_signal%& option is set then
24303 the message will be frozen in the queue. If that option is not set, a bounce
24304 will be sent as normal.
24305
24306 If the return code is greater than 128 and the command being run is a shell
24307 script, it normally means that the script was terminated by a signal whose
24308 value is the return code minus 128. The &%freeze_signal%& option does not
24309 apply in this case.
24310
24311 If Exim is unable to run the command (that is, if &[execve()]& fails), the
24312 return code is set to 127. This is the value that a shell returns if it is
24313 asked to run a non-existent command. The wording for the log line suggests that
24314 a non-existent command may be the problem.
24315
24316 The &%return_output%& option can affect the result of a pipe delivery. If it is
24317 set and the command produces any output on its standard output or standard
24318 error streams, the command is considered to have failed, even if it gave a zero
24319 return code or if &%ignore_status%& is set. The output from the command is
24320 included as part of the bounce message. The &%return_fail_output%& option is
24321 similar, except that output is returned only when the command exits with a
24322 failure return code, that is, a value other than zero or a code that matches
24323 &%temp_errors%&.
24324
24325
24326
24327 .section "How the command is run" "SECThowcommandrun"
24328 .cindex "&(pipe)& transport" "path for command"
24329 The command line is (by default) broken down into a command name and arguments
24330 by the &(pipe)& transport itself. The &%allow_commands%& and
24331 &%restrict_to_path%& options can be used to restrict the commands that may be
24332 run.
24333
24334 .cindex "quoting" "in pipe command"
24335 Unquoted arguments are delimited by white space. If an argument appears in
24336 double quotes, backslash is interpreted as an escape character in the usual
24337 way. If an argument appears in single quotes, no escaping is done.
24338
24339 String expansion is applied to the command line except when it comes from a
24340 traditional &_.forward_& file (commands from a filter file are expanded). The
24341 expansion is applied to each argument in turn rather than to the whole line.
24342 For this reason, any string expansion item that contains white space must be
24343 quoted so as to be contained within a single argument. A setting such as
24344 .code
24345 command = /some/path ${if eq{$local_part}{postmaster}{xx}{yy}}
24346 .endd
24347 will not work, because the expansion item gets split between several
24348 arguments. You have to write
24349 .code
24350 command = /some/path "${if eq{$local_part}{postmaster}{xx}{yy}}"
24351 .endd
24352 to ensure that it is all in one argument. The expansion is done in this way,
24353 argument by argument, so that the number of arguments cannot be changed as a
24354 result of expansion, and quotes or backslashes in inserted variables do not
24355 interact with external quoting. However, this leads to problems if you want to
24356 generate multiple arguments (or the command name plus arguments) from a single
24357 expansion. In this situation, the simplest solution is to use a shell. For
24358 example:
24359 .code
24360 command = /bin/sh -c ${lookup{$local_part}lsearch{/some/file}}
24361 .endd
24362
24363 .cindex "transport" "filter"
24364 .cindex "filter" "transport filter"
24365 .vindex "&$pipe_addresses$&"
24366 Special handling takes place when an argument consists of precisely the text
24367 &`$pipe_addresses`& (no quotes).
24368 This is not a general expansion variable; the only
24369 place this string is recognized is when it appears as an argument for a pipe or
24370 transport filter command. It causes each address that is being handled to be
24371 inserted in the argument list at that point &'as a separate argument'&. This
24372 avoids any problems with spaces or shell metacharacters, and is of use when a
24373 &(pipe)& transport is handling groups of addresses in a batch.
24374
24375 If &%force_command%& is enabled on the transport, special handling takes place
24376 for an argument that consists of precisely the text &`$address_pipe`&.  It
24377 is handled similarly to &$pipe_addresses$& above.  It is expanded and each
24378 argument is inserted in the argument list at that point
24379 &'as a separate argument'&.  The &`$address_pipe`& item does not need to be
24380 the only item in the argument; in fact, if it were then &%force_command%&
24381 should behave as a no-op.  Rather, it should be used to adjust the command
24382 run while preserving the argument vector separation.
24383
24384 After splitting up into arguments and expansion, the resulting command is run
24385 in a subprocess directly from the transport, &'not'& under a shell. The
24386 message that is being delivered is supplied on the standard input, and the
24387 standard output and standard error are both connected to a single pipe that is
24388 read by Exim. The &%max_output%& option controls how much output the command
24389 may produce, and the &%return_output%& and &%return_fail_output%& options
24390 control what is done with it.
24391
24392 Not running the command under a shell (by default) lessens the security risks
24393 in cases when a command from a user's filter file is built out of data that was
24394 taken from an incoming message. If a shell is required, it can of course be
24395 explicitly specified as the command to be run. However, there are circumstances
24396 where existing commands (for example, in &_.forward_& files) expect to be run
24397 under a shell and cannot easily be modified. To allow for these cases, there is
24398 an option called &%use_shell%&, which changes the way the &(pipe)& transport
24399 works. Instead of breaking up the command line as just described, it expands it
24400 as a single string and passes the result to &_/bin/sh_&. The
24401 &%restrict_to_path%& option and the &$pipe_addresses$& facility cannot be used
24402 with &%use_shell%&, and the whole mechanism is inherently less secure.
24403
24404
24405
24406 .section "Environment variables" "SECTpipeenv"
24407 .cindex "&(pipe)& transport" "environment for command"
24408 .cindex "environment" "&(pipe)& transport"
24409 The environment variables listed below are set up when the command is invoked.
24410 This list is a compromise for maximum compatibility with other MTAs. Note that
24411 the &%environment%& option can be used to add additional variables to this
24412 environment. The environment for the &(pipe)& transport is not subject
24413 to the &%add_environment%& and &%keep_environment%& main config options.
24414 .display
24415 &`DOMAIN            `&   the domain of the address
24416 &`HOME              `&   the home directory, if set
24417 &`HOST              `&   the host name when called from a router (see below)
24418 &`LOCAL_PART        `&   see below
24419 &`LOCAL_PART_PREFIX `&   see below
24420 &`LOCAL_PART_SUFFIX `&   see below
24421 &`LOGNAME           `&   see below
24422 &`MESSAGE_ID        `&   Exim's local ID for the message
24423 &`PATH              `&   as specified by the &%path%& option below
24424 &`QUALIFY_DOMAIN    `&   the sender qualification domain
24425 &`RECIPIENT         `&   the complete recipient address
24426 &`SENDER            `&   the sender of the message (empty if a bounce)
24427 &`SHELL             `&   &`/bin/sh`&
24428 &`TZ                `&   the value of the &%timezone%& option, if set
24429 &`USER              `&   see below
24430 .endd
24431 When a &(pipe)& transport is called directly from (for example) an &(accept)&
24432 router, LOCAL_PART is set to the local part of the address. When it is
24433 called as a result of a forward or alias expansion, LOCAL_PART is set to
24434 the local part of the address that was expanded. In both cases, any affixes are
24435 removed from the local part, and made available in LOCAL_PART_PREFIX and
24436 LOCAL_PART_SUFFIX, respectively. LOGNAME and USER are set to the
24437 same value as LOCAL_PART for compatibility with other MTAs.
24438
24439 .cindex "HOST"
24440 HOST is set only when a &(pipe)& transport is called from a router that
24441 associates hosts with an address, typically when using &(pipe)& as a
24442 pseudo-remote transport. HOST is set to the first host name specified by
24443 the router.
24444
24445 .cindex "HOME"
24446 If the transport's generic &%home_directory%& option is set, its value is used
24447 for the HOME environment variable. Otherwise, a home directory may be set
24448 by the router's &%transport_home_directory%& option, which defaults to the
24449 user's home directory if &%check_local_user%& is set.
24450
24451
24452 .section "Private options for pipe" "SECID142"
24453 .cindex "options" "&(pipe)& transport"
24454
24455
24456
24457 .option allow_commands pipe "string list&!!" unset
24458 .cindex "&(pipe)& transport" "permitted commands"
24459 The string is expanded, and is then interpreted as a colon-separated list of
24460 permitted commands. If &%restrict_to_path%& is not set, the only commands
24461 permitted are those in the &%allow_commands%& list. They need not be absolute
24462 paths; the &%path%& option is still used for relative paths. If
24463 &%restrict_to_path%& is set with &%allow_commands%&, the command must either be
24464 in the &%allow_commands%& list, or a name without any slashes that is found on
24465 the path. In other words, if neither &%allow_commands%& nor
24466 &%restrict_to_path%& is set, there is no restriction on the command, but
24467 otherwise only commands that are permitted by one or the other are allowed. For
24468 example, if
24469 .code
24470 allow_commands = /usr/bin/vacation
24471 .endd
24472 and &%restrict_to_path%& is not set, the only permitted command is
24473 &_/usr/bin/vacation_&. The &%allow_commands%& option may not be set if
24474 &%use_shell%& is set.
24475
24476
24477 .option batch_id pipe string&!! unset
24478 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
24479
24480
24481 .option batch_max pipe integer 1
24482 This limits the number of addresses that can be handled in a single delivery.
24483 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
24484
24485
24486 .option check_string pipe string unset
24487 As &(pipe)& writes the message, the start of each line is tested for matching
24488 &%check_string%&, and if it does, the initial matching characters are replaced
24489 by the contents of &%escape_string%&, provided both are set. The value of
24490 &%check_string%& is a literal string, not a regular expression, and the case of
24491 any letters it contains is significant. When &%use_bsmtp%& is set, the contents
24492 of &%check_string%& and &%escape_string%& are forced to values that implement
24493 the SMTP escaping protocol. Any settings made in the configuration file are
24494 ignored.
24495
24496
24497 .option command pipe string&!! unset
24498 This option need not be set when &(pipe)& is being used to deliver to pipes
24499 obtained directly from address redirections. In other cases, the option must be
24500 set, to provide a command to be run. It need not yield an absolute path (see
24501 the &%path%& option below). The command is split up into separate arguments by
24502 Exim, and each argument is separately expanded, as described in section
24503 &<<SECThowcommandrun>>& above.
24504
24505
24506 .option environment pipe string&!! unset
24507 .cindex "&(pipe)& transport" "environment for command"
24508 .cindex "environment" "&(pipe)& transport"
24509 This option is used to add additional variables to the environment in which the
24510 command runs (see section &<<SECTpipeenv>>& for the default list). Its value is
24511 a string which is expanded, and then interpreted as a colon-separated list of
24512 environment settings of the form <&'name'&>=<&'value'&>.
24513
24514
24515 .option escape_string pipe string unset
24516 See &%check_string%& above.
24517
24518
24519 .option freeze_exec_fail pipe boolean false
24520 .cindex "exec failure"
24521 .cindex "failure of exec"
24522 .cindex "&(pipe)& transport" "failure of exec"
24523 Failure to exec the command in a pipe transport is by default treated like
24524 any other failure while running the command. However, if &%freeze_exec_fail%&
24525 is set, failure to exec is treated specially, and causes the message to be
24526 frozen, whatever the setting of &%ignore_status%&.
24527
24528
24529 .option freeze_signal pipe boolean false
24530 .cindex "signal exit"
24531 .cindex "&(pipe)& transport", "signal exit"
24532 Normally if the process run by a command in a pipe transport exits on a signal,
24533 a bounce message is sent. If &%freeze_signal%& is set, the message will be
24534 frozen in Exim's queue instead.
24535
24536
24537 .option force_command pipe boolean false
24538 .cindex "force command"
24539 .cindex "&(pipe)& transport", "force command"
24540 Normally when a router redirects an address directly to a pipe command
24541 the &%command%& option on the transport is ignored.  If &%force_command%&
24542 is set, the &%command%& option will used. This is especially
24543 useful for forcing a wrapper or additional argument to be added to the
24544 command. For example:
24545 .code
24546 command = /usr/bin/remote_exec myhost -- $address_pipe
24547 force_command
24548 .endd
24549
24550 Note that &$address_pipe$& is handled specially in &%command%& when
24551 &%force_command%& is set, expanding out to the original argument vector as
24552 separate items, similarly to a Unix shell &`"$@"`& construct.
24553
24554
24555 .option ignore_status pipe boolean false
24556 If this option is true, the status returned by the subprocess that is set up to
24557 run the command is ignored, and Exim behaves as if zero had been returned.
24558 Otherwise, a non-zero status or termination by signal causes an error return
24559 from the transport unless the status value is one of those listed in
24560 &%temp_errors%&; these cause the delivery to be deferred and tried again later.
24561
24562 &*Note*&: This option does not apply to timeouts, which do not return a status.
24563 See the &%timeout_defer%& option for how timeouts are handled.
24564
24565
24566 .option log_defer_output pipe boolean false
24567 .cindex "&(pipe)& transport" "logging output"
24568 If this option is set, and the status returned by the command is
24569 one of the codes listed in &%temp_errors%& (that is, delivery was deferred),
24570 and any output was produced on stdout or stderr, the first line of it is
24571 written to the main log.
24572
24573
24574 .option log_fail_output pipe boolean false
24575 If this option is set, and the command returns any output on stdout or
24576 stderr, and also ends with a return code that is neither zero nor one of
24577 the return codes listed in &%temp_errors%& (that is, the delivery
24578 failed), the first line of output is written to the main log. This
24579 option and &%log_output%& are mutually exclusive.  Only one of them may
24580 be set.
24581
24582
24583 .option log_output pipe boolean false
24584 If this option is set and the command returns any output on stdout or
24585 stderr, the first line of output is written to the main log, whatever
24586 the return code. This option and &%log_fail_output%& are mutually
24587 exclusive. Only one of them may be set.
24588
24589
24590 .option max_output pipe integer 20K
24591 This specifies the maximum amount of output that the command may produce on its
24592 standard output and standard error file combined. If the limit is exceeded, the
24593 process running the command is killed. This is intended as a safety measure to
24594 catch runaway processes. The limit is applied independently of the settings of
24595 the options that control what is done with such output (for example,
24596 &%return_output%&). Because of buffering effects, the amount of output may
24597 exceed the limit by a small amount before Exim notices.
24598
24599
24600 .option message_prefix pipe string&!! "see below"
24601 The string specified here is expanded and output at the start of every message.
24602 The default is unset if &%use_bsmtp%& is set. Otherwise it is
24603 .code
24604 message_prefix = \
24605   From ${if def:return_path{$return_path}{MAILER-DAEMON}}\
24606   ${tod_bsdinbox}\n
24607 .endd
24608 .cindex "Cyrus"
24609 .cindex "&%tmail%&"
24610 .cindex "&""From""& line"
24611 This is required by the commonly used &_/usr/bin/vacation_& program.
24612 However, it must &'not'& be present if delivery is to the Cyrus IMAP server,
24613 or to the &%tmail%& local delivery agent. The prefix can be suppressed by
24614 setting
24615 .code
24616 message_prefix =
24617 .endd
24618 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
24619 &`\n`& to &`\r\n`& in &%message_prefix%&.
24620
24621
24622 .option message_suffix pipe string&!! "see below"
24623 The string specified here is expanded and output at the end of every message.
24624 The default is unset if &%use_bsmtp%& is set. Otherwise it is a single newline.
24625 The suffix can be suppressed by setting
24626 .code
24627 message_suffix =
24628 .endd
24629 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
24630 &`\n`& to &`\r\n`& in &%message_suffix%&.
24631
24632
24633 .option path pipe string&!! "/bin:/usr/bin"
24634 This option is expanded and
24635 specifies the string that is set up in the PATH environment
24636 variable of the subprocess.
24637 If the &%command%& option does not yield an absolute path name, the command is
24638 sought in the PATH directories, in the usual way. &*Warning*&: This does not
24639 apply to a command specified as a transport filter.
24640
24641
24642 .option permit_coredump pipe boolean false
24643 Normally Exim inhibits core-dumps during delivery.  If you have a need to get
24644 a core-dump of a pipe command, enable this command.  This enables core-dumps
24645 during delivery and affects both the Exim binary and the pipe command run.
24646 It is recommended that this option remain off unless and until you have a need
24647 for it and that this only be enabled when needed, as the risk of excessive
24648 resource consumption can be quite high.  Note also that Exim is typically
24649 installed as a setuid binary and most operating systems will inhibit coredumps
24650 of these by default, so further OS-specific action may be required.
24651
24652
24653 .option pipe_as_creator pipe boolean false
24654 .cindex "uid (user id)" "local delivery"
24655 If the generic &%user%& option is not set and this option is true, the delivery
24656 process is run under the uid that was in force when Exim was originally called
24657 to accept the message. If the group id is not otherwise set (via the generic
24658 &%group%& option), the gid that was in force when Exim was originally called to
24659 accept the message is used.
24660
24661
24662 .option restrict_to_path pipe boolean false
24663 When this option is set, any command name not listed in &%allow_commands%& must
24664 contain no slashes. The command is searched for only in the directories listed
24665 in the &%path%& option. This option is intended for use in the case when a pipe
24666 command has been generated from a user's &_.forward_& file. This is usually
24667 handled by a &(pipe)& transport called &%address_pipe%&.
24668
24669
24670 .option return_fail_output pipe boolean false
24671 If this option is true, and the command produced any output and ended with a
24672 return code other than zero or one of the codes listed in &%temp_errors%& (that
24673 is, the delivery failed), the output is returned in the bounce message.
24674 However, if the message has a null sender (that is, it is itself a bounce
24675 message), output from the command is discarded. This option and
24676 &%return_output%& are mutually exclusive. Only one of them may be set.
24677
24678
24679
24680 .option return_output pipe boolean false
24681 If this option is true, and the command produced any output, the delivery is
24682 deemed to have failed whatever the return code from the command, and the output
24683 is returned in the bounce message. Otherwise, the output is just discarded.
24684 However, if the message has a null sender (that is, it is a bounce message),
24685 output from the command is always discarded, whatever the setting of this
24686 option. This option and &%return_fail_output%& are mutually exclusive. Only one
24687 of them may be set.
24688
24689
24690
24691 .option temp_errors pipe "string list" "see below"
24692 .cindex "&(pipe)& transport" "temporary failure"
24693 This option contains either a colon-separated list of numbers, or a single
24694 asterisk. If &%ignore_status%& is false
24695 and &%return_output%& is not set,
24696 and the command exits with a non-zero return code, the failure is treated as
24697 temporary and the delivery is deferred if the return code matches one of the
24698 numbers, or if the setting is a single asterisk. Otherwise, non-zero return
24699 codes are treated as permanent errors. The default setting contains the codes
24700 defined by EX_TEMPFAIL and EX_CANTCREAT in &_sysexits.h_&. If Exim is
24701 compiled on a system that does not define these macros, it assumes values of 75
24702 and 73, respectively.
24703
24704
24705 .option timeout pipe time 1h
24706 If the command fails to complete within this time, it is killed. This normally
24707 causes the delivery to fail (but see &%timeout_defer%&). A zero time interval
24708 specifies no timeout. In order to ensure that any subprocesses created by the
24709 command are also killed, Exim makes the initial process a process group leader,
24710 and kills the whole process group on a timeout. However, this can be defeated
24711 if one of the processes starts a new process group.
24712
24713 .option timeout_defer pipe boolean false
24714 A timeout in a &(pipe)& transport, either in the command that the transport
24715 runs, or in a transport filter that is associated with it, is by default
24716 treated as a hard error, and the delivery fails. However, if &%timeout_defer%&
24717 is set true, both kinds of timeout become temporary errors, causing the
24718 delivery to be deferred.
24719
24720 .option umask pipe "octal integer" 022
24721 This specifies the umask setting for the subprocess that runs the command.
24722
24723
24724 .option use_bsmtp pipe boolean false
24725 .cindex "envelope sender"
24726 If this option is set true, the &(pipe)& transport writes messages in &"batch
24727 SMTP"& format, with the envelope sender and recipient(s) included as SMTP
24728 commands. If you want to include a leading HELO command with such messages,
24729 you can do so by setting the &%message_prefix%& option. See section
24730 &<<SECTbatchSMTP>>& for details of batch SMTP.
24731
24732 .option use_classresources pipe boolean false
24733 .cindex "class resources (BSD)"
24734 This option is available only when Exim is running on FreeBSD, NetBSD, or
24735 BSD/OS. If it is set true, the &[setclassresources()]& function is used to set
24736 resource limits when a &(pipe)& transport is run to perform a delivery. The
24737 limits for the uid under which the pipe is to run are obtained from the login
24738 class database.
24739
24740
24741 .option use_crlf pipe boolean false
24742 .cindex "carriage return"
24743 .cindex "linefeed"
24744 This option causes lines to be terminated with the two-character CRLF sequence
24745 (carriage return, linefeed) instead of just a linefeed character. In the case
24746 of batched SMTP, the byte sequence written to the pipe is then an exact image
24747 of what would be sent down a real SMTP connection.
24748
24749 The contents of the &%message_prefix%& and &%message_suffix%& options are
24750 written verbatim, so must contain their own carriage return characters if these
24751 are needed. When &%use_bsmtp%& is not set, the default values for both
24752 &%message_prefix%& and &%message_suffix%& end with a single linefeed, so their
24753 values must be changed to end with &`\r\n`& if &%use_crlf%& is set.
24754
24755
24756 .option use_shell pipe boolean false
24757 .vindex "&$pipe_addresses$&"
24758 If this option is set, it causes the command to be passed to &_/bin/sh_&
24759 instead of being run directly from the transport, as described in section
24760 &<<SECThowcommandrun>>&. This is less secure, but is needed in some situations
24761 where the command is expected to be run under a shell and cannot easily be
24762 modified. The &%allow_commands%& and &%restrict_to_path%& options, and the
24763 &`$pipe_addresses`& facility are incompatible with &%use_shell%&. The
24764 command is expanded as a single string, and handed to &_/bin/sh_& as data for
24765 its &%-c%& option.
24766
24767
24768
24769 .section "Using an external local delivery agent" "SECID143"
24770 .cindex "local delivery" "using an external agent"
24771 .cindex "&'procmail'&"
24772 .cindex "external local delivery"
24773 .cindex "delivery" "&'procmail'&"
24774 .cindex "delivery" "by external agent"
24775 The &(pipe)& transport can be used to pass all messages that require local
24776 delivery to a separate local delivery agent such as &%procmail%&. When doing
24777 this, care must be taken to ensure that the pipe is run under an appropriate
24778 uid and gid. In some configurations one wants this to be a uid that is trusted
24779 by the delivery agent to supply the correct sender of the message. It may be
24780 necessary to recompile or reconfigure the delivery agent so that it trusts an
24781 appropriate user. The following is an example transport and router
24782 configuration for &%procmail%&:
24783 .code
24784 # transport
24785 procmail_pipe:
24786   driver = pipe
24787   command = /usr/local/bin/procmail -d $local_part_data
24788   return_path_add
24789   delivery_date_add
24790   envelope_to_add
24791   check_string = "From "
24792   escape_string = ">From "
24793   umask = 077
24794   user = $local_part_data
24795   group = mail
24796
24797 # router
24798 procmail:
24799   driver = accept
24800   check_local_user
24801   transport = procmail_pipe
24802 .endd
24803 In this example, the pipe is run as the local user, but with the group set to
24804 &'mail'&. An alternative is to run the pipe as a specific user such as &'mail'&
24805 or &'exim'&, but in this case you must arrange for &%procmail%& to trust that
24806 user to supply a correct sender address. If you do not specify either a
24807 &%group%& or a &%user%& option, the pipe command is run as the local user. The
24808 home directory is the user's home directory by default.
24809
24810 &*Note*&: The command that the pipe transport runs does &'not'& begin with
24811 .code
24812 IFS=" "
24813 .endd
24814 as shown in some &%procmail%& documentation, because Exim does not by default
24815 use a shell to run pipe commands.
24816
24817 .cindex "Cyrus"
24818 The next example shows a transport and a router for a system where local
24819 deliveries are handled by the Cyrus IMAP server.
24820 .code
24821 # transport
24822 local_delivery_cyrus:
24823   driver = pipe
24824   command = /usr/cyrus/bin/deliver \
24825             -m ${substr_1:$local_part_suffix} -- $local_part
24826   user = cyrus
24827   group = mail
24828   return_output
24829   log_output
24830   message_prefix =
24831   message_suffix =
24832
24833 # router
24834 local_user_cyrus:
24835   driver = accept
24836   check_local_user
24837   local_part_suffix = .*
24838   transport = local_delivery_cyrus
24839 .endd
24840 Note the unsetting of &%message_prefix%& and &%message_suffix%&, and the use of
24841 &%return_output%& to cause any text written by Cyrus to be returned to the
24842 sender.
24843 .ecindex IIDpiptra1
24844 .ecindex IIDpiptra2
24845
24846
24847 . ////////////////////////////////////////////////////////////////////////////
24848 . ////////////////////////////////////////////////////////////////////////////
24849
24850 .chapter "The smtp transport" "CHAPsmtptrans"
24851 .scindex IIDsmttra1 "transports" "&(smtp)&"
24852 .scindex IIDsmttra2 "&(smtp)& transport"
24853 The &(smtp)& transport delivers messages over TCP/IP connections using the SMTP
24854 or LMTP protocol. The list of hosts to try can either be taken from the address
24855 that is being processed (having been set up by the router), or specified
24856 explicitly for the transport. Timeout and retry processing (see chapter
24857 &<<CHAPretry>>&) is applied to each IP address independently.
24858
24859
24860 .section "Multiple messages on a single connection" "SECID144"
24861 The sending of multiple messages over a single TCP/IP connection can arise in
24862 two ways:
24863
24864 .ilist
24865 If a message contains more than &%max_rcpt%& (see below) addresses that are
24866 routed to the same host, more than one copy of the message has to be sent to
24867 that host. In this situation, multiple copies may be sent in a single run of
24868 the &(smtp)& transport over a single TCP/IP connection. (What Exim actually
24869 does when it has too many addresses to send in one message also depends on the
24870 value of the global &%remote_max_parallel%& option. Details are given in
24871 section &<<SECToutSMTPTCP>>&.)
24872 .next
24873 .cindex "hints database" "remembering routing"
24874 When a message has been successfully delivered over a TCP/IP connection, Exim
24875 looks in its hints database to see if there are any other messages awaiting a
24876 connection to the same host. If there are, a new delivery process is started
24877 for one of them, and the current TCP/IP connection is passed on to it. The new
24878 process may in turn send multiple copies and possibly create yet another
24879 process.
24880 .endlist
24881
24882
24883 For each copy sent over the same TCP/IP connection, a sequence counter is
24884 incremented, and if it ever gets to the value of &%connection_max_messages%&,
24885 no further messages are sent over that connection.
24886
24887
24888
24889 .section "Use of the $host and $host_address variables" "SECID145"
24890 .vindex "&$host$&"
24891 .vindex "&$host_address$&"
24892 At the start of a run of the &(smtp)& transport, the values of &$host$& and
24893 &$host_address$& are the name and IP address of the first host on the host list
24894 passed by the router. However, when the transport is about to connect to a
24895 specific host, and while it is connected to that host, &$host$& and
24896 &$host_address$& are set to the values for that host. These are the values
24897 that are in force when the &%helo_data%&, &%hosts_try_auth%&, &%interface%&,
24898 &%serialize_hosts%&, and the various TLS options are expanded.
24899
24900
24901 .section "Use of $tls_cipher and $tls_peerdn" "usecippeer"
24902 .vindex &$tls_bits$&
24903 .vindex &$tls_cipher$&
24904 .vindex &$tls_peerdn$&
24905 .vindex &$tls_sni$&
24906 At the start of a run of the &(smtp)& transport, the values of &$tls_bits$&,
24907 &$tls_cipher$&, &$tls_peerdn$& and &$tls_sni$&
24908 are the values that were set when the message was received.
24909 These are the values that are used for options that are expanded before any
24910 SMTP connections are made. Just before each connection is made, these four
24911 variables are emptied. If TLS is subsequently started, they are set to the
24912 appropriate values for the outgoing connection, and these are the values that
24913 are in force when any authenticators are run and when the
24914 &%authenticated_sender%& option is expanded.
24915
24916 These variables are deprecated in favour of &$tls_in_cipher$& et. al.
24917 and will be removed in a future release.
24918
24919
24920 .section "Private options for smtp" "SECID146"
24921 .cindex "options" "&(smtp)& transport"
24922 The private options of the &(smtp)& transport are as follows:
24923
24924
24925 .option address_retry_include_sender smtp boolean true
24926 .cindex "4&'xx'& responses" "retrying after"
24927 When an address is delayed because of a 4&'xx'& response to a RCPT command, it
24928 is the combination of sender and recipient that is delayed in subsequent queue
24929 runs until the retry time is reached. You can delay the recipient without
24930 reference to the sender (which is what earlier versions of Exim did), by
24931 setting &%address_retry_include_sender%& false. However, this can lead to
24932 problems with servers that regularly issue 4&'xx'& responses to RCPT commands.
24933
24934 .option allow_localhost smtp boolean false
24935 .cindex "local host" "sending to"
24936 .cindex "fallback" "hosts specified on transport"
24937 When a host specified in &%hosts%& or &%fallback_hosts%& (see below) turns out
24938 to be the local host, or is listed in &%hosts_treat_as_local%&, delivery is
24939 deferred by default. However, if &%allow_localhost%& is set, Exim goes on to do
24940 the delivery anyway. This should be used only in special cases when the
24941 configuration ensures that no looping will result (for example, a differently
24942 configured Exim is listening on the port to which the message is sent).
24943
24944
24945 .option authenticated_sender smtp string&!! unset
24946 .cindex "Cyrus"
24947 When Exim has authenticated as a client, or if &%authenticated_sender_force%&
24948 is true, this option sets a value for the AUTH= item on outgoing MAIL commands,
24949 overriding any existing authenticated sender value. If the string expansion is
24950 forced to fail, the option is ignored. Other expansion failures cause delivery
24951 to be deferred. If the result of expansion is an empty string, that is also
24952 ignored.
24953
24954 The expansion happens after the outgoing connection has been made and TLS
24955 started, if required. This means that the &$host$&, &$host_address$&,
24956 &$tls_out_cipher$&, and &$tls_out_peerdn$& variables are set according to the
24957 particular connection.
24958
24959 If the SMTP session is not authenticated, the expansion of
24960 &%authenticated_sender%& still happens (and can cause the delivery to be
24961 deferred if it fails), but no AUTH= item is added to MAIL commands
24962 unless &%authenticated_sender_force%& is true.
24963
24964 This option allows you to use the &(smtp)& transport in LMTP mode to
24965 deliver mail to Cyrus IMAP and provide the proper local part as the
24966 &"authenticated sender"&, via a setting such as:
24967 .code
24968 authenticated_sender = $local_part
24969 .endd
24970 This removes the need for IMAP subfolders to be assigned special ACLs to
24971 allow direct delivery to those subfolders.
24972
24973 Because of expected uses such as that just described for Cyrus (when no
24974 domain is involved), there is no checking on the syntax of the provided
24975 value.
24976
24977
24978 .option authenticated_sender_force smtp boolean false
24979 If this option is set true, the &%authenticated_sender%& option's value
24980 is used for the AUTH= item on outgoing MAIL commands, even if Exim has not
24981 authenticated as a client.
24982
24983
24984 .option command_timeout smtp time 5m
24985 This sets a timeout for receiving a response to an SMTP command that has been
24986 sent out. It is also used when waiting for the initial banner line from the
24987 remote host. Its value must not be zero.
24988
24989
24990 .option connect_timeout smtp time 5m
24991 This sets a timeout for the &[connect()]& function, which sets up a TCP/IP call
24992 to a remote host. A setting of zero allows the system timeout (typically
24993 several minutes) to act. To have any effect, the value of this option must be
24994 less than the system timeout. However, it has been observed that on some
24995 systems there is no system timeout, which is why the default value for this
24996 option is 5 minutes, a value recommended by RFC 1123.
24997
24998
24999 .option connection_max_messages smtp integer 500
25000 .cindex "SMTP" "passed connection"
25001 .cindex "SMTP" "multiple deliveries"
25002 .cindex "multiple SMTP deliveries"
25003 This controls the maximum number of separate message deliveries that are sent
25004 over a single TCP/IP connection. If the value is zero, there is no limit.
25005 For testing purposes, this value can be overridden by the &%-oB%& command line
25006 option.
25007
25008
25009 .option dane_require_tls_ciphers smtp string&!! unset
25010 .cindex "TLS" "requiring specific ciphers for DANE"
25011 .cindex "cipher" "requiring specific"
25012 .cindex DANE "TLS ciphers"
25013 This option may be used to override &%tls_require_ciphers%& for connections
25014 where DANE has been determined to be in effect.
25015 If not set, then &%tls_require_ciphers%& will be used.
25016 Normal SMTP delivery is not able to make strong demands of TLS cipher
25017 configuration, because delivery will fall back to plaintext.  Once DANE has
25018 been determined to be in effect, there is no plaintext fallback and making the
25019 TLS cipherlist configuration stronger will increase security, rather than
25020 counter-intuitively decreasing it.
25021 If the option expands to be empty or is forced to fail, then it will
25022 be treated as unset and &%tls_require_ciphers%& will be used instead.
25023
25024
25025 .option data_timeout smtp time 5m
25026 This sets a timeout for the transmission of each block in the data portion of
25027 the message. As a result, the overall timeout for a message depends on the size
25028 of the message. Its value must not be zero. See also &%final_timeout%&.
25029
25030
25031 .option dkim_canon smtp string&!! unset
25032 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25033 .option dkim_domain smtp string list&!! unset
25034 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25035 .option dkim_hash smtp string&!! sha256
25036 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25037 .option dkim_identity smtp string&!! unset
25038 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25039 .option dkim_private_key smtp string&!! unset
25040 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25041 .option dkim_selector smtp string&!! unset
25042 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25043 .option dkim_strict smtp string&!! unset
25044 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25045 .option dkim_sign_headers smtp string&!! "per RFC"
25046 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25047 .option dkim_timestamps smtp string&!! unset
25048 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25049
25050
25051 .option delay_after_cutoff smtp boolean true
25052 .cindex "final cutoff" "retries, controlling"
25053 .cindex retry "final cutoff"
25054 This option controls what happens when all remote IP addresses for a given
25055 domain have been inaccessible for so long that they have passed their retry
25056 cutoff times.
25057
25058 In the default state, if the next retry time has not been reached for any of
25059 them, the address is bounced without trying any deliveries. In other words,
25060 Exim delays retrying an IP address after the final cutoff time until a new
25061 retry time is reached, and can therefore bounce an address without ever trying
25062 a delivery, when machines have been down for a long time. Some people are
25063 unhappy at this prospect, so...
25064
25065 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
25066 addresses are past their final cutoff time, Exim tries to deliver to those
25067 IP addresses that have not been tried since the message arrived. If there are
25068 none, of if they all fail, the address is bounced. In other words, it does not
25069 delay when a new message arrives, but immediately tries those expired IP
25070 addresses that haven't been tried since the message arrived. If there is a
25071 continuous stream of messages for the dead hosts, unsetting
25072 &%delay_after_cutoff%& means that there will be many more attempts to deliver
25073 to them.
25074
25075
25076 .option dns_qualify_single smtp boolean true
25077 If the &%hosts%& or &%fallback_hosts%& option is being used,
25078 and the &%gethostbyname%& option is false,
25079 the RES_DEFNAMES resolver option is set. See the &%qualify_single%& option
25080 in chapter &<<CHAPdnslookup>>& for more details.
25081
25082
25083 .option dns_search_parents smtp boolean false
25084 If the &%hosts%& or &%fallback_hosts%& option is being used, and the
25085 &%gethostbyname%& option is false, the RES_DNSRCH resolver option is set.
25086 See the &%search_parents%& option in chapter &<<CHAPdnslookup>>& for more
25087 details.
25088
25089
25090 .option dnssec_request_domains smtp "domain list&!!" *
25091 .cindex "MX record" "security"
25092 .cindex "DNSSEC" "MX lookup"
25093 .cindex "security" "MX lookup"
25094 .cindex "DNS" "DNSSEC"
25095 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
25096 the dnssec request bit set. Setting this transport option is only useful if the
25097 transport overrides or sets the host names. See the &%dnssec_request_domains%&
25098 router option.
25099
25100
25101
25102 .option dnssec_require_domains smtp "domain list&!!" unset
25103 .cindex "MX record" "security"
25104 .cindex "DNSSEC" "MX lookup"
25105 .cindex "security" "MX lookup"
25106 .cindex "DNS" "DNSSEC"
25107 DNS lookups for domains matching &%dnssec_require_domains%& will be done with
25108 the dnssec request bit set.  Setting this transport option is only
25109 useful if the transport overrides or sets the host names. See the
25110 &%dnssec_require_domains%& router option.
25111
25112
25113
25114 .option dscp smtp string&!! unset
25115 .cindex "DCSP" "outbound"
25116 This option causes the DSCP value associated with a socket to be set to one
25117 of a number of fixed strings or to numeric value.
25118 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
25119 Common values include &`throughput`&, &`mincost`&, and on newer systems
25120 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
25121
25122 The outbound packets from Exim will be marked with this value in the header
25123 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
25124 that these values will have any effect, not be stripped by networking
25125 equipment, or do much of anything without cooperation with your Network
25126 Engineer and those of all network operators between the source and destination.
25127
25128
25129 .option fallback_hosts smtp "string list" unset
25130 .cindex "fallback" "hosts specified on transport"
25131 String expansion is not applied to this option. The argument must be a
25132 colon-separated list of host names or IP addresses, optionally also including
25133 port numbers, though the separator can be changed, as described in section
25134 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
25135 item in a &%route_list%& setting for the &(manualroute)& router, as described
25136 in section &<<SECTformatonehostitem>>&.
25137
25138 Fallback hosts can also be specified on routers, which associate them with the
25139 addresses they process. As for the &%hosts%& option without &%hosts_override%&,
25140 &%fallback_hosts%& specified on the transport is used only if the address does
25141 not have its own associated fallback host list. Unlike &%hosts%&, a setting of
25142 &%fallback_hosts%& on an address is not overridden by &%hosts_override%&.
25143 However, &%hosts_randomize%& does apply to fallback host lists.
25144
25145 If Exim is unable to deliver to any of the hosts for a particular address, and
25146 the errors are not permanent rejections, the address is put on a separate
25147 transport queue with its host list replaced by the fallback hosts, unless the
25148 address was routed via MX records and the current host was in the original MX
25149 list. In that situation, the fallback host list is not used.
25150
25151 Once normal deliveries are complete, the fallback queue is delivered by
25152 re-running the same transports with the new host lists. If several failing
25153 addresses have the same fallback hosts (and &%max_rcpt%& permits it), a single
25154 copy of the message is sent.
25155
25156 The resolution of the host names on the fallback list is controlled by the
25157 &%gethostbyname%& option, as for the &%hosts%& option. Fallback hosts apply
25158 both to cases when the host list comes with the address and when it is taken
25159 from &%hosts%&. This option provides a &"use a smart host only if delivery
25160 fails"& facility.
25161
25162
25163 .option final_timeout smtp time 10m
25164 This is the timeout that applies while waiting for the response to the final
25165 line containing just &"."& that terminates a message. Its value must not be
25166 zero.
25167
25168 .option gethostbyname smtp boolean false
25169 If this option is true when the &%hosts%& and/or &%fallback_hosts%& options are
25170 being used, names are looked up using &[gethostbyname()]&
25171 (or &[getipnodebyname()]& when available)
25172 instead of using the DNS. Of course, that function may in fact use the DNS, but
25173 it may also consult other sources of information such as &_/etc/hosts_&.
25174
25175 .option gnutls_compat_mode smtp boolean unset
25176 This option controls whether GnuTLS is used in compatibility mode in an Exim
25177 server. This reduces security slightly, but improves interworking with older
25178 implementations of TLS.
25179
25180 .option helo_data smtp string&!! "see below"
25181 .cindex "HELO" "argument, setting"
25182 .cindex "EHLO" "argument, setting"
25183 .cindex "LHLO argument setting"
25184 The value of this option is expanded after a connection to a another host has
25185 been set up. The result is used as the argument for the EHLO, HELO, or LHLO
25186 command that starts the outgoing SMTP or LMTP session. The default value of the
25187 option is:
25188 .code
25189 $primary_hostname
25190 .endd
25191 During the expansion, the variables &$host$& and &$host_address$& are set to
25192 the identity of the remote host, and the variables &$sending_ip_address$& and
25193 &$sending_port$& are set to the local IP address and port number that are being
25194 used. These variables can be used to generate different values for different
25195 servers or different local IP addresses. For example, if you want the string
25196 that is used for &%helo_data%& to be obtained by a DNS lookup of the outgoing
25197 interface address, you could use this:
25198 .code
25199 helo_data = ${lookup dnsdb{ptr=$sending_ip_address}{$value}\
25200   {$primary_hostname}}
25201 .endd
25202 The use of &%helo_data%& applies both to sending messages and when doing
25203 callouts.
25204
25205 .option hosts smtp "string list&!!" unset
25206 Hosts are associated with an address by a router such as &(dnslookup)&, which
25207 finds the hosts by looking up the address domain in the DNS, or by
25208 &(manualroute)&, which has lists of hosts in its configuration. However,
25209 email addresses can be passed to the &(smtp)& transport by any router, and not
25210 all of them can provide an associated list of hosts.
25211
25212 The &%hosts%& option specifies a list of hosts to be used if the address being
25213 processed does not have any hosts associated with it. The hosts specified by
25214 &%hosts%& are also used, whether or not the address has its own hosts, if
25215 &%hosts_override%& is set.
25216
25217 The string is first expanded, before being interpreted as a colon-separated
25218 list of host names or IP addresses, possibly including port numbers. The
25219 separator may be changed to something other than colon, as described in section
25220 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
25221 item in a &%route_list%& setting for the &(manualroute)& router, as described
25222 in section &<<SECTformatonehostitem>>&. However, note that the &`/MX`& facility
25223 of the &(manualroute)& router is not available here.
25224
25225 If the expansion fails, delivery is deferred. Unless the failure was caused by
25226 the inability to complete a lookup, the error is logged to the panic log as
25227 well as the main log. Host names are looked up either by searching directly for
25228 address records in the DNS or by calling &[gethostbyname()]& (or
25229 &[getipnodebyname()]& when available), depending on the setting of the
25230 &%gethostbyname%& option. When Exim is compiled with IPv6 support, if a host
25231 that is looked up in the DNS has both IPv4 and IPv6 addresses, both types of
25232 address are used.
25233
25234 During delivery, the hosts are tried in order, subject to their retry status,
25235 unless &%hosts_randomize%& is set.
25236
25237
25238 .option hosts_avoid_esmtp smtp "host list&!!" unset
25239 .cindex "ESMTP, avoiding use of"
25240 .cindex "HELO" "forcing use of"
25241 .cindex "EHLO" "avoiding use of"
25242 .cindex "PIPELINING" "avoiding the use of"
25243 This option is for use with broken hosts that announce ESMTP facilities (for
25244 example, PIPELINING) and then fail to implement them properly. When a host
25245 matches &%hosts_avoid_esmtp%&, Exim sends HELO rather than EHLO at the
25246 start of the SMTP session. This means that it cannot use any of the ESMTP
25247 facilities such as AUTH, PIPELINING, SIZE, and STARTTLS.
25248
25249
25250 .option hosts_avoid_pipelining smtp "host list&!!" unset
25251 .cindex "PIPELINING" "avoiding the use of"
25252 .cindex "ESMTP extensions" PIPELINING
25253 Exim will not use the ESMTP PIPELINING extension when delivering to any host
25254 that matches this list, even if the server host advertises PIPELINING support.
25255
25256 .option hosts_pipe_connect smtp "host list&!!" unset
25257 .cindex "pipelining" "early connection"
25258 .cindex "pipelining" PIPE_CONNECT
25259 If Exim is built with the SUPPORT_PIPE_CONNECT build option
25260 this option controls which to hosts the facility watched for
25261 and recorded, and used for subsequent connections.
25262
25263 The retry hints database is used for the record,
25264 and records are subject to the &%retry_data_expire%& option.
25265 When used, the pipelining saves on roundtrip times.
25266 It also turns SMTP into a client-first protocol
25267 so combines well with TCP Fast Open.
25268
25269 See also the &%pipelining_connect_advertise_hosts%& main option.
25270
25271 Note:
25272 When the facility is used, the transport &%helo_data%& option
25273 will be expanded before the &$sending_ip_address$& variable
25274 is filled in.
25275 A check is made for the use of that variable, without the
25276 presence of a &"def:"& test on it, but suitably complex coding
25277 can avoid the check and produce unexpected results.
25278 You have been warned.
25279
25280
25281 .option hosts_avoid_tls smtp "host list&!!" unset
25282 .cindex "TLS" "avoiding for certain hosts"
25283 Exim will not try to start a TLS session when delivering to any host that
25284 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
25285
25286 .option hosts_verify_avoid_tls smtp "host list&!!" unset
25287 .cindex "TLS" "avoiding for certain hosts"
25288 Exim will not try to start a TLS session for a verify callout,
25289 or when delivering in cutthrough mode,
25290 to any host that matches this list.
25291
25292
25293 .option hosts_max_try smtp integer 5
25294 .cindex "host" "maximum number to try"
25295 .cindex "limit" "number of hosts tried"
25296 .cindex "limit" "number of MX tried"
25297 .cindex "MX record" "maximum tried"
25298 This option limits the number of IP addresses that are tried for any one
25299 delivery in cases where there are temporary delivery errors. Section
25300 &<<SECTvalhosmax>>& describes in detail how the value of this option is used.
25301
25302
25303 .option hosts_max_try_hardlimit smtp integer 50
25304 This is an additional check on the maximum number of IP addresses that Exim
25305 tries for any one delivery. Section &<<SECTvalhosmax>>& describes its use and
25306 why it exists.
25307
25308
25309
25310 .option hosts_nopass_tls smtp "host list&!!" unset
25311 .cindex "TLS" "passing connection"
25312 .cindex "multiple SMTP deliveries"
25313 .cindex "TLS" "multiple message deliveries"
25314 For any host that matches this list, a connection on which a TLS session has
25315 been started will not be passed to a new delivery process for sending another
25316 message on the same connection. See section &<<SECTmulmessam>>& for an
25317 explanation of when this might be needed.
25318
25319 .option hosts_noproxy_tls smtp "host list&!!" unset
25320 .cindex "TLS" "passing connection"
25321 .cindex "multiple SMTP deliveries"
25322 .cindex "TLS" "multiple message deliveries"
25323 For any host that matches this list, a TLS session which has
25324 been started will not be passed to a new delivery process for sending another
25325 message on the same session.
25326
25327 The traditional implementation closes down TLS and re-starts it in the new
25328 process, on the same open TCP connection, for each successive message
25329 sent.  If permitted by this option a pipe to to the new process is set up
25330 instead, and the original process maintains the TLS connection and proxies
25331 the SMTP connection from and to the new process and any subsequents.
25332 The new process has no access to TLS information, so cannot include it in
25333 logging.
25334
25335
25336
25337 .option hosts_override smtp boolean false
25338 If this option is set and the &%hosts%& option is also set, any hosts that are
25339 attached to the address are ignored, and instead the hosts specified by the
25340 &%hosts%& option are always used. This option does not apply to
25341 &%fallback_hosts%&.
25342
25343
25344 .option hosts_randomize smtp boolean false
25345 .cindex "randomized host list"
25346 .cindex "host" "list of; randomized"
25347 .cindex "fallback" "randomized hosts"
25348 If this option is set, and either the list of hosts is taken from the
25349 &%hosts%& or the &%fallback_hosts%& option, or the hosts supplied by the router
25350 were not obtained from MX records (this includes fallback hosts from the
25351 router), and were not randomized by the router, the order of trying the hosts
25352 is randomized each time the transport runs. Randomizing the order of a host
25353 list can be used to do crude load sharing.
25354
25355 When &%hosts_randomize%& is true, a host list may be split into groups whose
25356 order is separately randomized. This makes it possible to set up MX-like
25357 behaviour. The boundaries between groups are indicated by an item that is just
25358 &`+`& in the host list. For example:
25359 .code
25360 hosts = host1:host2:host3:+:host4:host5
25361 .endd
25362 The order of the first three hosts and the order of the last two hosts is
25363 randomized for each use, but the first three always end up before the last two.
25364 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored.
25365
25366 .option hosts_require_auth smtp "host list&!!" unset
25367 .cindex "authentication" "required by client"
25368 This option provides a list of servers for which authentication must succeed
25369 before Exim will try to transfer a message. If authentication fails for
25370 servers which are not in this list, Exim tries to send unauthenticated. If
25371 authentication fails for one of these servers, delivery is deferred. This
25372 temporary error is detectable in the retry rules, so it can be turned into a
25373 hard failure if required. See also &%hosts_try_auth%&, and chapter
25374 &<<CHAPSMTPAUTH>>& for details of authentication.
25375
25376
25377 .option hosts_request_ocsp smtp "host list&!!" *
25378 .cindex "TLS" "requiring for certain servers"
25379 Exim will request a Certificate Status on a
25380 TLS session for any host that matches this list.
25381 &%tls_verify_certificates%& should also be set for the transport.
25382
25383 .option hosts_require_dane smtp "host list&!!" unset
25384 .cindex DANE "transport options"
25385 .cindex DANE "requiring for certain servers"
25386 If built with DANE support, Exim  will require that a DNSSEC-validated
25387 TLSA record is present for any host matching the list,
25388 and that a DANE-verified TLS connection is made. See
25389 the &%dnssec_request_domains%& router and transport options.
25390 There will be no fallback to in-clear communication.
25391 See section &<<SECDANE>>&.
25392
25393 .option hosts_require_ocsp smtp "host list&!!" unset
25394 .cindex "TLS" "requiring for certain servers"
25395 Exim will request, and check for a valid Certificate Status being given, on a
25396 TLS session for any host that matches this list.
25397 &%tls_verify_certificates%& should also be set for the transport.
25398
25399 .option hosts_require_tls smtp "host list&!!" unset
25400 .cindex "TLS" "requiring for certain servers"
25401 Exim will insist on using a TLS session when delivering to any host that
25402 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
25403 &*Note*&: This option affects outgoing mail only. To insist on TLS for
25404 incoming messages, use an appropriate ACL.
25405
25406 .option hosts_try_auth smtp "host list&!!" unset
25407 .cindex "authentication" "optional in client"
25408 This option provides a list of servers to which, provided they announce
25409 authentication support, Exim will attempt to authenticate as a client when it
25410 connects. If authentication fails, Exim will try to transfer the message
25411 unauthenticated. See also &%hosts_require_auth%&, and chapter
25412 &<<CHAPSMTPAUTH>>& for details of authentication.
25413
25414 .option hosts_try_chunking smtp "host list&!!" *
25415 .cindex CHUNKING "enabling, in client"
25416 .cindex BDAT "SMTP command"
25417 .cindex "RFC 3030" "CHUNKING"
25418 This option provides a list of servers to which, provided they announce
25419 CHUNKING support, Exim will attempt to use BDAT commands rather than DATA.
25420 Unless DKIM signing is being done,
25421 BDAT will not be used in conjunction with a transport filter.
25422
25423 .option hosts_try_dane smtp "host list&!!" *
25424 .cindex DANE "transport options"
25425 .cindex DANE "attempting for certain servers"
25426 If built with DANE support, Exim  will require that a DNSSEC-validated
25427 TLSA record is present for any host matching the list,
25428 and that a DANE-verified TLS connection is made. See
25429 the &%dnssec_request_domains%& router and transport options.
25430 There will be no fallback to in-clear communication.
25431 See section &<<SECDANE>>&.
25432
25433 .option hosts_try_fastopen smtp "host list&!!" *
25434 .cindex "fast open, TCP" "enabling, in client"
25435 .cindex "TCP Fast Open" "enabling, in client"
25436 .cindex "RFC 7413" "TCP Fast Open"
25437 This option provides a list of servers to which, provided
25438 the facility is supported by this system, Exim will attempt to
25439 perform a TCP Fast Open.
25440 No data is sent on the SYN segment but, if the remote server also
25441 supports the facility, it can send its SMTP banner immediately after
25442 the SYN,ACK segment.  This can save up to one round-trip time.
25443
25444 The facility is only active for previously-contacted servers,
25445 as the initiator must present a cookie in the SYN segment.
25446
25447 On (at least some) current Linux distributions the facility must be enabled
25448 in the kernel by the sysadmin before the support is usable.
25449 There is no option for control of the server side; if the system supports
25450 it it is always enabled.  Note that lengthy operations in the connect ACL,
25451 such as DNSBL lookups, will still delay the emission of the SMTP banner.
25452
25453 .option hosts_try_prdr smtp "host list&!!" *
25454 .cindex "PRDR" "enabling, optional in client"
25455 .cindex "ESMTP extensions" PRDR
25456 This option provides a list of servers to which, provided they announce
25457 PRDR support, Exim will attempt to negotiate PRDR
25458 for multi-recipient messages.
25459 The option can usually be left as default.
25460
25461 .option interface smtp "string list&!!" unset
25462 .cindex "bind IP address"
25463 .cindex "IP address" "binding"
25464 .vindex "&$host$&"
25465 .vindex "&$host_address$&"
25466 This option specifies which interface to bind to when making an outgoing SMTP
25467 call. The value is an IP address, not an interface name such as
25468 &`eth0`&. Do not confuse this with the interface address that was used when a
25469 message was received, which is in &$received_ip_address$&, formerly known as
25470 &$interface_address$&. The name was changed to minimize confusion with the
25471 outgoing interface address. There is no variable that contains an outgoing
25472 interface address because, unless it is set by this option, its value is
25473 unknown.
25474
25475 During the expansion of the &%interface%& option the variables &$host$& and
25476 &$host_address$& refer to the host to which a connection is about to be made
25477 during the expansion of the string. Forced expansion failure, or an empty
25478 string result causes the option to be ignored. Otherwise, after expansion, the
25479 string must be a list of IP addresses, colon-separated by default, but the
25480 separator can be changed in the usual way (&<<SECTlistsepchange>>&).
25481 For example:
25482 .code
25483 interface = <; 192.168.123.123 ; 3ffe:ffff:836f::fe86:a061
25484 .endd
25485 The first interface of the correct type (IPv4 or IPv6) is used for the outgoing
25486 connection. If none of them are the correct type, the option is ignored. If
25487 &%interface%& is not set, or is ignored, the system's IP functions choose which
25488 interface to use if the host has more than one.
25489
25490
25491 .option keepalive smtp boolean true
25492 .cindex "keepalive" "on outgoing connection"
25493 This option controls the setting of SO_KEEPALIVE on outgoing TCP/IP socket
25494 connections. When set, it causes the kernel to probe idle connections
25495 periodically, by sending packets with &"old"& sequence numbers. The other end
25496 of the connection should send a acknowledgment if the connection is still okay
25497 or a reset if the connection has been aborted. The reason for doing this is
25498 that it has the beneficial effect of freeing up certain types of connection
25499 that can get stuck when the remote host is disconnected without tidying up the
25500 TCP/IP call properly. The keepalive mechanism takes several hours to detect
25501 unreachable hosts.
25502
25503
25504 .option lmtp_ignore_quota smtp boolean false
25505 .cindex "LMTP" "ignoring quota errors"
25506 If this option is set true when the &%protocol%& option is set to &"lmtp"&, the
25507 string &`IGNOREQUOTA`& is added to RCPT commands, provided that the LMTP server
25508 has advertised support for IGNOREQUOTA in its response to the LHLO command.
25509
25510 .option max_rcpt smtp integer 100
25511 .cindex "RCPT" "maximum number of outgoing"
25512 This option limits the number of RCPT commands that are sent in a single
25513 SMTP message transaction. Each set of addresses is treated independently, and
25514 so can cause parallel connections to the same host if &%remote_max_parallel%&
25515 permits this.
25516
25517
25518 .new
25519 .option message_linelength_limit smtp integer 998
25520 .cindex "line length" limit
25521 This option sets the maximum line length, in bytes, that the transport
25522 will send.  Any messages with lines exceeding the given value
25523 will fail and a failure-DSN ("bounce") message will if possible be returned
25524 to the sender.
25525 The default value is that defined by the SMTP standards.
25526
25527 It is generally wise to also check in the data ACL so that messages
25528 received via SMTP can be refused without producing a bounce.
25529 .wen
25530
25531
25532 .option multi_domain smtp boolean&!! true
25533 .vindex "&$domain$&"
25534 When this option is set, the &(smtp)& transport can handle a number of
25535 addresses containing a mixture of different domains provided they all resolve
25536 to the same list of hosts. Turning the option off restricts the transport to
25537 handling only one domain at a time. This is useful if you want to use
25538 &$domain$& in an expansion for the transport, because it is set only when there
25539 is a single domain involved in a remote delivery.
25540
25541 It is expanded per-address and can depend on any of
25542 &$address_data$&, &$domain_data$&, &$local_part_data$&,
25543 &$host$&, &$host_address$& and &$host_port$&.
25544
25545 .option port smtp string&!! "see below"
25546 .cindex "port" "sending TCP/IP"
25547 .cindex "TCP/IP" "setting outgoing port"
25548 This option specifies the TCP/IP port on the server to which Exim connects.
25549 &*Note:*& Do not confuse this with the port that was used when a message was
25550 received, which is in &$received_port$&, formerly known as &$interface_port$&.
25551 The name was changed to minimize confusion with the outgoing port. There is no
25552 variable that contains an outgoing port.
25553
25554 If the value of this option begins with a digit it is taken as a port number;
25555 otherwise it is looked up using &[getservbyname()]&. The default value is
25556 normally &"smtp"&,
25557 but if &%protocol%& is set to &"lmtp"& the default is &"lmtp"&
25558 and if &%protocol%& is set to &"smtps"& the default is &"smtps"&.
25559 If the expansion fails, or if a port number cannot be found, delivery
25560 is deferred.
25561
25562 Note that at least one Linux distribution has been seen failing
25563 to put &"smtps"& in its &"/etc/services"& file, resulting is such deferrals.
25564
25565
25566
25567 .option protocol smtp string smtp
25568 .cindex "LMTP" "over TCP/IP"
25569 .cindex "ssmtp protocol" "outbound"
25570 .cindex "TLS" "SSL-on-connect outbound"
25571 .vindex "&$port$&"
25572 If this option is set to &"lmtp"& instead of &"smtp"&, the default value for
25573 the &%port%& option changes to &"lmtp"&, and the transport operates the LMTP
25574 protocol (RFC 2033) instead of SMTP. This protocol is sometimes used for local
25575 deliveries into closed message stores. Exim also has support for running LMTP
25576 over a pipe to a local process &-- see chapter &<<CHAPLMTP>>&.
25577
25578 If this option is set to &"smtps"&, the default value for the &%port%& option
25579 changes to &"smtps"&, and the transport initiates TLS immediately after
25580 connecting, as an outbound SSL-on-connect, instead of using STARTTLS to upgrade.
25581 The Internet standards bodies used to strongly discourage use of this mode,
25582 but as of RFC 8314 it is perferred over STARTTLS for message submission
25583 (as distinct from MTA-MTA communication).
25584
25585
25586 .option retry_include_ip_address smtp boolean&!! true
25587 Exim normally includes both the host name and the IP address in the key it
25588 constructs for indexing retry data after a temporary delivery failure. This
25589 means that when one of several IP addresses for a host is failing, it gets
25590 tried periodically (controlled by the retry rules), but use of the other IP
25591 addresses is not affected.
25592
25593 However, in some dialup environments hosts are assigned a different IP address
25594 each time they connect. In this situation the use of the IP address as part of
25595 the retry key leads to undesirable behaviour. Setting this option false causes
25596 Exim to use only the host name.
25597 Since it is expanded it can be made to depend on the host or domain.
25598
25599
25600 .option serialize_hosts smtp "host list&!!" unset
25601 .cindex "serializing connections"
25602 .cindex "host" "serializing connections"
25603 Because Exim operates in a distributed manner, if several messages for the same
25604 host arrive at around the same time, more than one simultaneous connection to
25605 the remote host can occur. This is not usually a problem except when there is a
25606 slow link between the hosts. In that situation it may be helpful to restrict
25607 Exim to one connection at a time. This can be done by setting
25608 &%serialize_hosts%& to match the relevant hosts.
25609
25610 .cindex "hints database" "serializing deliveries to a host"
25611 Exim implements serialization by means of a hints database in which a record is
25612 written whenever a process connects to one of the restricted hosts. The record
25613 is deleted when the connection is completed. Obviously there is scope for
25614 records to get left lying around if there is a system or program crash. To
25615 guard against this, Exim ignores any records that are more than six hours old.
25616
25617 If you set up this kind of serialization, you should also arrange to delete the
25618 relevant hints database whenever your system reboots. The names of the files
25619 start with &_misc_& and they are kept in the &_spool/db_& directory. There
25620 may be one or two files, depending on the type of DBM in use. The same files
25621 are used for ETRN serialization.
25622
25623 See also the &%max_parallel%& generic transport option.
25624
25625
25626 .option size_addition smtp integer 1024
25627 .cindex "SIZE" "ESMTP extension"
25628 .cindex "message" "size issue for transport filter"
25629 .cindex "size" "of message"
25630 .cindex "transport" "filter"
25631 .cindex "filter" "transport filter"
25632 If a remote SMTP server indicates that it supports the SIZE option of the
25633 MAIL command, Exim uses this to pass over the message size at the start of
25634 an SMTP transaction. It adds the value of &%size_addition%& to the value it
25635 sends, to allow for headers and other text that may be added during delivery by
25636 configuration options or in a transport filter. It may be necessary to increase
25637 this if a lot of text is added to messages.
25638
25639 Alternatively, if the value of &%size_addition%& is set negative, it disables
25640 the use of the SIZE option altogether.
25641
25642
25643 .option socks_proxy smtp string&!! unset
25644 .cindex proxy SOCKS
25645 This option enables use of SOCKS proxies for connections made by the
25646 transport.  For details see section &<<SECTproxySOCKS>>&.
25647
25648
25649 .option tls_certificate smtp string&!! unset
25650 .cindex "TLS" "client certificate, location of"
25651 .cindex "certificate" "client, location of"
25652 .vindex "&$host$&"
25653 .vindex "&$host_address$&"
25654 The value of this option must be the absolute path to a file which contains the
25655 client's certificate, for possible use when sending a message over an encrypted
25656 connection. The values of &$host$& and &$host_address$& are set to the name and
25657 address of the server during the expansion. See chapter &<<CHAPTLS>>& for
25658 details of TLS.
25659
25660 &*Note*&: This option must be set if you want Exim to be able to use a TLS
25661 certificate when sending messages as a client. The global option of the same
25662 name specifies the certificate for Exim as a server; it is not automatically
25663 assumed that the same certificate should be used when Exim is operating as a
25664 client.
25665
25666
25667 .option tls_crl smtp string&!! unset
25668 .cindex "TLS" "client certificate revocation list"
25669 .cindex "certificate" "revocation list for client"
25670 This option specifies a certificate revocation list. The expanded value must
25671 be the name of a file that contains a CRL in PEM format.
25672
25673
25674 .option tls_dh_min_bits smtp integer 1024
25675 .cindex "TLS" "Diffie-Hellman minimum acceptable size"
25676 When establishing a TLS session, if a ciphersuite which uses Diffie-Hellman
25677 key agreement is negotiated, the server will provide a large prime number
25678 for use.  This option establishes the minimum acceptable size of that number.
25679 If the parameter offered by the server is too small, then the TLS handshake
25680 will fail.
25681
25682 Only supported when using GnuTLS.
25683
25684
25685 .option tls_privatekey smtp string&!! unset
25686 .cindex "TLS" "client private key, location of"
25687 .vindex "&$host$&"
25688 .vindex "&$host_address$&"
25689 The value of this option must be the absolute path to a file which contains the
25690 client's private key. This is used when sending a message over an encrypted
25691 connection using a client certificate. The values of &$host$& and
25692 &$host_address$& are set to the name and address of the server during the
25693 expansion. If this option is unset, or the expansion is forced to fail, or the
25694 result is an empty string, the private key is assumed to be in the same file as
25695 the certificate. See chapter &<<CHAPTLS>>& for details of TLS.
25696
25697
25698 .option tls_require_ciphers smtp string&!! unset
25699 .cindex "TLS" "requiring specific ciphers"
25700 .cindex "cipher" "requiring specific"
25701 .vindex "&$host$&"
25702 .vindex "&$host_address$&"
25703 The value of this option must be a list of permitted cipher suites, for use
25704 when setting up an outgoing encrypted connection. (There is a global option of
25705 the same name for controlling incoming connections.) The values of &$host$& and
25706 &$host_address$& are set to the name and address of the server during the
25707 expansion. See chapter &<<CHAPTLS>>& for details of TLS; note that this option
25708 is used in different ways by OpenSSL and GnuTLS (see sections
25709 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&). For GnuTLS, the order of the
25710 ciphers is a preference order.
25711
25712
25713 .new
25714 .option tls_resumption_hosts smtp "host list&!!" unset
25715 .cindex TLS resumption
25716 This option controls which connections to use the TLS resumption feature.
25717 See &<<SECTresumption>>& for details.
25718 .wen
25719
25720
25721
25722 .option tls_sni smtp string&!! unset
25723 .cindex "TLS" "Server Name Indication"
25724 .cindex "TLS" SNI
25725 .cindex SNI "setting in client"
25726 .vindex "&$tls_sni$&"
25727 If this option is set then it sets the $tls_out_sni variable and causes any
25728 TLS session to pass this value as the Server Name Indication extension to
25729 the remote side, which can be used by the remote side to select an appropriate
25730 certificate and private key for the session.
25731
25732 See &<<SECTtlssni>>& for more information.
25733
25734 Note that for OpenSSL, this feature requires a build of OpenSSL that supports
25735 TLS extensions.
25736
25737
25738
25739
25740 .option tls_tempfail_tryclear smtp boolean true
25741 .cindex "4&'xx'& responses" "to STARTTLS"
25742 When the server host is not in &%hosts_require_tls%&, and there is a problem in
25743 setting up a TLS session, this option determines whether or not Exim should try
25744 to deliver the message unencrypted. If it is set false, delivery to the
25745 current host is deferred; if there are other hosts, they are tried. If this
25746 option is set true, Exim attempts to deliver unencrypted after a 4&'xx'&
25747 response to STARTTLS. Also, if STARTTLS is accepted, but the subsequent
25748 TLS negotiation fails, Exim closes the current connection (because it is in an
25749 unknown state), opens a new one to the same host, and then tries the delivery
25750 in clear.
25751
25752
25753 .option tls_try_verify_hosts smtp "host list&!!" *
25754 .cindex "TLS" "server certificate verification"
25755 .cindex "certificate" "verification of server"
25756 This option gives a list of hosts for which, on encrypted connections,
25757 certificate verification will be tried but need not succeed.
25758 The &%tls_verify_certificates%& option must also be set.
25759 Note that unless the host is in this list
25760 TLS connections will be denied to hosts using self-signed certificates
25761 when &%tls_verify_certificates%& is matched.
25762 The &$tls_out_certificate_verified$& variable is set when
25763 certificate verification succeeds.
25764
25765
25766 .option tls_verify_cert_hostnames smtp "host list&!!" *
25767 .cindex "TLS" "server certificate hostname verification"
25768 .cindex "certificate" "verification of server"
25769 This option give a list of hosts for which,
25770 while verifying the server certificate,
25771 checks will be included on the host name
25772 (note that this will generally be the result of a DNS MX lookup)
25773 versus Subject and Subject-Alternate-Name fields.  Wildcard names are permitted
25774 limited to being the initial component of a 3-or-more component FQDN.
25775
25776 There is no equivalent checking on client certificates.
25777
25778
25779 .option tls_verify_certificates smtp string&!! system
25780 .cindex "TLS" "server certificate verification"
25781 .cindex "certificate" "verification of server"
25782 .vindex "&$host$&"
25783 .vindex "&$host_address$&"
25784 The value of this option must be either the
25785 word "system"
25786 or the absolute path to
25787 a file or directory containing permitted certificates for servers,
25788 for use when setting up an encrypted connection.
25789
25790 The "system" value for the option will use a location compiled into the SSL library.
25791 This is not available for GnuTLS versions preceding 3.0.20; a value of "system"
25792 is taken as empty and an explicit location
25793 must be specified.
25794
25795 The use of a directory for the option value is not available for GnuTLS versions
25796 preceding 3.3.6 and a single file must be used.
25797
25798 With OpenSSL the certificates specified
25799 explicitly
25800 either by file or directory
25801 are added to those given by the system default location.
25802
25803 The values of &$host$& and
25804 &$host_address$& are set to the name and address of the server during the
25805 expansion of this option. See chapter &<<CHAPTLS>>& for details of TLS.
25806
25807 For back-compatibility,
25808 if neither tls_verify_hosts nor tls_try_verify_hosts are set
25809 (a single-colon empty list counts as being set)
25810 and certificate verification fails the TLS connection is closed.
25811
25812
25813 .option tls_verify_hosts smtp "host list&!!" unset
25814 .cindex "TLS" "server certificate verification"
25815 .cindex "certificate" "verification of server"
25816 This option gives a list of hosts for which, on encrypted connections,
25817 certificate verification must succeed.
25818 The &%tls_verify_certificates%& option must also be set.
25819 If both this option and &%tls_try_verify_hosts%& are unset
25820 operation is as if this option selected all hosts.
25821
25822 .option utf8_downconvert smtp integer&!! -1
25823 .cindex utf8 "address downconversion"
25824 .cindex i18n "utf8 address downconversion"
25825 If built with internationalization support,
25826 this option controls conversion of UTF-8 in message envelope addresses
25827 to a-label form.
25828 If, after expansion, the value is 1, 0, or -1 then this value overrides
25829 any value previously set for the message.  Otherwise, any previously
25830 set value is used.  To permit use of a previous value,
25831 set this option to an empty string.
25832 For details on the values see section &<<SECTi18nMTA>>&.
25833
25834
25835
25836
25837 .section "How the limits for the number of hosts to try are used" &&&
25838          "SECTvalhosmax"
25839 .cindex "host" "maximum number to try"
25840 .cindex "limit" "hosts; maximum number tried"
25841 There are two options that are concerned with the number of hosts that are
25842 tried when an SMTP delivery takes place. They are &%hosts_max_try%& and
25843 &%hosts_max_try_hardlimit%&.
25844
25845
25846 The &%hosts_max_try%& option limits the number of hosts that are tried
25847 for a single delivery. However, despite the term &"host"& in its name, the
25848 option actually applies to each IP address independently. In other words, a
25849 multihomed host is treated as several independent hosts, just as it is for
25850 retrying.
25851
25852 Many of the larger ISPs have multiple MX records which often point to
25853 multihomed hosts. As a result, a list of a dozen or more IP addresses may be
25854 created as a result of routing one of these domains.
25855
25856 Trying every single IP address on such a long list does not seem sensible; if
25857 several at the top of the list fail, it is reasonable to assume there is some
25858 problem that is likely to affect all of them. Roughly speaking, the value of
25859 &%hosts_max_try%& is the maximum number that are tried before deferring the
25860 delivery. However, the logic cannot be quite that simple.
25861
25862 Firstly, IP addresses that are skipped because their retry times have not
25863 arrived do not count, and in addition, addresses that are past their retry
25864 limits are also not counted, even when they are tried. This means that when
25865 some IP addresses are past their retry limits, more than the value of
25866 &%hosts_max_retry%& may be tried. The reason for this behaviour is to ensure
25867 that all IP addresses are considered before timing out an email address (but
25868 see below for an exception).
25869
25870 Secondly, when the &%hosts_max_try%& limit is reached, Exim looks down the host
25871 list to see if there is a subsequent host with a different (higher valued) MX.
25872 If there is, that host is considered next, and the current IP address is used
25873 but not counted. This behaviour helps in the case of a domain with a retry rule
25874 that hardly ever delays any hosts, as is now explained:
25875
25876 Consider the case of a long list of hosts with one MX value, and a few with a
25877 higher MX value. If &%hosts_max_try%& is small (the default is 5) only a few
25878 hosts at the top of the list are tried at first. With the default retry rule,
25879 which specifies increasing retry times, the higher MX hosts are eventually
25880 tried when those at the top of the list are skipped because they have not
25881 reached their retry times.
25882
25883 However, it is common practice to put a fixed short retry time on domains for
25884 large ISPs, on the grounds that their servers are rarely down for very long.
25885 Unfortunately, these are exactly the domains that tend to resolve to long lists
25886 of hosts. The short retry time means that the lowest MX hosts are tried every
25887 time. The attempts may be in a different order because of random sorting, but
25888 without the special MX check, the higher MX hosts would never be tried until
25889 all the lower MX hosts had timed out (which might be several days), because
25890 there are always some lower MX hosts that have reached their retry times. With
25891 the special check, Exim considers at least one IP address from each MX value at
25892 every delivery attempt, even if the &%hosts_max_try%& limit has already been
25893 reached.
25894
25895 The above logic means that &%hosts_max_try%& is not a hard limit, and in
25896 particular, Exim normally eventually tries all the IP addresses before timing
25897 out an email address. When &%hosts_max_try%& was implemented, this seemed a
25898 reasonable thing to do. Recently, however, some lunatic DNS configurations have
25899 been set up with hundreds of IP addresses for some domains. It can
25900 take a very long time indeed for an address to time out in these cases.
25901
25902 The &%hosts_max_try_hardlimit%& option was added to help with this problem.
25903 Exim never tries more than this number of IP addresses; if it hits this limit
25904 and they are all timed out, the email address is bounced, even though not all
25905 possible IP addresses have been tried.
25906 .ecindex IIDsmttra1
25907 .ecindex IIDsmttra2
25908
25909
25910
25911
25912
25913 . ////////////////////////////////////////////////////////////////////////////
25914 . ////////////////////////////////////////////////////////////////////////////
25915
25916 .chapter "Address rewriting" "CHAPrewrite"
25917 .scindex IIDaddrew "rewriting" "addresses"
25918 There are some circumstances in which Exim automatically rewrites domains in
25919 addresses. The two most common are when an address is given without a domain
25920 (referred to as an &"unqualified address"&) or when an address contains an
25921 abbreviated domain that is expanded by DNS lookup.
25922
25923 Unqualified envelope addresses are accepted only for locally submitted
25924 messages, or for messages that are received from hosts matching
25925 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
25926 appropriate. Unqualified addresses in header lines are qualified if they are in
25927 locally submitted messages, or messages from hosts that are permitted to send
25928 unqualified envelope addresses. Otherwise, unqualified addresses in header
25929 lines are neither qualified nor rewritten.
25930
25931 One situation in which Exim does &'not'& automatically rewrite a domain is
25932 when it is the name of a CNAME record in the DNS. The older RFCs suggest that
25933 such a domain should be rewritten using the &"canonical"& name, and some MTAs
25934 do this. The new RFCs do not contain this suggestion.
25935
25936
25937 .section "Explicitly configured address rewriting" "SECID147"
25938 This chapter describes the rewriting rules that can be used in the
25939 main rewrite section of the configuration file, and also in the generic
25940 &%headers_rewrite%& option that can be set on any transport.
25941
25942 Some people believe that configured address rewriting is a Mortal Sin.
25943 Others believe that life is not possible without it. Exim provides the
25944 facility; you do not have to use it.
25945
25946 The main rewriting rules that appear in the &"rewrite"& section of the
25947 configuration file are applied to addresses in incoming messages, both envelope
25948 addresses and addresses in header lines. Each rule specifies the types of
25949 address to which it applies.
25950
25951 Whether or not addresses in header lines are rewritten depends on the origin of
25952 the headers and the type of rewriting. Global rewriting, that is, rewriting
25953 rules from the rewrite section of the configuration file, is applied only to
25954 those headers that were received with the message. Header lines that are added
25955 by ACLs or by a system filter or by individual routers or transports (which
25956 are specific to individual recipient addresses) are not rewritten by the global
25957 rules.
25958
25959 Rewriting at transport time, by means of the &%headers_rewrite%& option,
25960 applies all headers except those added by routers and transports. That is, as
25961 well as the headers that were received with the message, it also applies to
25962 headers that were added by an ACL or a system filter.
25963
25964
25965 In general, rewriting addresses from your own system or domain has some
25966 legitimacy. Rewriting other addresses should be done only with great care and
25967 in special circumstances. The author of Exim believes that rewriting should be
25968 used sparingly, and mainly for &"regularizing"& addresses in your own domains.
25969 Although it can sometimes be used as a routing tool, this is very strongly
25970 discouraged.
25971
25972 There are two commonly encountered circumstances where rewriting is used, as
25973 illustrated by these examples:
25974
25975 .ilist
25976 The company whose domain is &'hitch.fict.example'& has a number of hosts that
25977 exchange mail with each other behind a firewall, but there is only a single
25978 gateway to the outer world. The gateway rewrites &'*.hitch.fict.example'& as
25979 &'hitch.fict.example'& when sending mail off-site.
25980 .next
25981 A host rewrites the local parts of its own users so that, for example,
25982 &'fp42@hitch.fict.example'& becomes &'Ford.Prefect@hitch.fict.example'&.
25983 .endlist
25984
25985
25986
25987 .section "When does rewriting happen?" "SECID148"
25988 .cindex "rewriting" "timing of"
25989 .cindex "&ACL;" "rewriting addresses in"
25990 Configured address rewriting can take place at several different stages of a
25991 message's processing.
25992
25993 .vindex "&$sender_address$&"
25994 At the start of an ACL for MAIL, the sender address may have been rewritten
25995 by a special SMTP-time rewrite rule (see section &<<SECTrewriteS>>&), but no
25996 ordinary rewrite rules have yet been applied. If, however, the sender address
25997 is verified in the ACL, it is rewritten before verification, and remains
25998 rewritten thereafter. The subsequent value of &$sender_address$& is the
25999 rewritten address. This also applies if sender verification happens in a
26000 RCPT ACL. Otherwise, when the sender address is not verified, it is
26001 rewritten as soon as a message's header lines have been received.
26002
26003 .vindex "&$domain$&"
26004 .vindex "&$local_part$&"
26005 Similarly, at the start of an ACL for RCPT, the current recipient's address
26006 may have been rewritten by a special SMTP-time rewrite rule, but no ordinary
26007 rewrite rules have yet been applied to it. However, the behaviour is different
26008 from the sender address when a recipient is verified. The address is rewritten
26009 for the verification, but the rewriting is not remembered at this stage. The
26010 value of &$local_part$& and &$domain$& after verification are always the same
26011 as they were before (that is, they contain the unrewritten &-- except for
26012 SMTP-time rewriting &-- address).
26013
26014 As soon as a message's header lines have been received, all the envelope
26015 recipient addresses are permanently rewritten, and rewriting is also applied to
26016 the addresses in the header lines (if configured). This happens before adding
26017 any header lines that were specified in MAIL or RCPT ACLs, and
26018 .cindex "&[local_scan()]& function" "address rewriting; timing of"
26019 before the DATA ACL and &[local_scan()]& functions are run.
26020
26021 When an address is being routed, either for delivery or for verification,
26022 rewriting is applied immediately to child addresses that are generated by
26023 redirection, unless &%no_rewrite%& is set on the router.
26024
26025 .cindex "envelope from"
26026 .cindex "envelope sender" "rewriting at transport time"
26027 .cindex "rewriting" "at transport time"
26028 .cindex "header lines" "rewriting at transport time"
26029 At transport time, additional rewriting of addresses in header lines can be
26030 specified by setting the generic &%headers_rewrite%& option on a transport.
26031 This option contains rules that are identical in form to those in the rewrite
26032 section of the configuration file. They are applied to the original message
26033 header lines and any that were added by ACLs or a system filter. They are not
26034 applied to header lines that are added by routers or the transport.
26035
26036 The outgoing envelope sender can be rewritten by means of the &%return_path%&
26037 transport option. However, it is not possible to rewrite envelope recipients at
26038 transport time.
26039
26040
26041
26042
26043 .section "Testing the rewriting rules that apply on input" "SECID149"
26044 .cindex "rewriting" "testing"
26045 .cindex "testing" "rewriting"
26046 Exim's input rewriting configuration appears in a part of the runtime
26047 configuration file headed by &"begin rewrite"&. It can be tested by the
26048 &%-brw%& command line option. This takes an address (which can be a full RFC
26049 2822 address) as its argument. The output is a list of how the address would be
26050 transformed by the rewriting rules for each of the different places it might
26051 appear in an incoming message, that is, for each different header and for the
26052 envelope sender and recipient fields. For example,
26053 .code
26054 exim -brw ph10@exim.workshop.example
26055 .endd
26056 might produce the output
26057 .code
26058 sender: Philip.Hazel@exim.workshop.example
26059 from: Philip.Hazel@exim.workshop.example
26060 to: ph10@exim.workshop.example
26061 cc: ph10@exim.workshop.example
26062 bcc: ph10@exim.workshop.example
26063 reply-to: Philip.Hazel@exim.workshop.example
26064 env-from: Philip.Hazel@exim.workshop.example
26065 env-to: ph10@exim.workshop.example
26066 .endd
26067 which shows that rewriting has been set up for that address when used in any of
26068 the source fields, but not when it appears as a recipient address. At the
26069 present time, there is no equivalent way of testing rewriting rules that are
26070 set for a particular transport.
26071
26072
26073 .section "Rewriting rules" "SECID150"
26074 .cindex "rewriting" "rules"
26075 The rewrite section of the configuration file consists of lines of rewriting
26076 rules in the form
26077 .display
26078 <&'source pattern'&>  <&'replacement'&>  <&'flags'&>
26079 .endd
26080 Rewriting rules that are specified for the &%headers_rewrite%& generic
26081 transport option are given as a colon-separated list. Each item in the list
26082 takes the same form as a line in the main rewriting configuration (except that
26083 any colons must be doubled, of course).
26084
26085 The formats of source patterns and replacement strings are described below.
26086 Each is terminated by white space, unless enclosed in double quotes, in which
26087 case normal quoting conventions apply inside the quotes. The flags are single
26088 characters which may appear in any order. Spaces and tabs between them are
26089 ignored.
26090
26091 For each address that could potentially be rewritten, the rules are scanned in
26092 order, and replacements for the address from earlier rules can themselves be
26093 replaced by later rules (but see the &"q"& and &"R"& flags).
26094
26095 The order in which addresses are rewritten is undefined, may change between
26096 releases, and must not be relied on, with one exception: when a message is
26097 received, the envelope sender is always rewritten first, before any header
26098 lines are rewritten. For example, the replacement string for a rewrite of an
26099 address in &'To:'& must not assume that the message's address in &'From:'& has
26100 (or has not) already been rewritten. However, a rewrite of &'From:'& may assume
26101 that the envelope sender has already been rewritten.
26102
26103 .vindex "&$domain$&"
26104 .vindex "&$local_part$&"
26105 The variables &$local_part$& and &$domain$& can be used in the replacement
26106 string to refer to the address that is being rewritten. Note that lookup-driven
26107 rewriting can be done by a rule of the form
26108 .code
26109 *@*   ${lookup ...
26110 .endd
26111 where the lookup key uses &$1$& and &$2$& or &$local_part$& and &$domain$& to
26112 refer to the address that is being rewritten.
26113
26114
26115 .section "Rewriting patterns" "SECID151"
26116 .cindex "rewriting" "patterns"
26117 .cindex "address list" "in a rewriting pattern"
26118 The source pattern in a rewriting rule is any item which may appear in an
26119 address list (see section &<<SECTaddresslist>>&). It is in fact processed as a
26120 single-item address list, which means that it is expanded before being tested
26121 against the address. As always, if you use a regular expression as a pattern,
26122 you must take care to escape dollar and backslash characters, or use the &`\N`&
26123 facility to suppress string expansion within the regular expression.
26124
26125 Domains in patterns should be given in lower case. Local parts in patterns are
26126 case-sensitive. If you want to do case-insensitive matching of local parts, you
26127 can use a regular expression that starts with &`^(?i)`&.
26128
26129 .cindex "numerical variables (&$1$& &$2$& etc)" "in rewriting rules"
26130 After matching, the numerical variables &$1$&, &$2$&, etc. may be set,
26131 depending on the type of match which occurred. These can be used in the
26132 replacement string to insert portions of the incoming address. &$0$& always
26133 refers to the complete incoming address. When a regular expression is used, the
26134 numerical variables are set from its capturing subexpressions. For other types
26135 of pattern they are set as follows:
26136
26137 .ilist
26138 If a local part or domain starts with an asterisk, the numerical variables
26139 refer to the character strings matched by asterisks, with &$1$& associated with
26140 the first asterisk, and &$2$& with the second, if present. For example, if the
26141 pattern
26142 .code
26143 *queen@*.fict.example
26144 .endd
26145 is matched against the address &'hearts-queen@wonderland.fict.example'& then
26146 .code
26147 $0 = hearts-queen@wonderland.fict.example
26148 $1 = hearts-
26149 $2 = wonderland
26150 .endd
26151 Note that if the local part does not start with an asterisk, but the domain
26152 does, it is &$1$& that contains the wild part of the domain.
26153
26154 .next
26155 If the domain part of the pattern is a partial lookup, the wild and fixed parts
26156 of the domain are placed in the next available numerical variables. Suppose,
26157 for example, that the address &'foo@bar.baz.example'& is processed by a
26158 rewriting rule of the form
26159 .display
26160 &`*@partial-dbm;/some/dbm/file`&    <&'replacement string'&>
26161 .endd
26162 and the key in the file that matches the domain is &`*.baz.example`&. Then
26163 .code
26164 $1 = foo
26165 $2 = bar
26166 $3 = baz.example
26167 .endd
26168 If the address &'foo@baz.example'& is looked up, this matches the same
26169 wildcard file entry, and in this case &$2$& is set to the empty string, but
26170 &$3$& is still set to &'baz.example'&. If a non-wild key is matched in a
26171 partial lookup, &$2$& is again set to the empty string and &$3$& is set to the
26172 whole domain. For non-partial domain lookups, no numerical variables are set.
26173 .endlist
26174
26175
26176 .section "Rewriting replacements" "SECID152"
26177 .cindex "rewriting" "replacements"
26178 If the replacement string for a rule is a single asterisk, addresses that
26179 match the pattern and the flags are &'not'& rewritten, and no subsequent
26180 rewriting rules are scanned. For example,
26181 .code
26182 hatta@lookingglass.fict.example  *  f
26183 .endd
26184 specifies that &'hatta@lookingglass.fict.example'& is never to be rewritten in
26185 &'From:'& headers.
26186
26187 .vindex "&$domain$&"
26188 .vindex "&$local_part$&"
26189 If the replacement string is not a single asterisk, it is expanded, and must
26190 yield a fully qualified address. Within the expansion, the variables
26191 &$local_part$& and &$domain$& refer to the address that is being rewritten.
26192 Any letters they contain retain their original case &-- they are not lower
26193 cased. The numerical variables are set up according to the type of pattern that
26194 matched the address, as described above. If the expansion is forced to fail by
26195 the presence of &"fail"& in a conditional or lookup item, rewriting by the
26196 current rule is abandoned, but subsequent rules may take effect. Any other
26197 expansion failure causes the entire rewriting operation to be abandoned, and an
26198 entry written to the panic log.
26199
26200
26201
26202 .section "Rewriting flags" "SECID153"
26203 There are three different kinds of flag that may appear on rewriting rules:
26204
26205 .ilist
26206 Flags that specify which headers and envelope addresses to rewrite: E, F, T, b,
26207 c, f, h, r, s, t.
26208 .next
26209 A flag that specifies rewriting at SMTP time: S.
26210 .next
26211 Flags that control the rewriting process: Q, q, R, w.
26212 .endlist
26213
26214 For rules that are part of the &%headers_rewrite%& generic transport option,
26215 E, F, T, and S are not permitted.
26216
26217
26218
26219 .section "Flags specifying which headers and envelope addresses to rewrite" &&&
26220          "SECID154"
26221 .cindex "rewriting" "flags"
26222 If none of the following flag letters, nor the &"S"& flag (see section
26223 &<<SECTrewriteS>>&) are present, a main rewriting rule applies to all headers
26224 and to both the sender and recipient fields of the envelope, whereas a
26225 transport-time rewriting rule just applies to all headers. Otherwise, the
26226 rewriting rule is skipped unless the relevant addresses are being processed.
26227 .display
26228 &`E`&       rewrite all envelope fields
26229 &`F`&       rewrite the envelope From field
26230 &`T`&       rewrite the envelope To field
26231 &`b`&       rewrite the &'Bcc:'& header
26232 &`c`&       rewrite the &'Cc:'& header
26233 &`f`&       rewrite the &'From:'& header
26234 &`h`&       rewrite all headers
26235 &`r`&       rewrite the &'Reply-To:'& header
26236 &`s`&       rewrite the &'Sender:'& header
26237 &`t`&       rewrite the &'To:'& header
26238 .endd
26239 "All headers" means all of the headers listed above that can be selected
26240 individually, plus their &'Resent-'& versions. It does not include
26241 other headers such as &'Subject:'& etc.
26242
26243 You should be particularly careful about rewriting &'Sender:'& headers, and
26244 restrict this to special known cases in your own domains.
26245
26246
26247 .section "The SMTP-time rewriting flag" "SECTrewriteS"
26248 .cindex "SMTP" "rewriting malformed addresses"
26249 .cindex "RCPT" "rewriting argument of"
26250 .cindex "MAIL" "rewriting argument of"
26251 The rewrite flag &"S"& specifies a rewrite of incoming envelope addresses at
26252 SMTP time, as soon as an address is received in a MAIL or RCPT command, and
26253 before any other processing; even before syntax checking. The pattern is
26254 required to be a regular expression, and it is matched against the whole of the
26255 data for the command, including any surrounding angle brackets.
26256
26257 .vindex "&$domain$&"
26258 .vindex "&$local_part$&"
26259 This form of rewrite rule allows for the handling of addresses that are not
26260 compliant with RFCs 2821 and 2822 (for example, &"bang paths"& in batched SMTP
26261 input). Because the input is not required to be a syntactically valid address,
26262 the variables &$local_part$& and &$domain$& are not available during the
26263 expansion of the replacement string. The result of rewriting replaces the
26264 original address in the MAIL or RCPT command.
26265
26266
26267 .section "Flags controlling the rewriting process" "SECID155"
26268 There are four flags which control the way the rewriting process works. These
26269 take effect only when a rule is invoked, that is, when the address is of the
26270 correct type (matches the flags) and matches the pattern:
26271
26272 .ilist
26273 If the &"Q"& flag is set on a rule, the rewritten address is permitted to be an
26274 unqualified local part. It is qualified with &%qualify_recipient%&. In the
26275 absence of &"Q"& the rewritten address must always include a domain.
26276 .next
26277 If the &"q"& flag is set on a rule, no further rewriting rules are considered,
26278 even if no rewriting actually takes place because of a &"fail"& in the
26279 expansion. The &"q"& flag is not effective if the address is of the wrong type
26280 (does not match the flags) or does not match the pattern.
26281 .next
26282 The &"R"& flag causes a successful rewriting rule to be re-applied to the new
26283 address, up to ten times. It can be combined with the &"q"& flag, to stop
26284 rewriting once it fails to match (after at least one successful rewrite).
26285 .next
26286 .cindex "rewriting" "whole addresses"
26287 When an address in a header is rewritten, the rewriting normally applies only
26288 to the working part of the address, with any comments and RFC 2822 &"phrase"&
26289 left unchanged. For example, rewriting might change
26290 .code
26291 From: Ford Prefect <fp42@restaurant.hitch.fict.example>
26292 .endd
26293 into
26294 .code
26295 From: Ford Prefect <prefectf@hitch.fict.example>
26296 .endd
26297 .cindex "RFC 2047"
26298 Sometimes there is a need to replace the whole address item, and this can be
26299 done by adding the flag letter &"w"& to a rule. If this is set on a rule that
26300 causes an address in a header line to be rewritten, the entire address is
26301 replaced, not just the working part. The replacement must be a complete RFC
26302 2822 address, including the angle brackets if necessary. If text outside angle
26303 brackets contains a character whose value is greater than 126 or less than 32
26304 (except for tab), the text is encoded according to RFC 2047. The character set
26305 is taken from &%headers_charset%&, which gets its default at build time.
26306
26307 When the &"w"& flag is set on a rule that causes an envelope address to be
26308 rewritten, all but the working part of the replacement address is discarded.
26309 .endlist
26310
26311
26312 .section "Rewriting examples" "SECID156"
26313 Here is an example of the two common rewriting paradigms:
26314 .code
26315 *@*.hitch.fict.example  $1@hitch.fict.example
26316 *@hitch.fict.example    ${lookup{$1}dbm{/etc/realnames}\
26317                      {$value}fail}@hitch.fict.example bctfrF
26318 .endd
26319 Note the use of &"fail"& in the lookup expansion in the second rule, forcing
26320 the string expansion to fail if the lookup does not succeed. In this context it
26321 has the effect of leaving the original address unchanged, but Exim goes on to
26322 consider subsequent rewriting rules, if any, because the &"q"& flag is not
26323 present in that rule. An alternative to &"fail"& would be to supply &$1$&
26324 explicitly, which would cause the rewritten address to be the same as before,
26325 at the cost of a small bit of processing. Not supplying either of these is an
26326 error, since the rewritten address would then contain no local part.
26327
26328 The first example above replaces the domain with a superior, more general
26329 domain. This may not be desirable for certain local parts. If the rule
26330 .code
26331 root@*.hitch.fict.example  *
26332 .endd
26333 were inserted before the first rule, rewriting would be suppressed for the
26334 local part &'root'& at any domain ending in &'hitch.fict.example'&.
26335
26336 Rewriting can be made conditional on a number of tests, by making use of
26337 &${if$& in the expansion item. For example, to apply a rewriting rule only to
26338 messages that originate outside the local host:
26339 .code
26340 *@*.hitch.fict.example  "${if !eq {$sender_host_address}{}\
26341                          {$1@hitch.fict.example}fail}"
26342 .endd
26343 The replacement string is quoted in this example because it contains white
26344 space.
26345
26346 .cindex "rewriting" "bang paths"
26347 .cindex "bang paths" "rewriting"
26348 Exim does not handle addresses in the form of &"bang paths"&. If it sees such
26349 an address it treats it as an unqualified local part which it qualifies with
26350 the local qualification domain (if the source of the message is local or if the
26351 remote host is permitted to send unqualified addresses). Rewriting can
26352 sometimes be used to handle simple bang paths with a fixed number of
26353 components. For example, the rule
26354 .code
26355 \N^([^!]+)!(.*)@your.domain.example$\N   $2@$1
26356 .endd
26357 rewrites a two-component bang path &'host.name!user'& as the domain address
26358 &'user@host.name'&. However, there is a security implication in using this as
26359 a global rewriting rule for envelope addresses. It can provide a backdoor
26360 method for using your system as a relay, because the incoming addresses appear
26361 to be local. If the bang path addresses are received via SMTP, it is safer to
26362 use the &"S"& flag to rewrite them as they are received, so that relay checking
26363 can be done on the rewritten addresses.
26364 .ecindex IIDaddrew
26365
26366
26367
26368
26369
26370 . ////////////////////////////////////////////////////////////////////////////
26371 . ////////////////////////////////////////////////////////////////////////////
26372
26373 .chapter "Retry configuration" "CHAPretry"
26374 .scindex IIDretconf1 "retry" "configuration, description of"
26375 .scindex IIDregconf2 "configuration file" "retry section"
26376 The &"retry"& section of the runtime configuration file contains a list of
26377 retry rules that control how often Exim tries to deliver messages that cannot
26378 be delivered at the first attempt. If there are no retry rules (the section is
26379 empty or not present), there are no retries. In this situation, temporary
26380 errors are treated as permanent. The default configuration contains a single,
26381 general-purpose retry rule (see section &<<SECID57>>&). The &%-brt%& command
26382 line option can be used to test which retry rule will be used for a given
26383 address, domain and error.
26384
26385 The most common cause of retries is temporary failure to deliver to a remote
26386 host because the host is down, or inaccessible because of a network problem.
26387 Exim's retry processing in this case is applied on a per-host (strictly, per IP
26388 address) basis, not on a per-message basis. Thus, if one message has recently
26389 been delayed, delivery of a new message to the same host is not immediately
26390 tried, but waits for the host's retry time to arrive. If the &%retry_defer%&
26391 log selector is set, the message
26392 .cindex "retry" "time not reached"
26393 &"retry time not reached"& is written to the main log whenever a delivery is
26394 skipped for this reason. Section &<<SECToutSMTPerr>>& contains more details of
26395 the handling of errors during remote deliveries.
26396
26397 Retry processing applies to routing as well as to delivering, except as covered
26398 in the next paragraph. The retry rules do not distinguish between these
26399 actions. It is not possible, for example, to specify different behaviour for
26400 failures to route the domain &'snark.fict.example'& and failures to deliver to
26401 the host &'snark.fict.example'&. I didn't think anyone would ever need this
26402 added complication, so did not implement it. However, although they share the
26403 same retry rule, the actual retry times for routing and transporting a given
26404 domain are maintained independently.
26405
26406 When a delivery is not part of a queue run (typically an immediate delivery on
26407 receipt of a message), the routers are always run, and local deliveries are
26408 always attempted, even if retry times are set for them. This makes for better
26409 behaviour if one particular message is causing problems (for example, causing
26410 quota overflow, or provoking an error in a filter file). If such a delivery
26411 suffers a temporary failure, the retry data is updated as normal, and
26412 subsequent delivery attempts from queue runs occur only when the retry time for
26413 the local address is reached.
26414
26415 .section "Changing retry rules" "SECID157"
26416 If you change the retry rules in your configuration, you should consider
26417 whether or not to delete the retry data that is stored in Exim's spool area in
26418 files with names like &_db/retry_&. Deleting any of Exim's hints files is
26419 always safe; that is why they are called &"hints"&.
26420
26421 The hints retry data contains suggested retry times based on the previous
26422 rules. In the case of a long-running problem with a remote host, it might
26423 record the fact that the host has timed out. If your new rules increase the
26424 timeout time for such a host, you should definitely remove the old retry data
26425 and let Exim recreate it, based on the new rules. Otherwise Exim might bounce
26426 messages that it should now be retaining.
26427
26428
26429
26430 .section "Format of retry rules" "SECID158"
26431 .cindex "retry" "rules"
26432 Each retry rule occupies one line and consists of three or four parts,
26433 separated by white space: a pattern, an error name, an optional list of sender
26434 addresses, and a list of retry parameters. The pattern and sender lists must be
26435 enclosed in double quotes if they contain white space. The rules are searched
26436 in order until one is found where the pattern, error name, and sender list (if
26437 present) match the failing host or address, the error that occurred, and the
26438 message's sender, respectively.
26439
26440
26441 The pattern is any single item that may appear in an address list (see section
26442 &<<SECTaddresslist>>&). It is in fact processed as a one-item address list,
26443 which means that it is expanded before being tested against the address that
26444 has been delayed. A negated address list item is permitted. Address
26445 list processing treats a plain domain name as if it were preceded by &"*@"&,
26446 which makes it possible for many retry rules to start with just a domain. For
26447 example,
26448 .code
26449 lookingglass.fict.example        *  F,24h,30m;
26450 .endd
26451 provides a rule for any address in the &'lookingglass.fict.example'& domain,
26452 whereas
26453 .code
26454 alice@lookingglass.fict.example  *  F,24h,30m;
26455 .endd
26456 applies only to temporary failures involving the local part &%alice%&.
26457 In practice, almost all rules start with a domain name pattern without a local
26458 part.
26459
26460 .cindex "regular expressions" "in retry rules"
26461 &*Warning*&: If you use a regular expression in a retry rule pattern, it
26462 must match a complete address, not just a domain, because that is how regular
26463 expressions work in address lists.
26464 .display
26465 &`^\Nxyz\d+\.abc\.example$\N        *  G,1h,10m,2`&     &%Wrong%&
26466 &`^\N[^@]+@xyz\d+\.abc\.example$\N  *  G,1h,10m,2`&     &%Right%&
26467 .endd
26468
26469
26470 .section "Choosing which retry rule to use for address errors" "SECID159"
26471 When Exim is looking for a retry rule after a routing attempt has failed (for
26472 example, after a DNS timeout), each line in the retry configuration is tested
26473 against the complete address only if &%retry_use_local_part%& is set for the
26474 router. Otherwise, only the domain is used, except when matching against a
26475 regular expression, when the local part of the address is replaced with &"*"&.
26476 A domain on its own can match a domain pattern, or a pattern that starts with
26477 &"*@"&. By default, &%retry_use_local_part%& is true for routers where
26478 &%check_local_user%& is true, and false for other routers.
26479
26480 Similarly, when Exim is looking for a retry rule after a local delivery has
26481 failed (for example, after a mailbox full error), each line in the retry
26482 configuration is tested against the complete address only if
26483 &%retry_use_local_part%& is set for the transport (it defaults true for all
26484 local transports).
26485
26486 .cindex "4&'xx'& responses" "retry rules for"
26487 However, when Exim is looking for a retry rule after a remote delivery attempt
26488 suffers an address error (a 4&'xx'& SMTP response for a recipient address), the
26489 whole address is always used as the key when searching the retry rules. The
26490 rule that is found is used to create a retry time for the combination of the
26491 failing address and the message's sender. It is the combination of sender and
26492 recipient that is delayed in subsequent queue runs until its retry time is
26493 reached. You can delay the recipient without regard to the sender by setting
26494 &%address_retry_include_sender%& false in the &(smtp)& transport but this can
26495 lead to problems with servers that regularly issue 4&'xx'& responses to RCPT
26496 commands.
26497
26498
26499
26500 .section "Choosing which retry rule to use for host and message errors" &&&
26501          "SECID160"
26502 For a temporary error that is not related to an individual address (for
26503 example, a connection timeout), each line in the retry configuration is checked
26504 twice. First, the name of the remote host is used as a domain name (preceded by
26505 &"*@"& when matching a regular expression). If this does not match the line,
26506 the domain from the email address is tried in a similar fashion. For example,
26507 suppose the MX records for &'a.b.c.example'& are
26508 .code
26509 a.b.c.example  MX  5  x.y.z.example
26510                MX  6  p.q.r.example
26511                MX  7  m.n.o.example
26512 .endd
26513 and the retry rules are
26514 .code
26515 p.q.r.example    *      F,24h,30m;
26516 a.b.c.example    *      F,4d,45m;
26517 .endd
26518 and a delivery to the host &'x.y.z.example'& suffers a connection failure. The
26519 first rule matches neither the host nor the domain, so Exim looks at the second
26520 rule. This does not match the host, but it does match the domain, so it is used
26521 to calculate the retry time for the host &'x.y.z.example'&. Meanwhile, Exim
26522 tries to deliver to &'p.q.r.example'&. If this also suffers a host error, the
26523 first retry rule is used, because it matches the host.
26524
26525 In other words, temporary failures to deliver to host &'p.q.r.example'& use the
26526 first rule to determine retry times, but for all the other hosts for the domain
26527 &'a.b.c.example'&, the second rule is used. The second rule is also used if
26528 routing to &'a.b.c.example'& suffers a temporary failure.
26529
26530 &*Note*&: The host name is used when matching the patterns, not its IP address.
26531 However, if a message is routed directly to an IP address without the use of a
26532 host name, for example, if a &(manualroute)& router contains a setting such as:
26533 .code
26534 route_list = *.a.example  192.168.34.23
26535 .endd
26536 then the &"host name"& that is used when searching for a retry rule is the
26537 textual form of the IP address.
26538
26539 .section "Retry rules for specific errors" "SECID161"
26540 .cindex "retry" "specific errors; specifying"
26541 The second field in a retry rule is the name of a particular error, or an
26542 asterisk, which matches any error. The errors that can be tested for are:
26543
26544 .vlist
26545 .vitem &%auth_failed%&
26546 Authentication failed when trying to send to a host in the
26547 &%hosts_require_auth%& list in an &(smtp)& transport.
26548
26549 .vitem &%data_4xx%&
26550 A 4&'xx'& error was received for an outgoing DATA command, either immediately
26551 after the command, or after sending the message's data.
26552
26553 .vitem &%mail_4xx%&
26554 A 4&'xx'& error was received for an outgoing MAIL command.
26555
26556 .vitem &%rcpt_4xx%&
26557 A 4&'xx'& error was received for an outgoing RCPT command.
26558 .endlist
26559
26560 For the three 4&'xx'& errors, either the first or both of the x's can be given
26561 as specific digits, for example: &`mail_45x`& or &`rcpt_436`&. For example, to
26562 recognize 452 errors given to RCPT commands for addresses in a certain domain,
26563 and have retries every ten minutes with a one-hour timeout, you could set up a
26564 retry rule of this form:
26565 .code
26566 the.domain.name  rcpt_452   F,1h,10m
26567 .endd
26568 These errors apply to both outgoing SMTP (the &(smtp)& transport) and outgoing
26569 LMTP (either the &(lmtp)& transport, or the &(smtp)& transport in LMTP mode).
26570
26571 .vlist
26572 .vitem &%lost_connection%&
26573 A server unexpectedly closed the SMTP connection. There may, of course,
26574 legitimate reasons for this (host died, network died), but if it repeats a lot
26575 for the same host, it indicates something odd.
26576
26577 .vitem &%lookup%&
26578 A DNS lookup for a host failed.
26579 Note that a &%dnslookup%& router will need to have matched
26580 its &%fail_defer_domains%& option for this retry type to be usable.
26581 Also note that a &%manualroute%& router will probably need
26582 its &%host_find_failed%& option set to &%defer%&.
26583
26584 .vitem &%refused_MX%&
26585 A connection to a host obtained from an MX record was refused.
26586
26587 .vitem &%refused_A%&
26588 A connection to a host not obtained from an MX record was refused.
26589
26590 .vitem &%refused%&
26591 A connection was refused.
26592
26593 .vitem &%timeout_connect_MX%&
26594 A connection attempt to a host obtained from an MX record timed out.
26595
26596 .vitem &%timeout_connect_A%&
26597 A connection attempt to a host not obtained from an MX record timed out.
26598
26599 .vitem &%timeout_connect%&
26600 A connection attempt timed out.
26601
26602 .vitem &%timeout_MX%&
26603 There was a timeout while connecting or during an SMTP session with a host
26604 obtained from an MX record.
26605
26606 .vitem &%timeout_A%&
26607 There was a timeout while connecting or during an SMTP session with a host not
26608 obtained from an MX record.
26609
26610 .vitem &%timeout%&
26611 There was a timeout while connecting or during an SMTP session.
26612
26613 .vitem &%tls_required%&
26614 The server was required to use TLS (it matched &%hosts_require_tls%& in the
26615 &(smtp)& transport), but either did not offer TLS, or it responded with 4&'xx'&
26616 to STARTTLS, or there was a problem setting up the TLS connection.
26617
26618 .vitem &%quota%&
26619 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
26620 transport.
26621
26622 .vitem &%quota_%&<&'time'&>
26623 .cindex "quota" "error testing in retry rule"
26624 .cindex "retry" "quota error testing"
26625 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
26626 transport, and the mailbox has not been accessed for <&'time'&>. For example,
26627 &'quota_4d'& applies to a quota error when the mailbox has not been accessed
26628 for four days.
26629 .endlist
26630
26631 .cindex "mailbox" "time of last read"
26632 The idea of &%quota_%&<&'time'&> is to make it possible to have shorter
26633 timeouts when the mailbox is full and is not being read by its owner. Ideally,
26634 it should be based on the last time that the user accessed the mailbox.
26635 However, it is not always possible to determine this. Exim uses the following
26636 heuristic rules:
26637
26638 .ilist
26639 If the mailbox is a single file, the time of last access (the &"atime"&) is
26640 used. As no new messages are being delivered (because the mailbox is over
26641 quota), Exim does not access the file, so this is the time of last user access.
26642 .next
26643 .cindex "maildir format" "time of last read"
26644 For a maildir delivery, the time of last modification of the &_new_&
26645 subdirectory is used. As the mailbox is over quota, no new files are created in
26646 the &_new_& subdirectory, because no new messages are being delivered. Any
26647 change to the &_new_& subdirectory is therefore assumed to be the result of an
26648 MUA moving a new message to the &_cur_& directory when it is first read. The
26649 time that is used is therefore the last time that the user read a new message.
26650 .next
26651 For other kinds of multi-file mailbox, the time of last access cannot be
26652 obtained, so a retry rule that uses this type of error field is never matched.
26653 .endlist
26654
26655 The quota errors apply both to system-enforced quotas and to Exim's own quota
26656 mechanism in the &(appendfile)& transport. The &'quota'& error also applies
26657 when a local delivery is deferred because a partition is full (the ENOSPC
26658 error).
26659
26660
26661
26662 .section "Retry rules for specified senders" "SECID162"
26663 .cindex "retry" "rules; sender-specific"
26664 You can specify retry rules that apply only when the failing message has a
26665 specific sender. In particular, this can be used to define retry rules that
26666 apply only to bounce messages. The third item in a retry rule can be of this
26667 form:
26668 .display
26669 &`senders=`&<&'address list'&>
26670 .endd
26671 The retry timings themselves are then the fourth item. For example:
26672 .code
26673 *   rcpt_4xx   senders=:   F,1h,30m
26674 .endd
26675 matches recipient 4&'xx'& errors for bounce messages sent to any address at any
26676 host. If the address list contains white space, it must be enclosed in quotes.
26677 For example:
26678 .code
26679 a.domain  rcpt_452  senders="xb.dom : yc.dom"  G,8h,10m,1.5
26680 .endd
26681 &*Warning*&: This facility can be unhelpful if it is used for host errors
26682 (which do not depend on the recipient). The reason is that the sender is used
26683 only to match the retry rule. Once the rule has been found for a host error,
26684 its contents are used to set a retry time for the host, and this will apply to
26685 all messages, not just those with specific senders.
26686
26687 When testing retry rules using &%-brt%&, you can supply a sender using the
26688 &%-f%& command line option, like this:
26689 .code
26690 exim -f "" -brt user@dom.ain
26691 .endd
26692 If you do not set &%-f%& with &%-brt%&, a retry rule that contains a senders
26693 list is never matched.
26694
26695
26696
26697
26698
26699 .section "Retry parameters" "SECID163"
26700 .cindex "retry" "parameters in rules"
26701 The third (or fourth, if a senders list is present) field in a retry rule is a
26702 sequence of retry parameter sets, separated by semicolons. Each set consists of
26703 .display
26704 <&'letter'&>,<&'cutoff time'&>,<&'arguments'&>
26705 .endd
26706 The letter identifies the algorithm for computing a new retry time; the cutoff
26707 time is the time beyond which this algorithm no longer applies, and the
26708 arguments vary the algorithm's action. The cutoff time is measured from the
26709 time that the first failure for the domain (combined with the local part if
26710 relevant) was detected, not from the time the message was received.
26711
26712 .cindex "retry" "algorithms"
26713 .cindex "retry" "fixed intervals"
26714 .cindex "retry" "increasing intervals"
26715 .cindex "retry" "random intervals"
26716 The available algorithms are:
26717
26718 .ilist
26719 &'F'&: retry at fixed intervals. There is a single time parameter specifying
26720 the interval.
26721 .next
26722 &'G'&: retry at geometrically increasing intervals. The first argument
26723 specifies a starting value for the interval, and the second a multiplier, which
26724 is used to increase the size of the interval at each retry.
26725 .next
26726 &'H'&: retry at randomized intervals. The arguments are as for &'G'&. For each
26727 retry, the previous interval is multiplied by the factor in order to get a
26728 maximum for the next interval. The minimum interval is the first argument of
26729 the parameter, and an actual interval is chosen randomly between them. Such a
26730 rule has been found to be helpful in cluster configurations when all the
26731 members of the cluster restart at once, and may therefore synchronize their
26732 queue processing times.
26733 .endlist
26734
26735 When computing the next retry time, the algorithm definitions are scanned in
26736 order until one whose cutoff time has not yet passed is reached. This is then
26737 used to compute a new retry time that is later than the current time. In the
26738 case of fixed interval retries, this simply means adding the interval to the
26739 current time. For geometrically increasing intervals, retry intervals are
26740 computed from the rule's parameters until one that is greater than the previous
26741 interval is found. The main configuration variable
26742 .cindex "limit" "retry interval"
26743 .cindex "retry" "interval, maximum"
26744 .oindex "&%retry_interval_max%&"
26745 &%retry_interval_max%& limits the maximum interval between retries. It
26746 cannot be set greater than &`24h`&, which is its default value.
26747
26748 A single remote domain may have a number of hosts associated with it, and each
26749 host may have more than one IP address. Retry algorithms are selected on the
26750 basis of the domain name, but are applied to each IP address independently. If,
26751 for example, a host has two IP addresses and one is unusable, Exim will
26752 generate retry times for it and will not try to use it until its next retry
26753 time comes. Thus the good IP address is likely to be tried first most of the
26754 time.
26755
26756 .cindex "hints database" "use for retrying"
26757 Retry times are hints rather than promises. Exim does not make any attempt to
26758 run deliveries exactly at the computed times. Instead, a queue runner process
26759 starts delivery processes for delayed messages periodically, and these attempt
26760 new deliveries only for those addresses that have passed their next retry time.
26761 If a new message arrives for a deferred address, an immediate delivery attempt
26762 occurs only if the address has passed its retry time. In the absence of new
26763 messages, the minimum time between retries is the interval between queue runner
26764 processes. There is not much point in setting retry times of five minutes if
26765 your queue runners happen only once an hour, unless there are a significant
26766 number of incoming messages (which might be the case on a system that is
26767 sending everything to a smart host, for example).
26768
26769 The data in the retry hints database can be inspected by using the
26770 &'exim_dumpdb'& or &'exim_fixdb'& utility programs (see chapter
26771 &<<CHAPutils>>&). The latter utility can also be used to change the data. The
26772 &'exinext'& utility script can be used to find out what the next retry times
26773 are for the hosts associated with a particular mail domain, and also for local
26774 deliveries that have been deferred.
26775
26776
26777 .section "Retry rule examples" "SECID164"
26778 Here are some example retry rules:
26779 .code
26780 alice@wonderland.fict.example quota_5d  F,7d,3h
26781 wonderland.fict.example       quota_5d
26782 wonderland.fict.example       *         F,1h,15m; G,2d,1h,2;
26783 lookingglass.fict.example     *         F,24h,30m;
26784 *                 refused_A   F,2h,20m;
26785 *                 *           F,2h,15m; G,16h,1h,1.5; F,5d,8h
26786 .endd
26787 The first rule sets up special handling for mail to
26788 &'alice@wonderland.fict.example'& when there is an over-quota error and the
26789 mailbox has not been read for at least 5 days. Retries continue every three
26790 hours for 7 days. The second rule handles over-quota errors for all other local
26791 parts at &'wonderland.fict.example'&; the absence of a local part has the same
26792 effect as supplying &"*@"&. As no retry algorithms are supplied, messages that
26793 fail are bounced immediately if the mailbox has not been read for at least 5
26794 days.
26795
26796 The third rule handles all other errors at &'wonderland.fict.example'&; retries
26797 happen every 15 minutes for an hour, then with geometrically increasing
26798 intervals until two days have passed since a delivery first failed. After the
26799 first hour there is a delay of one hour, then two hours, then four hours, and
26800 so on (this is a rather extreme example).
26801
26802 The fourth rule controls retries for the domain &'lookingglass.fict.example'&.
26803 They happen every 30 minutes for 24 hours only. The remaining two rules handle
26804 all other domains, with special action for connection refusal from hosts that
26805 were not obtained from an MX record.
26806
26807 The final rule in a retry configuration should always have asterisks in the
26808 first two fields so as to provide a general catch-all for any addresses that do
26809 not have their own special handling. This example tries every 15 minutes for 2
26810 hours, then with intervals starting at one hour and increasing by a factor of
26811 1.5 up to 16 hours, then every 8 hours up to 5 days.
26812
26813
26814
26815 .section "Timeout of retry data" "SECID165"
26816 .cindex "timeout" "of retry data"
26817 .oindex "&%retry_data_expire%&"
26818 .cindex "hints database" "data expiry"
26819 .cindex "retry" "timeout of data"
26820 Exim timestamps the data that it writes to its retry hints database. When it
26821 consults the data during a delivery it ignores any that is older than the value
26822 set in &%retry_data_expire%& (default 7 days). If, for example, a host hasn't
26823 been tried for 7 days, Exim will try to deliver to it immediately a message
26824 arrives, and if that fails, it will calculate a retry time as if it were
26825 failing for the first time.
26826
26827 This improves the behaviour for messages routed to rarely-used hosts such as MX
26828 backups. If such a host was down at one time, and happens to be down again when
26829 Exim tries a month later, using the old retry data would imply that it had been
26830 down all the time, which is not a justified assumption.
26831
26832 If a host really is permanently dead, this behaviour causes a burst of retries
26833 every now and again, but only if messages routed to it are rare. If there is a
26834 message at least once every 7 days the retry data never expires.
26835
26836
26837
26838
26839 .section "Long-term failures" "SECID166"
26840 .cindex "delivery failure, long-term"
26841 .cindex "retry" "after long-term failure"
26842 Special processing happens when an email address has been failing for so long
26843 that the cutoff time for the last algorithm is reached. For example, using the
26844 default retry rule:
26845 .code
26846 * * F,2h,15m; G,16h,1h,1.5; F,4d,6h
26847 .endd
26848 the cutoff time is four days. Reaching the retry cutoff is independent of how
26849 long any specific message has been failing; it is the length of continuous
26850 failure for the recipient address that counts.
26851
26852 When the cutoff time is reached for a local delivery, or for all the IP
26853 addresses associated with a remote delivery, a subsequent delivery failure
26854 causes Exim to give up on the address, and a bounce message is generated.
26855 In order to cater for new messages that use the failing address, a next retry
26856 time is still computed from the final algorithm, and is used as follows:
26857
26858 For local deliveries, one delivery attempt is always made for any subsequent
26859 messages. If this delivery fails, the address fails immediately. The
26860 post-cutoff retry time is not used.
26861
26862 .cindex "final cutoff" "retries, controlling"
26863 .cindex retry "final cutoff"
26864 If the delivery is remote, there are two possibilities, controlled by the
26865 .oindex "&%delay_after_cutoff%&"
26866 &%delay_after_cutoff%& option of the &(smtp)& transport. The option is true by
26867 default. Until the post-cutoff retry time for one of the IP addresses,
26868 as set by the &%retry_data_expire%& option, is
26869 reached, the failing email address is bounced immediately, without a delivery
26870 attempt taking place. After that time, one new delivery attempt is made to
26871 those IP addresses that are past their retry times, and if that still fails,
26872 the address is bounced and new retry times are computed.
26873
26874 In other words, when all the hosts for a given email address have been failing
26875 for a long time, Exim bounces rather then defers until one of the hosts' retry
26876 times is reached. Then it tries once, and bounces if that attempt fails. This
26877 behaviour ensures that few resources are wasted in repeatedly trying to deliver
26878 to a broken destination, but if the host does recover, Exim will eventually
26879 notice.
26880
26881 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
26882 addresses are past their final cutoff time, Exim tries to deliver to those IP
26883 addresses that have not been tried since the message arrived. If there are
26884 no suitable IP addresses, or if they all fail, the address is bounced. In other
26885 words, it does not delay when a new message arrives, but tries the expired
26886 addresses immediately, unless they have been tried since the message arrived.
26887 If there is a continuous stream of messages for the failing domains, setting
26888 &%delay_after_cutoff%& false means that there will be many more attempts to
26889 deliver to permanently failing IP addresses than when &%delay_after_cutoff%& is
26890 true.
26891
26892 .section "Deliveries that work intermittently" "SECID167"
26893 .cindex "retry" "intermittently working deliveries"
26894 Some additional logic is needed to cope with cases where a host is
26895 intermittently available, or when a message has some attribute that prevents
26896 its delivery when others to the same address get through. In this situation,
26897 because some messages are successfully delivered, the &"retry clock"& for the
26898 host or address keeps getting reset by the successful deliveries, and so
26899 failing messages remain in the queue for ever because the cutoff time is never
26900 reached.
26901
26902 Two exceptional actions are applied to prevent this happening. The first
26903 applies to errors that are related to a message rather than a remote host.
26904 Section &<<SECToutSMTPerr>>& has a discussion of the different kinds of error;
26905 examples of message-related errors are 4&'xx'& responses to MAIL or DATA
26906 commands, and quota failures. For this type of error, if a message's arrival
26907 time is earlier than the &"first failed"& time for the error, the earlier time
26908 is used when scanning the retry rules to decide when to try next and when to
26909 time out the address.
26910
26911 The exceptional second action applies in all cases. If a message has been on
26912 the queue for longer than the cutoff time of any applicable retry rule for a
26913 given address, a delivery is attempted for that address, even if it is not yet
26914 time, and if this delivery fails, the address is timed out. A new retry time is
26915 not computed in this case, so that other messages for the same address are
26916 considered immediately.
26917 .ecindex IIDretconf1
26918 .ecindex IIDregconf2
26919
26920
26921
26922
26923
26924
26925 . ////////////////////////////////////////////////////////////////////////////
26926 . ////////////////////////////////////////////////////////////////////////////
26927
26928 .chapter "SMTP authentication" "CHAPSMTPAUTH"
26929 .scindex IIDauthconf1 "SMTP" "authentication configuration"
26930 .scindex IIDauthconf2 "authentication"
26931 The &"authenticators"& section of Exim's runtime configuration is concerned
26932 with SMTP authentication. This facility is an extension to the SMTP protocol,
26933 described in RFC 2554, which allows a client SMTP host to authenticate itself
26934 to a server. This is a common way for a server to recognize clients that are
26935 permitted to use it as a relay. SMTP authentication is not of relevance to the
26936 transfer of mail between servers that have no managerial connection with each
26937 other.
26938
26939 .cindex "AUTH" "description of"
26940 .cindex "ESMTP extensions" AUTH
26941 Very briefly, the way SMTP authentication works is as follows:
26942
26943 .ilist
26944 The server advertises a number of authentication &'mechanisms'& in response to
26945 the client's EHLO command.
26946 .next
26947 The client issues an AUTH command, naming a specific mechanism. The command
26948 may, optionally, contain some authentication data.
26949 .next
26950 The server may issue one or more &'challenges'&, to which the client must send
26951 appropriate responses. In simple authentication mechanisms, the challenges are
26952 just prompts for user names and passwords. The server does not have to issue
26953 any challenges &-- in some mechanisms the relevant data may all be transmitted
26954 with the AUTH command.
26955 .next
26956 The server either accepts or denies authentication.
26957 .next
26958 If authentication succeeds, the client may optionally make use of the AUTH
26959 option on the MAIL command to pass an authenticated sender in subsequent
26960 mail transactions. Authentication lasts for the remainder of the SMTP
26961 connection.
26962 .next
26963 If authentication fails, the client may give up, or it may try a different
26964 authentication mechanism, or it may try transferring mail over the
26965 unauthenticated connection.
26966 .endlist
26967
26968 If you are setting up a client, and want to know which authentication
26969 mechanisms the server supports, you can use Telnet to connect to port 25 (the
26970 SMTP port) on the server, and issue an EHLO command. The response to this
26971 includes the list of supported mechanisms. For example:
26972 .display
26973 &`$ `&&*&`telnet server.example 25`&*&
26974 &`Trying 192.168.34.25...`&
26975 &`Connected to server.example.`&
26976 &`Escape character is &#x0027;^]&#x0027;.`&
26977 &`220 server.example ESMTP Exim 4.20 ...`&
26978 &*&`ehlo client.example`&*&
26979 &`250-server.example Hello client.example [10.8.4.5]`&
26980 &`250-SIZE 52428800`&
26981 &`250-PIPELINING`&
26982 &`250-AUTH PLAIN`&
26983 &`250 HELP`&
26984 .endd
26985 The second-last line of this example output shows that the server supports
26986 authentication using the PLAIN mechanism. In Exim, the different authentication
26987 mechanisms are configured by specifying &'authenticator'& drivers. Like the
26988 routers and transports, which authenticators are included in the binary is
26989 controlled by build-time definitions. The following are currently available,
26990 included by setting
26991 .code
26992 AUTH_CRAM_MD5=yes
26993 AUTH_CYRUS_SASL=yes
26994 AUTH_DOVECOT=yes
26995 AUTH_EXTERNAL=yes
26996 AUTH_GSASL=yes
26997 AUTH_HEIMDAL_GSSAPI=yes
26998 AUTH_PLAINTEXT=yes
26999 AUTH_SPA=yes
27000 AUTH_TLS=yes
27001 .endd
27002 in &_Local/Makefile_&, respectively. The first of these supports the CRAM-MD5
27003 authentication mechanism (RFC 2195), and the second provides an interface to
27004 the Cyrus SASL authentication library.
27005 The third is an interface to Dovecot's authentication system, delegating the
27006 work via a socket interface.
27007 The fourth provides for negotiation of authentication done via non-SMTP means,
27008 as defined by RFC 4422 Appendix A.
27009 The fifth provides an interface to the GNU SASL authentication library, which
27010 provides mechanisms but typically not data sources.
27011 The sixth provides direct access to Heimdal GSSAPI, geared for Kerberos, but
27012 supporting setting a server keytab.
27013 The seventh can be configured to support
27014 the PLAIN authentication mechanism (RFC 2595) or the LOGIN mechanism, which is
27015 not formally documented, but used by several MUAs.
27016 The eighth authenticator
27017 supports Microsoft's &'Secure Password Authentication'& mechanism.
27018 The last is an Exim authenticator but not an SMTP one;
27019 instead it can use information from a TLS negotiation.
27020
27021 The authenticators are configured using the same syntax as other drivers (see
27022 section &<<SECTfordricon>>&). If no authenticators are required, no
27023 authentication section need be present in the configuration file. Each
27024 authenticator can in principle have both server and client functions. When Exim
27025 is receiving SMTP mail, it is acting as a server; when it is sending out
27026 messages over SMTP, it is acting as a client. Authenticator configuration
27027 options are provided for use in both these circumstances.
27028
27029 To make it clear which options apply to which situation, the prefixes
27030 &%server_%& and &%client_%& are used on option names that are specific to
27031 either the server or the client function, respectively. Server and client
27032 functions are disabled if none of their options are set. If an authenticator is
27033 to be used for both server and client functions, a single definition, using
27034 both sets of options, is required. For example:
27035 .code
27036 cram:
27037   driver = cram_md5
27038   public_name = CRAM-MD5
27039   server_secret = ${if eq{$auth1}{ph10}{secret1}fail}
27040   client_name = ph10
27041   client_secret = secret2
27042 .endd
27043 The &%server_%& option is used when Exim is acting as a server, and the
27044 &%client_%& options when it is acting as a client.
27045
27046 Descriptions of the individual authenticators are given in subsequent chapters.
27047 The remainder of this chapter covers the generic options for the
27048 authenticators, followed by general discussion of the way authentication works
27049 in Exim.
27050
27051 &*Beware:*& the meaning of &$auth1$&, &$auth2$&, ... varies on a per-driver and
27052 per-mechanism basis.  Please read carefully to determine which variables hold
27053 account labels such as usercodes and which hold passwords or other
27054 authenticating data.
27055
27056 Note that some mechanisms support two different identifiers for accounts: the
27057 &'authentication id'& and the &'authorization id'&.  The contractions &'authn'&
27058 and &'authz'& are commonly encountered.  The American spelling is standard here.
27059 Conceptually, authentication data such as passwords are tied to the identifier
27060 used to authenticate; servers may have rules to permit one user to act as a
27061 second user, so that after login the session is treated as though that second
27062 user had logged in.  That second user is the &'authorization id'&.  A robust
27063 configuration might confirm that the &'authz'& field is empty or matches the
27064 &'authn'& field.  Often this is just ignored.  The &'authn'& can be considered
27065 as verified data, the &'authz'& as an unverified request which the server might
27066 choose to honour.
27067
27068 A &'realm'& is a text string, typically a domain name, presented by a server
27069 to a client to help it select an account and credentials to use.  In some
27070 mechanisms, the client and server provably agree on the realm, but clients
27071 typically can not treat the realm as secure data to be blindly trusted.
27072
27073
27074
27075 .section "Generic options for authenticators" "SECID168"
27076 .cindex "authentication" "generic options"
27077 .cindex "options" "generic; for authenticators"
27078
27079 .option client_condition authenticators string&!! unset
27080 When Exim is authenticating as a client, it skips any authenticator whose
27081 &%client_condition%& expansion yields &"0"&, &"no"&, or &"false"&. This can be
27082 used, for example, to skip plain text authenticators when the connection is not
27083 encrypted by a setting such as:
27084 .code
27085 client_condition = ${if !eq{$tls_out_cipher}{}}
27086 .endd
27087
27088
27089 .option client_set_id authenticators string&!! unset
27090 When client authentication succeeds, this condition is expanded; the
27091 result is used in the log lines for outbound messages.
27092 Typically it will be the user name used for authentication.
27093
27094
27095 .option driver authenticators string unset
27096 This option must always be set. It specifies which of the available
27097 authenticators is to be used.
27098
27099
27100 .option public_name authenticators string unset
27101 This option specifies the name of the authentication mechanism that the driver
27102 implements, and by which it is known to the outside world. These names should
27103 contain only upper case letters, digits, underscores, and hyphens (RFC 2222),
27104 but Exim in fact matches them caselessly. If &%public_name%& is not set, it
27105 defaults to the driver's instance name.
27106
27107
27108 .option server_advertise_condition authenticators string&!! unset
27109 When a server is about to advertise an authentication mechanism, the condition
27110 is expanded. If it yields the empty string, &"0"&, &"no"&, or &"false"&, the
27111 mechanism is not advertised.
27112 If the expansion fails, the mechanism is not advertised. If the failure was not
27113 forced, and was not caused by a lookup defer, the incident is logged.
27114 See section &<<SECTauthexiser>>& below for further discussion.
27115
27116
27117 .option server_condition authenticators string&!! unset
27118 This option must be set for a &%plaintext%& server authenticator, where it
27119 is used directly to control authentication. See section &<<SECTplainserver>>&
27120 for details.
27121
27122 For the &(gsasl)& authenticator, this option is required for various
27123 mechanisms; see chapter &<<CHAPgsasl>>& for details.
27124
27125 For the other authenticators, &%server_condition%& can be used as an additional
27126 authentication or authorization mechanism that is applied after the other
27127 authenticator conditions succeed. If it is set, it is expanded when the
27128 authenticator would otherwise return a success code. If the expansion is forced
27129 to fail, authentication fails. Any other expansion failure causes a temporary
27130 error code to be returned. If the result of a successful expansion is an empty
27131 string, &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
27132 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds. For any
27133 other result, a temporary error code is returned, with the expanded string as
27134 the error text.
27135
27136
27137 .option server_debug_print authenticators string&!! unset
27138 If this option is set and authentication debugging is enabled (see the &%-d%&
27139 command line option), the string is expanded and included in the debugging
27140 output when the authenticator is run as a server. This can help with checking
27141 out the values of variables.
27142 If expansion of the string fails, the error message is written to the debugging
27143 output, and Exim carries on processing.
27144
27145
27146 .option server_set_id authenticators string&!! unset
27147 .vindex "&$authenticated_id$&"
27148 .vindex "&$authenticated_fail_id$&"
27149 When an Exim server successfully authenticates a client, this string is
27150 expanded using data from the authentication, and preserved for any incoming
27151 messages in the variable &$authenticated_id$&. It is also included in the log
27152 lines for incoming messages. For example, a user/password authenticator
27153 configuration might preserve the user name that was used to authenticate, and
27154 refer to it subsequently during delivery of the message.
27155 On a failing authentication the expansion result is instead saved in
27156 the &$authenticated_fail_id$& variable.
27157 If expansion fails, the option is ignored.
27158
27159
27160 .option server_mail_auth_condition authenticators string&!! unset
27161 This option allows a server to discard authenticated sender addresses supplied
27162 as part of MAIL commands in SMTP connections that are authenticated by the
27163 driver on which &%server_mail_auth_condition%& is set. The option is not used
27164 as part of the authentication process; instead its (unexpanded) value is
27165 remembered for later use.
27166 How it is used is described in the following section.
27167
27168
27169
27170
27171
27172 .section "The AUTH parameter on MAIL commands" "SECTauthparamail"
27173 .cindex "authentication" "sender; authenticated"
27174 .cindex "AUTH" "on MAIL command"
27175 When a client supplied an AUTH= item on a MAIL command, Exim applies
27176 the following checks before accepting it as the authenticated sender of the
27177 message:
27178
27179 .ilist
27180 If the connection is not using extended SMTP (that is, HELO was used rather
27181 than EHLO), the use of AUTH= is a syntax error.
27182 .next
27183 If the value of the AUTH= parameter is &"<>"&, it is ignored.
27184 .next
27185 .vindex "&$authenticated_sender$&"
27186 If &%acl_smtp_mailauth%& is defined, the ACL it specifies is run. While it is
27187 running, the value of &$authenticated_sender$& is set to the value obtained
27188 from the AUTH= parameter. If the ACL does not yield &"accept"&, the value of
27189 &$authenticated_sender$& is deleted. The &%acl_smtp_mailauth%& ACL may not
27190 return &"drop"& or &"discard"&. If it defers, a temporary error code (451) is
27191 given for the MAIL command.
27192 .next
27193 If &%acl_smtp_mailauth%& is not defined, the value of the AUTH= parameter
27194 is accepted and placed in &$authenticated_sender$& only if the client has
27195 authenticated.
27196 .next
27197 If the AUTH= value was accepted by either of the two previous rules, and
27198 the client has authenticated, and the authenticator has a setting for the
27199 &%server_mail_auth_condition%&, the condition is checked at this point. The
27200 valued that was saved from the authenticator is expanded. If the expansion
27201 fails, or yields an empty string, &"0"&, &"no"&, or &"false"&, the value of
27202 &$authenticated_sender$& is deleted. If the expansion yields any other value,
27203 the value of &$authenticated_sender$& is retained and passed on with the
27204 message.
27205 .endlist
27206
27207
27208 When &$authenticated_sender$& is set for a message, it is passed on to other
27209 hosts to which Exim authenticates as a client. Do not confuse this value with
27210 &$authenticated_id$&, which is a string obtained from the authentication
27211 process, and which is not usually a complete email address.
27212
27213 .vindex "&$sender_address$&"
27214 Whenever an AUTH= value is ignored, the incident is logged. The ACL for
27215 MAIL, if defined, is run after AUTH= is accepted or ignored. It can
27216 therefore make use of &$authenticated_sender$&. The converse is not true: the
27217 value of &$sender_address$& is not yet set up when the &%acl_smtp_mailauth%&
27218 ACL is run.
27219
27220
27221
27222 .section "Authentication on an Exim server" "SECTauthexiser"
27223 .cindex "authentication" "on an Exim server"
27224 When Exim receives an EHLO command, it advertises the public names of those
27225 authenticators that are configured as servers, subject to the following
27226 conditions:
27227
27228 .ilist
27229 The client host must match &%auth_advertise_hosts%& (default *).
27230 .next
27231 It the &%server_advertise_condition%& option is set, its expansion must not
27232 yield the empty string, &"0"&, &"no"&, or &"false"&.
27233 .endlist
27234
27235 The order in which the authenticators are defined controls the order in which
27236 the mechanisms are advertised.
27237
27238 Some mail clients (for example, some versions of Netscape) require the user to
27239 provide a name and password for authentication whenever AUTH is advertised,
27240 even though authentication may not in fact be needed (for example, Exim may be
27241 set up to allow unconditional relaying from the client by an IP address check).
27242 You can make such clients more friendly by not advertising AUTH to them.
27243 For example, if clients on the 10.9.8.0/24 network are permitted (by the ACL
27244 that runs for RCPT) to relay without authentication, you should set
27245 .code
27246 auth_advertise_hosts = ! 10.9.8.0/24
27247 .endd
27248 so that no authentication mechanisms are advertised to them.
27249
27250 The &%server_advertise_condition%& controls the advertisement of individual
27251 authentication mechanisms. For example, it can be used to restrict the
27252 advertisement of a particular mechanism to encrypted connections, by a setting
27253 such as:
27254 .code
27255 server_advertise_condition = ${if eq{$tls_in_cipher}{}{no}{yes}}
27256 .endd
27257 .vindex "&$tls_in_cipher$&"
27258 If the session is encrypted, &$tls_in_cipher$& is not empty, and so the expansion
27259 yields &"yes"&, which allows the advertisement to happen.
27260
27261 When an Exim server receives an AUTH command from a client, it rejects it
27262 immediately if AUTH was not advertised in response to an earlier EHLO
27263 command. This is the case if
27264
27265 .ilist
27266 The client host does not match &%auth_advertise_hosts%&; or
27267 .next
27268 No authenticators are configured with server options; or
27269 .next
27270 Expansion of &%server_advertise_condition%& blocked the advertising of all the
27271 server authenticators.
27272 .endlist
27273
27274
27275 Otherwise, Exim runs the ACL specified by &%acl_smtp_auth%& in order
27276 to decide whether to accept the command. If &%acl_smtp_auth%& is not set,
27277 AUTH is accepted from any client host.
27278
27279 If AUTH is not rejected by the ACL, Exim searches its configuration for a
27280 server authentication mechanism that was advertised in response to EHLO and
27281 that matches the one named in the AUTH command. If it finds one, it runs
27282 the appropriate authentication protocol, and authentication either succeeds or
27283 fails. If there is no matching advertised mechanism, the AUTH command is
27284 rejected with a 504 error.
27285
27286 .vindex "&$received_protocol$&"
27287 .vindex "&$sender_host_authenticated$&"
27288 When a message is received from an authenticated host, the value of
27289 &$received_protocol$& is set to &"esmtpa"& or &"esmtpsa"& instead of &"esmtp"&
27290 or &"esmtps"&, and &$sender_host_authenticated$& contains the name (not the
27291 public name) of the authenticator driver that successfully authenticated the
27292 client from which the message was received. This variable is empty if there was
27293 no successful authentication.
27294
27295 .cindex authentication "expansion item"
27296 Successful authentication sets up information used by the
27297 &%authresults%& expansion item.
27298
27299
27300
27301
27302 .section "Testing server authentication" "SECID169"
27303 .cindex "authentication" "testing a server"
27304 .cindex "AUTH" "testing a server"
27305 .cindex "base64 encoding" "creating authentication test data"
27306 Exim's &%-bh%& option can be useful for testing server authentication
27307 configurations. The data for the AUTH command has to be sent using base64
27308 encoding. A quick way to produce such data for testing is the following Perl
27309 script:
27310 .code
27311 use MIME::Base64;
27312 printf ("%s", encode_base64(eval "\"$ARGV[0]\""));
27313 .endd
27314 .cindex "binary zero" "in authentication data"
27315 This interprets its argument as a Perl string, and then encodes it. The
27316 interpretation as a Perl string allows binary zeros, which are required for
27317 some kinds of authentication, to be included in the data. For example, a
27318 command line to run this script on such data might be
27319 .code
27320 encode '\0user\0password'
27321 .endd
27322 Note the use of single quotes to prevent the shell interpreting the
27323 backslashes, so that they can be interpreted by Perl to specify characters
27324 whose code value is zero.
27325
27326 &*Warning 1*&: If either of the user or password strings starts with an octal
27327 digit, you must use three zeros instead of one after the leading backslash. If
27328 you do not, the octal digit that starts your string will be incorrectly
27329 interpreted as part of the code for the first character.
27330
27331 &*Warning 2*&: If there are characters in the strings that Perl interprets
27332 specially, you must use a Perl escape to prevent them being misinterpreted. For
27333 example, a command such as
27334 .code
27335 encode '\0user@domain.com\0pas$$word'
27336 .endd
27337 gives an incorrect answer because of the unescaped &"@"& and &"$"& characters.
27338
27339 If you have the &%mimencode%& command installed, another way to do produce
27340 base64-encoded strings is to run the command
27341 .code
27342 echo -e -n `\0user\0password' | mimencode
27343 .endd
27344 The &%-e%& option of &%echo%& enables the interpretation of backslash escapes
27345 in the argument, and the &%-n%& option specifies no newline at the end of its
27346 output. However, not all versions of &%echo%& recognize these options, so you
27347 should check your version before relying on this suggestion.
27348
27349
27350
27351 .section "Authentication by an Exim client" "SECID170"
27352 .cindex "authentication" "on an Exim client"
27353 The &(smtp)& transport has two options called &%hosts_require_auth%& and
27354 &%hosts_try_auth%&. When the &(smtp)& transport connects to a server that
27355 announces support for authentication, and the host matches an entry in either
27356 of these options, Exim (as a client) tries to authenticate as follows:
27357
27358 .ilist
27359 For each authenticator that is configured as a client, in the order in which
27360 they are defined in the configuration, it searches the authentication
27361 mechanisms announced by the server for one whose name matches the public name
27362 of the authenticator.
27363 .next
27364 .vindex "&$host$&"
27365 .vindex "&$host_address$&"
27366 When it finds one that matches, it runs the authenticator's client code. The
27367 variables &$host$& and &$host_address$& are available for any string expansions
27368 that the client might do. They are set to the server's name and IP address. If
27369 any expansion is forced to fail, the authentication attempt is abandoned, and
27370 Exim moves on to the next authenticator. Otherwise an expansion failure causes
27371 delivery to be deferred.
27372 .next
27373 If the result of the authentication attempt is a temporary error or a timeout,
27374 Exim abandons trying to send the message to the host for the moment. It will
27375 try again later. If there are any backup hosts available, they are tried in the
27376 usual way.
27377 .next
27378 If the response to authentication is a permanent error (5&'xx'& code), Exim
27379 carries on searching the list of authenticators and tries another one if
27380 possible. If all authentication attempts give permanent errors, or if there are
27381 no attempts because no mechanisms match (or option expansions force failure),
27382 what happens depends on whether the host matches &%hosts_require_auth%& or
27383 &%hosts_try_auth%&. In the first case, a temporary error is generated, and
27384 delivery is deferred. The error can be detected in the retry rules, and thereby
27385 turned into a permanent error if you wish. In the second case, Exim tries to
27386 deliver the message unauthenticated.
27387 .endlist
27388
27389 Note that the hostlist test for whether to do authentication can be
27390 confused if name-IP lookups change between the time the peer is decided
27391 upon and the time that the transport runs.  For example, with a manualroute
27392 router given a host name, and with DNS "round-robin" used by that name: if
27393 the local resolver cache times out between the router and the transport
27394 running, the transport may get an IP for the name for its authentication
27395 check which does not match the connection peer IP.
27396 No authentication will then be done, despite the names being identical.
27397
27398 For such cases use a separate transport which always authenticates.
27399
27400 .cindex "AUTH" "on MAIL command"
27401 When Exim has authenticated itself to a remote server, it adds the AUTH
27402 parameter to the MAIL commands it sends, if it has an authenticated sender for
27403 the message. If the message came from a remote host, the authenticated sender
27404 is the one that was receiving on an incoming MAIL command, provided that the
27405 incoming connection was authenticated and the &%server_mail_auth%& condition
27406 allowed the authenticated sender to be retained. If a local process calls Exim
27407 to send a message, the sender address that is built from the login name and
27408 &%qualify_domain%& is treated as authenticated. However, if the
27409 &%authenticated_sender%& option is set on the &(smtp)& transport, it overrides
27410 the authenticated sender that was received with the message.
27411 .ecindex IIDauthconf1
27412 .ecindex IIDauthconf2
27413
27414
27415
27416
27417
27418
27419 . ////////////////////////////////////////////////////////////////////////////
27420 . ////////////////////////////////////////////////////////////////////////////
27421
27422 .chapter "The plaintext authenticator" "CHAPplaintext"
27423 .scindex IIDplaiauth1 "&(plaintext)& authenticator"
27424 .scindex IIDplaiauth2 "authenticators" "&(plaintext)&"
27425 The &(plaintext)& authenticator can be configured to support the PLAIN and
27426 LOGIN authentication mechanisms, both of which transfer authentication data as
27427 plain (unencrypted) text (though base64 encoded). The use of plain text is a
27428 security risk; you are strongly advised to insist on the use of SMTP encryption
27429 (see chapter &<<CHAPTLS>>&) if you use the PLAIN or LOGIN mechanisms. If you do
27430 use unencrypted plain text, you should not use the same passwords for SMTP
27431 connections as you do for login accounts.
27432
27433 .section "Avoiding cleartext use" "SECTplain_TLS"
27434 The following generic option settings will disable &(plaintext)& authenticators when
27435 TLS is not being used:
27436 .code
27437   server_advertise_condition = ${if def:tls_in_cipher }
27438   client_condition =           ${if def:tls_out_cipher}
27439 .endd
27440
27441 &*Note*&: a plaintext SMTP AUTH done inside TLS is not vulnerable to casual snooping,
27442 but is still vulnerable to a Man In The Middle attack unless certificates
27443 (including their names) have been properly verified.
27444
27445 .section "Plaintext server options" "SECID171"
27446 .cindex "options" "&(plaintext)& authenticator (server)"
27447 When configured as a server, &(plaintext)& uses the following options:
27448
27449 .option server_condition authenticators string&!! unset
27450 This is actually a global authentication option, but it must be set in order to
27451 configure the &(plaintext)& driver as a server. Its use is described below.
27452
27453 .option server_prompts plaintext "string list&!!" unset
27454 The contents of this option, after expansion, must be a colon-separated list of
27455 prompt strings. If expansion fails, a temporary authentication rejection is
27456 given.
27457
27458 .section "Using plaintext in a server" "SECTplainserver"
27459 .cindex "AUTH" "in &(plaintext)& authenticator"
27460 .cindex "binary zero" "in &(plaintext)& authenticator"
27461 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
27462         "in &(plaintext)& authenticator"
27463 .vindex "&$auth1$&, &$auth2$&, etc"
27464 .cindex "base64 encoding" "in &(plaintext)& authenticator"
27465
27466 When running as a server, &(plaintext)& performs the authentication test by
27467 expanding a string. The data sent by the client with the AUTH command, or in
27468 response to subsequent prompts, is base64 encoded, and so may contain any byte
27469 values when decoded. If any data is supplied with the command, it is treated as
27470 a list of strings, separated by NULs (binary zeros), the first three of which
27471 are placed in the expansion variables &$auth1$&, &$auth2$&, and &$auth3$&
27472 (neither LOGIN nor PLAIN uses more than three strings).
27473
27474 For compatibility with previous releases of Exim, the values are also placed in
27475 the expansion variables &$1$&, &$2$&, and &$3$&. However, the use of these
27476 variables for this purpose is now deprecated, as it can lead to confusion in
27477 string expansions that also use them for other things.
27478
27479 If there are more strings in &%server_prompts%& than the number of strings
27480 supplied with the AUTH command, the remaining prompts are used to obtain more
27481 data. Each response from the client may be a list of NUL-separated strings.
27482
27483 .vindex "&$authenticated_id$&"
27484 Once a sufficient number of data strings have been received,
27485 &%server_condition%& is expanded. If the expansion is forced to fail,
27486 authentication fails. Any other expansion failure causes a temporary error code
27487 to be returned. If the result of a successful expansion is an empty string,
27488 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
27489 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
27490 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
27491 For any other result, a temporary error code is returned, with the expanded
27492 string as the error text.
27493
27494 &*Warning*&: If you use a lookup in the expansion to find the user's
27495 password, be sure to make the authentication fail if the user is unknown.
27496 There are good and bad examples at the end of the next section.
27497
27498
27499
27500 .section "The PLAIN authentication mechanism" "SECID172"
27501 .cindex "PLAIN authentication mechanism"
27502 .cindex authentication PLAIN
27503 .cindex "binary zero" "in &(plaintext)& authenticator"
27504 The PLAIN authentication mechanism (RFC 2595) specifies that three strings be
27505 sent as one item of data (that is, one combined string containing two NUL
27506 separators). The data is sent either as part of the AUTH command, or
27507 subsequently in response to an empty prompt from the server.
27508
27509 The second and third strings are a user name and a corresponding password.
27510 Using a single fixed user name and password as an example, this could be
27511 configured as follows:
27512 .code
27513 fixed_plain:
27514   driver = plaintext
27515   public_name = PLAIN
27516   server_prompts = :
27517   server_condition = \
27518     ${if and {{eq{$auth2}{username}}{eq{$auth3}{mysecret}}}}
27519   server_set_id = $auth2
27520 .endd
27521 Note that the default result strings from &%if%& (&"true"& or an empty string)
27522 are exactly what we want here, so they need not be specified. Obviously, if the
27523 password contains expansion-significant characters such as dollar, backslash,
27524 or closing brace, they have to be escaped.
27525
27526 The &%server_prompts%& setting specifies a single, empty prompt (empty items at
27527 the end of a string list are ignored). If all the data comes as part of the
27528 AUTH command, as is commonly the case, the prompt is not used. This
27529 authenticator is advertised in the response to EHLO as
27530 .code
27531 250-AUTH PLAIN
27532 .endd
27533 and a client host can authenticate itself by sending the command
27534 .code
27535 AUTH PLAIN AHVzZXJuYW1lAG15c2VjcmV0
27536 .endd
27537 As this contains three strings (more than the number of prompts), no further
27538 data is required from the client. Alternatively, the client may just send
27539 .code
27540 AUTH PLAIN
27541 .endd
27542 to initiate authentication, in which case the server replies with an empty
27543 prompt. The client must respond with the combined data string.
27544
27545 The data string is base64 encoded, as required by the RFC. This example,
27546 when decoded, is <&'NUL'&>&`username`&<&'NUL'&>&`mysecret`&, where <&'NUL'&>
27547 represents a zero byte. This is split up into three strings, the first of which
27548 is empty. The &%server_condition%& option in the authenticator checks that the
27549 second two are &`username`& and &`mysecret`& respectively.
27550
27551 Having just one fixed user name and password, as in this example, is not very
27552 realistic, though for a small organization with only a handful of
27553 authenticating clients it could make sense.
27554
27555 A more sophisticated instance of this authenticator could use the user name in
27556 &$auth2$& to look up a password in a file or database, and maybe do an encrypted
27557 comparison (see &%crypteq%& in chapter &<<CHAPexpand>>&). Here is a example of
27558 this approach, where the passwords are looked up in a DBM file. &*Warning*&:
27559 This is an incorrect example:
27560 .code
27561 server_condition = \
27562   ${if eq{$auth3}{${lookup{$auth2}dbm{/etc/authpwd}}}}
27563 .endd
27564 The expansion uses the user name (&$auth2$&) as the key to look up a password,
27565 which it then compares to the supplied password (&$auth3$&). Why is this example
27566 incorrect? It works fine for existing users, but consider what happens if a
27567 non-existent user name is given. The lookup fails, but as no success/failure
27568 strings are given for the lookup, it yields an empty string. Thus, to defeat
27569 the authentication, all a client has to do is to supply a non-existent user
27570 name and an empty password. The correct way of writing this test is:
27571 .code
27572 server_condition = ${lookup{$auth2}dbm{/etc/authpwd}\
27573   {${if eq{$value}{$auth3}}} {false}}
27574 .endd
27575 In this case, if the lookup succeeds, the result is checked; if the lookup
27576 fails, &"false"& is returned and authentication fails. If &%crypteq%& is being
27577 used instead of &%eq%&, the first example is in fact safe, because &%crypteq%&
27578 always fails if its second argument is empty. However, the second way of
27579 writing the test makes the logic clearer.
27580
27581
27582 .section "The LOGIN authentication mechanism" "SECID173"
27583 .cindex "LOGIN authentication mechanism"
27584 .cindex authentication LOGIN
27585 The LOGIN authentication mechanism is not documented in any RFC, but is in use
27586 in a number of programs. No data is sent with the AUTH command. Instead, a
27587 user name and password are supplied separately, in response to prompts. The
27588 plaintext authenticator can be configured to support this as in this example:
27589 .code
27590 fixed_login:
27591   driver = plaintext
27592   public_name = LOGIN
27593   server_prompts = User Name : Password
27594   server_condition = \
27595     ${if and {{eq{$auth1}{username}}{eq{$auth2}{mysecret}}}}
27596   server_set_id = $auth1
27597 .endd
27598 Because of the way plaintext operates, this authenticator accepts data supplied
27599 with the AUTH command (in contravention of the specification of LOGIN), but
27600 if the client does not supply it (as is the case for LOGIN clients), the prompt
27601 strings are used to obtain two data items.
27602
27603 Some clients are very particular about the precise text of the prompts. For
27604 example, Outlook Express is reported to recognize only &"Username:"& and
27605 &"Password:"&. Here is an example of a LOGIN authenticator that uses those
27606 strings. It uses the &%ldapauth%& expansion condition to check the user
27607 name and password by binding to an LDAP server:
27608 .code
27609 login:
27610   driver = plaintext
27611   public_name = LOGIN
27612   server_prompts = Username:: : Password::
27613   server_condition = ${if and{{ \
27614     !eq{}{$auth1} }{ \
27615     ldapauth{\
27616       user="uid=${quote_ldap_dn:$auth1},ou=people,o=example.org" \
27617       pass=${quote:$auth2} \
27618       ldap://ldap.example.org/} }} }
27619   server_set_id = uid=$auth1,ou=people,o=example.org
27620 .endd
27621 We have to check that the username is not empty before using it, because LDAP
27622 does not permit empty DN components. We must also use the &%quote_ldap_dn%&
27623 operator to correctly quote the DN for authentication. However, the basic
27624 &%quote%& operator, rather than any of the LDAP quoting operators, is the
27625 correct one to use for the password, because quoting is needed only to make
27626 the password conform to the Exim syntax. At the LDAP level, the password is an
27627 uninterpreted string.
27628
27629
27630 .section "Support for different kinds of authentication" "SECID174"
27631 A number of string expansion features are provided for the purpose of
27632 interfacing to different ways of user authentication. These include checking
27633 traditionally encrypted passwords from &_/etc/passwd_& (or equivalent), PAM,
27634 Radius, &%ldapauth%&, &'pwcheck'&, and &'saslauthd'&. For details see section
27635 &<<SECTexpcond>>&.
27636
27637
27638
27639
27640 .section "Using plaintext in a client" "SECID175"
27641 .cindex "options" "&(plaintext)& authenticator (client)"
27642 The &(plaintext)& authenticator has two client options:
27643
27644 .option client_ignore_invalid_base64 plaintext boolean false
27645 If the client receives a server prompt that is not a valid base64 string,
27646 authentication is abandoned by default. However, if this option is set true,
27647 the error in the challenge is ignored and the client sends the response as
27648 usual.
27649
27650 .option client_send plaintext string&!! unset
27651 The string is a colon-separated list of authentication data strings. Each
27652 string is independently expanded before being sent to the server. The first
27653 string is sent with the AUTH command; any more strings are sent in response
27654 to prompts from the server. Before each string is expanded, the value of the
27655 most recent prompt is placed in the next &$auth$&<&'n'&> variable, starting
27656 with &$auth1$& for the first prompt. Up to three prompts are stored in this
27657 way. Thus, the prompt that is received in response to sending the first string
27658 (with the AUTH command) can be used in the expansion of the second string, and
27659 so on. If an invalid base64 string is received when
27660 &%client_ignore_invalid_base64%& is set, an empty string is put in the
27661 &$auth$&<&'n'&> variable.
27662
27663 &*Note*&: You cannot use expansion to create multiple strings, because
27664 splitting takes priority and happens first.
27665
27666 Because the PLAIN authentication mechanism requires NUL (binary zero) bytes in
27667 the data, further processing is applied to each string before it is sent. If
27668 there are any single circumflex characters in the string, they are converted to
27669 NULs. Should an actual circumflex be required as data, it must be doubled in
27670 the string.
27671
27672 This is an example of a client configuration that implements the PLAIN
27673 authentication mechanism with a fixed user name and password:
27674 .code
27675 fixed_plain:
27676   driver = plaintext
27677   public_name = PLAIN
27678   client_send = ^username^mysecret
27679 .endd
27680 The lack of colons means that the entire text is sent with the AUTH
27681 command, with the circumflex characters converted to NULs. A similar example
27682 that uses the LOGIN mechanism is:
27683 .code
27684 fixed_login:
27685   driver = plaintext
27686   public_name = LOGIN
27687   client_send = : username : mysecret
27688 .endd
27689 The initial colon means that the first string is empty, so no data is sent with
27690 the AUTH command itself. The remaining strings are sent in response to
27691 prompts.
27692 .ecindex IIDplaiauth1
27693 .ecindex IIDplaiauth2
27694
27695
27696
27697
27698 . ////////////////////////////////////////////////////////////////////////////
27699 . ////////////////////////////////////////////////////////////////////////////
27700
27701 .chapter "The cram_md5 authenticator" "CHID9"
27702 .scindex IIDcramauth1 "&(cram_md5)& authenticator"
27703 .scindex IIDcramauth2 "authenticators" "&(cram_md5)&"
27704 .cindex "CRAM-MD5 authentication mechanism"
27705 .cindex authentication CRAM-MD5
27706 The CRAM-MD5 authentication mechanism is described in RFC 2195. The server
27707 sends a challenge string to the client, and the response consists of a user
27708 name and the CRAM-MD5 digest of the challenge string combined with a secret
27709 string (password) which is known to both server and client. Thus, the secret
27710 is not sent over the network as plain text, which makes this authenticator more
27711 secure than &(plaintext)&. However, the downside is that the secret has to be
27712 available in plain text at either end.
27713
27714
27715 .section "Using cram_md5 as a server" "SECID176"
27716 .cindex "options" "&(cram_md5)& authenticator (server)"
27717 This authenticator has one server option, which must be set to configure the
27718 authenticator as a server:
27719
27720 .option server_secret cram_md5 string&!! unset
27721 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(cram_md5)& authenticator"
27722 When the server receives the client's response, the user name is placed in
27723 the expansion variable &$auth1$&, and &%server_secret%& is expanded to
27724 obtain the password for that user. The server then computes the CRAM-MD5 digest
27725 that the client should have sent, and checks that it received the correct
27726 string. If the expansion of &%server_secret%& is forced to fail, authentication
27727 fails. If the expansion fails for some other reason, a temporary error code is
27728 returned to the client.
27729
27730 For compatibility with previous releases of Exim, the user name is also placed
27731 in &$1$&. However, the use of this variables for this purpose is now
27732 deprecated, as it can lead to confusion in string expansions that also use
27733 numeric variables for other things.
27734
27735 For example, the following authenticator checks that the user name given by the
27736 client is &"ph10"&, and if so, uses &"secret"& as the password. For any other
27737 user name, authentication fails.
27738 .code
27739 fixed_cram:
27740   driver = cram_md5
27741   public_name = CRAM-MD5
27742   server_secret = ${if eq{$auth1}{ph10}{secret}fail}
27743   server_set_id = $auth1
27744 .endd
27745 .vindex "&$authenticated_id$&"
27746 If authentication succeeds, the setting of &%server_set_id%& preserves the user
27747 name in &$authenticated_id$&. A more typical configuration might look up the
27748 secret string in a file, using the user name as the key. For example:
27749 .code
27750 lookup_cram:
27751   driver = cram_md5
27752   public_name = CRAM-MD5
27753   server_secret = ${lookup{$auth1}lsearch{/etc/authpwd}\
27754                   {$value}fail}
27755   server_set_id = $auth1
27756 .endd
27757 Note that this expansion explicitly forces failure if the lookup fails
27758 because &$auth1$& contains an unknown user name.
27759
27760 As another example, if you wish to re-use a Cyrus SASL sasldb2 file without
27761 using the relevant libraries, you need to know the realm to specify in the
27762 lookup and then ask for the &"userPassword"& attribute for that user in that
27763 realm, with:
27764 .code
27765 cyrusless_crammd5:
27766   driver = cram_md5
27767   public_name = CRAM-MD5
27768   server_secret = ${lookup{$auth1:mail.example.org:userPassword}\
27769                   dbmjz{/etc/sasldb2}{$value}fail}
27770   server_set_id = $auth1
27771 .endd
27772
27773 .section "Using cram_md5 as a client" "SECID177"
27774 .cindex "options" "&(cram_md5)& authenticator (client)"
27775 When used as a client, the &(cram_md5)& authenticator has two options:
27776
27777
27778
27779 .option client_name cram_md5 string&!! "the primary host name"
27780 This string is expanded, and the result used as the user name data when
27781 computing the response to the server's challenge.
27782
27783
27784 .option client_secret cram_md5 string&!! unset
27785 This option must be set for the authenticator to work as a client. Its value is
27786 expanded and the result used as the secret string when computing the response.
27787
27788
27789 .vindex "&$host$&"
27790 .vindex "&$host_address$&"
27791 Different user names and secrets can be used for different servers by referring
27792 to &$host$& or &$host_address$& in the options. Forced failure of either
27793 expansion string is treated as an indication that this authenticator is not
27794 prepared to handle this case. Exim moves on to the next configured client
27795 authenticator. Any other expansion failure causes Exim to give up trying to
27796 send the message to the current server.
27797
27798 A simple example configuration of a &(cram_md5)& authenticator, using fixed
27799 strings, is:
27800 .code
27801 fixed_cram:
27802   driver = cram_md5
27803   public_name = CRAM-MD5
27804   client_name = ph10
27805   client_secret = secret
27806 .endd
27807 .ecindex IIDcramauth1
27808 .ecindex IIDcramauth2
27809
27810
27811
27812 . ////////////////////////////////////////////////////////////////////////////
27813 . ////////////////////////////////////////////////////////////////////////////
27814
27815 .chapter "The cyrus_sasl authenticator" "CHID10"
27816 .scindex IIDcyrauth1 "&(cyrus_sasl)& authenticator"
27817 .scindex IIDcyrauth2 "authenticators" "&(cyrus_sasl)&"
27818 .cindex "Cyrus" "SASL library"
27819 .cindex "Kerberos"
27820 The code for this authenticator was provided by Matthew Byng-Maddick while
27821 at A L Digital Ltd.
27822
27823 The &(cyrus_sasl)& authenticator provides server support for the Cyrus SASL
27824 library implementation of the RFC 2222 (&"Simple Authentication and Security
27825 Layer"&). This library supports a number of authentication mechanisms,
27826 including PLAIN and LOGIN, but also several others that Exim does not support
27827 directly. In particular, there is support for Kerberos authentication.
27828
27829 The &(cyrus_sasl)& authenticator provides a gatewaying mechanism directly to
27830 the Cyrus interface, so if your Cyrus library can do, for example, CRAM-MD5,
27831 then so can the &(cyrus_sasl)& authenticator. By default it uses the public
27832 name of the driver to determine which mechanism to support.
27833
27834 Where access to some kind of secret file is required, for example, in GSSAPI
27835 or CRAM-MD5, it is worth noting that the authenticator runs as the Exim
27836 user, and that the Cyrus SASL library has no way of escalating privileges
27837 by default. You may also find you need to set environment variables,
27838 depending on the driver you are using.
27839
27840 The application name provided by Exim is &"exim"&, so various SASL options may
27841 be set in &_exim.conf_& in your SASL directory. If you are using GSSAPI for
27842 Kerberos, note that because of limitations in the GSSAPI interface,
27843 changing the server keytab might need to be communicated down to the Kerberos
27844 layer independently. The mechanism for doing so is dependent upon the Kerberos
27845 implementation.
27846
27847 For example, for older releases of Heimdal, the environment variable KRB5_KTNAME
27848 may be set to point to an alternative keytab file. Exim will pass this
27849 variable through from its own inherited environment when started as root or the
27850 Exim user. The keytab file needs to be readable by the Exim user.
27851 With newer releases of Heimdal, a setuid Exim may cause Heimdal to discard the
27852 environment variable.  In practice, for those releases, the Cyrus authenticator
27853 is not a suitable interface for GSSAPI (Kerberos) support.  Instead, consider
27854 the &(heimdal_gssapi)& authenticator, described in chapter &<<CHAPheimdalgss>>&
27855
27856
27857 .section "Using cyrus_sasl as a server" "SECID178"
27858 The &(cyrus_sasl)& authenticator has four private options. It puts the username
27859 (on a successful authentication) into &$auth1$&. For compatibility with
27860 previous releases of Exim, the username is also placed in &$1$&. However, the
27861 use of this variable for this purpose is now deprecated, as it can lead to
27862 confusion in string expansions that also use numeric variables for other
27863 things.
27864
27865
27866 .option server_hostname cyrus_sasl string&!! "see below"
27867 This option selects the hostname that is used when communicating with the
27868 library. The default value is &`$primary_hostname`&. It is up to the underlying
27869 SASL plug-in what it does with this data.
27870
27871
27872 .option server_mech cyrus_sasl string "see below"
27873 This option selects the authentication mechanism this driver should use. The
27874 default is the value of the generic &%public_name%& option. This option allows
27875 you to use a different underlying mechanism from the advertised name. For
27876 example:
27877 .code
27878 sasl:
27879   driver = cyrus_sasl
27880   public_name = X-ANYTHING
27881   server_mech = CRAM-MD5
27882   server_set_id = $auth1
27883 .endd
27884
27885 .option server_realm cyrus_sasl string&!! unset
27886 This specifies the SASL realm that the server claims to be in.
27887
27888
27889 .option server_service cyrus_sasl string &`smtp`&
27890 This is the SASL service that the server claims to implement.
27891
27892
27893 For straightforward cases, you do not need to set any of the authenticator's
27894 private options. All you need to do is to specify an appropriate mechanism as
27895 the public name. Thus, if you have a SASL library that supports CRAM-MD5 and
27896 PLAIN, you could have two authenticators as follows:
27897 .code
27898 sasl_cram_md5:
27899   driver = cyrus_sasl
27900   public_name = CRAM-MD5
27901   server_set_id = $auth1
27902
27903 sasl_plain:
27904   driver = cyrus_sasl
27905   public_name = PLAIN
27906   server_set_id = $auth2
27907 .endd
27908 Cyrus SASL does implement the LOGIN authentication method, even though it is
27909 not a standard method. It is disabled by default in the source distribution,
27910 but it is present in many binary distributions.
27911 .ecindex IIDcyrauth1
27912 .ecindex IIDcyrauth2
27913
27914
27915
27916
27917 . ////////////////////////////////////////////////////////////////////////////
27918 . ////////////////////////////////////////////////////////////////////////////
27919 .chapter "The dovecot authenticator" "CHAPdovecot"
27920 .scindex IIDdcotauth1 "&(dovecot)& authenticator"
27921 .scindex IIDdcotauth2 "authenticators" "&(dovecot)&"
27922 This authenticator is an interface to the authentication facility of the
27923 Dovecot 2 POP/IMAP server, which can support a number of authentication methods.
27924 Note that Dovecot must be configured to use auth-client not auth-userdb.
27925 If you are using Dovecot to authenticate POP/IMAP clients, it might be helpful
27926 to use the same mechanisms for SMTP authentication. This is a server
27927 authenticator only. There is only one option:
27928
27929 .option server_socket dovecot string unset
27930
27931 This option must specify the UNIX socket that is the interface to Dovecot
27932 authentication. The &%public_name%& option must specify an authentication
27933 mechanism that Dovecot is configured to support. You can have several
27934 authenticators for different mechanisms. For example:
27935 .code
27936 dovecot_plain:
27937   driver = dovecot
27938   public_name = PLAIN
27939   server_socket = /var/run/dovecot/auth-client
27940   server_set_id = $auth1
27941
27942 dovecot_ntlm:
27943   driver = dovecot
27944   public_name = NTLM
27945   server_socket = /var/run/dovecot/auth-client
27946   server_set_id = $auth1
27947 .endd
27948 If the SMTP connection is encrypted, or if &$sender_host_address$& is equal to
27949 &$received_ip_address$& (that is, the connection is local), the &"secured"&
27950 option is passed in the Dovecot authentication command. If, for a TLS
27951 connection, a client certificate has been verified, the &"valid-client-cert"&
27952 option is passed. When authentication succeeds, the identity of the user
27953 who authenticated is placed in &$auth1$&.
27954
27955 The Dovecot configuration to match the above wil look
27956 something like:
27957 .code
27958 conf.d/10-master.conf :-
27959
27960 service auth {
27961 ...
27962 #SASL
27963   unix_listener auth-client {
27964     mode = 0660
27965     user = mail
27966   }
27967 ...
27968 }
27969
27970 conf.d/10-auth.conf :-
27971
27972 auth_mechanisms = plain login ntlm
27973 .endd
27974
27975 .ecindex IIDdcotauth1
27976 .ecindex IIDdcotauth2
27977
27978
27979 . ////////////////////////////////////////////////////////////////////////////
27980 . ////////////////////////////////////////////////////////////////////////////
27981 .chapter "The gsasl authenticator" "CHAPgsasl"
27982 .scindex IIDgsaslauth1 "&(gsasl)& authenticator"
27983 .scindex IIDgsaslauth2 "authenticators" "&(gsasl)&"
27984 .cindex "authentication" "GNU SASL"
27985 .cindex "authentication" "SASL"
27986 .cindex "authentication" "EXTERNAL"
27987 .cindex "authentication" "ANONYMOUS"
27988 .cindex "authentication" "PLAIN"
27989 .cindex "authentication" "LOGIN"
27990 .cindex "authentication" "DIGEST-MD5"
27991 .cindex "authentication" "CRAM-MD5"
27992 .cindex "authentication" "SCRAM family"
27993 The &(gsasl)& authenticator provides integration for the GNU SASL
27994 library and the mechanisms it provides.  This is new as of the 4.80 release
27995 and there are a few areas where the library does not let Exim smoothly
27996 scale to handle future authentication mechanisms, so no guarantee can be
27997 made that any particular new authentication mechanism will be supported
27998 without code changes in Exim.
27999
28000 The library is expected to add support in an upcoming
28001 realease for the SCRAM-SHA-256 method.
28002 The macro _HAVE_AUTH_GSASL_SCRAM_SHA_256 will be defined
28003 when this happens.
28004
28005
28006 .option client_authz gsasl string&!! unset
28007 This option can be used to supply an &'authorization id'&
28008 which is different to the &'authentication_id'& provided
28009 by &%client_username%& option.
28010 If unset or (after expansion) empty it is not used,
28011 which is the common case.
28012
28013 .option client_channelbinding gsasl boolean false
28014 See &%server_channelbinding%& below.
28015
28016 .option client_password gsasl string&!! unset
28017 This option is exapanded before use, and should result in
28018 the password to be used, in clear.
28019
28020 .option client_username gsasl string&!! unset
28021 This option is exapanded before use, and should result in
28022 the account name to be used.
28023
28024 .option client_spassword gsasl string&!! unset
28025 If a SCRAM mechanism is being used and this option is set
28026 it is used in preference to &%client_password%&.
28027 The value after expansion should be
28028 a 40 (for SHA-1) or 64 (for SHA-256) character string
28029 with the PBKDF2-prepared password, hex-encoded.
28030 Note that this value will depend on the salt and iteration-count
28031 supplied by the server.
28032
28033
28034
28035 .option server_channelbinding gsasl boolean false
28036 Do not set this true and rely on the properties
28037 without consulting a cryptographic engineer.
28038
28039 Some authentication mechanisms are able to use external context at both ends
28040 of the session to bind the authentication to that context, and fail the
28041 authentication process if that context differs.  Specifically, some TLS
28042 ciphersuites can provide identifying information about the cryptographic
28043 context.
28044
28045 This should have meant that certificate identity and verification becomes a
28046 non-issue, as a man-in-the-middle attack will cause the correct client and
28047 server to see different identifiers and authentication will fail.
28048
28049 This is
28050 only usable by mechanisms which support "channel binding"; at time of
28051 writing, that's the SCRAM family.
28052 When using this feature the "-PLUS" variants of the method names need to be used.
28053
28054 This defaults off to ensure smooth upgrade across Exim releases, in case
28055 this option causes some clients to start failing.  Some future release
28056 of Exim might have switched the default to be true.
28057
28058 However, Channel Binding in TLS has proven to be vulnerable in current versions.
28059 Do not plan to rely upon this feature for security, ever, without consulting
28060 with a subject matter expert (a cryptographic engineer).
28061
28062
28063 .option server_hostname gsasl string&!! "see below"
28064 This option selects the hostname that is used when communicating with the
28065 library. The default value is &`$primary_hostname`&.
28066 Some mechanisms will use this data.
28067
28068
28069 .option server_mech gsasl string "see below"
28070 This option selects the authentication mechanism this driver should use. The
28071 default is the value of the generic &%public_name%& option. This option allows
28072 you to use a different underlying mechanism from the advertised name. For
28073 example:
28074 .code
28075 sasl:
28076   driver = gsasl
28077   public_name = X-ANYTHING
28078   server_mech = CRAM-MD5
28079   server_set_id = $auth1
28080 .endd
28081
28082
28083 .option server_password gsasl string&!! unset
28084 Various mechanisms need access to the cleartext password on the server, so
28085 that proof-of-possession can be demonstrated on the wire, without sending
28086 the password itself.
28087
28088 The data available for lookup varies per mechanism.
28089 In all cases, &$auth1$& is set to the &'authentication id'&.
28090 The &$auth2$& variable will always be the &'authorization id'& (&'authz'&)
28091 if available, else the empty string.
28092 The &$auth3$& variable will always be the &'realm'& if available,
28093 else the empty string.
28094
28095 A forced failure will cause authentication to defer.
28096
28097 If using this option, it may make sense to set the &%server_condition%&
28098 option to be simply "true".
28099
28100
28101 .option server_realm gsasl string&!! unset
28102 This specifies the SASL realm that the server claims to be in.
28103 Some mechanisms will use this data.
28104
28105
28106 .option server_scram_iter gsasl string&!! 4096
28107 This option provides data for the SCRAM family of mechanisms.
28108 The &$auth1$&, &$auth2$& and &$auth3$& variables are available
28109 when this option is expanded.
28110
28111 The result of expansion should be a decimal number,
28112 and represents both a lower-bound on the security, and
28113 a compute cost factor imposed on the client
28114 (if it does not cache results, or the server changes
28115 either the iteration count or the salt).
28116 A minimum value of 4096 is required by the standards
28117 for all current SCRAM mechanism variants.
28118
28119 .option server_scram_salt gsasl string&!! unset
28120 This option provides data for the SCRAM family of mechanisms.
28121 The &$auth1$&, &$auth2$& and &$auth3$& variables are available
28122 when this option is expanded.
28123 The value should be a base64-encoded string,
28124 of random data typically 4-to-16 bytes long.
28125 If unset or empty after expansion the library will provides a value for the
28126 protocol conversation.
28127
28128
28129 .option server_key gsasl string&!! unset
28130 .option server_skey gsasl string&!! unset
28131 These options can be used for the SCRAM family of mechanisms
28132 to provide stored information related to a password,
28133 the storage of which is preferable to plaintext.
28134
28135 &%server_key%& is the value defined in the SCRAM standards as ServerKey;
28136 &%server_skey%& is StoredKey.
28137
28138 They are only available for version 1.9.0 (or later) of the gsasl library.
28139 When this is so, the macros
28140 _OPT_AUTHENTICATOR_GSASL_SERVER_KEY
28141 and _HAVE_AUTH_GSASL_SCRAM_S_KEY
28142 will be defined.
28143
28144 The &$authN$& variables are available when these options are expanded.
28145
28146 If set, the results of expansion should for each
28147 should be a 28 (for SHA-1) or 44 (for SHA-256) character string
28148 of base64-coded data, and will be used in preference to the
28149 &%server_password%& option.
28150 If unset or not of the right length, &%server_password%& will be used.
28151
28152 The libgsasl library release includes a utility &'gsasl'& which can be used
28153 to generate these values.
28154
28155
28156 .option server_service gsasl string &`smtp`&
28157 This is the SASL service that the server claims to implement.
28158 Some mechanisms will use this data.
28159
28160
28161 .section "&(gsasl)& auth variables" "SECTgsaslauthvar"
28162 .vindex "&$auth1$&, &$auth2$&, etc"
28163 These may be set when evaluating specific options, as detailed above.
28164 They will also be set when evaluating &%server_condition%&.
28165
28166 Unless otherwise stated below, the &(gsasl)& integration will use the following
28167 meanings for these variables:
28168
28169 .ilist
28170 .vindex "&$auth1$&"
28171 &$auth1$&: the &'authentication id'&
28172 .next
28173 .vindex "&$auth2$&"
28174 &$auth2$&: the &'authorization id'&
28175 .next
28176 .vindex "&$auth3$&"
28177 &$auth3$&: the &'realm'&
28178 .endlist
28179
28180 On a per-mechanism basis:
28181
28182 .ilist
28183 .cindex "authentication" "EXTERNAL"
28184 EXTERNAL: only &$auth1$& is set, to the possibly empty &'authorization id'&;
28185 the &%server_condition%& option must be present.
28186 .next
28187 .cindex "authentication" "ANONYMOUS"
28188 ANONYMOUS: only &$auth1$& is set, to the possibly empty &'anonymous token'&;
28189 the &%server_condition%& option must be present.
28190 .next
28191 .cindex "authentication" "GSSAPI"
28192 GSSAPI: &$auth1$& will be set to the &'GSSAPI Display Name'&;
28193 &$auth2$& will be set to the &'authorization id'&,
28194 the &%server_condition%& option must be present.
28195 .endlist
28196
28197 An &'anonymous token'& is something passed along as an unauthenticated
28198 identifier; this is analogous to FTP anonymous authentication passing an
28199 email address, or software-identifier@, as the "password".
28200
28201
28202 An example showing the password having the realm specified in the callback
28203 and demonstrating a Cyrus SASL to GSASL migration approach is:
28204 .code
28205 gsasl_cyrusless_crammd5:
28206   driver = gsasl
28207   public_name = CRAM-MD5
28208   server_realm = imap.example.org
28209   server_password = ${lookup{$auth1:$auth3:userPassword}\
28210                     dbmjz{/etc/sasldb2}{$value}fail}
28211   server_set_id = ${quote:$auth1}
28212   server_condition = yes
28213 .endd
28214
28215
28216 . ////////////////////////////////////////////////////////////////////////////
28217 . ////////////////////////////////////////////////////////////////////////////
28218
28219 .chapter "The heimdal_gssapi authenticator" "CHAPheimdalgss"
28220 .scindex IIDheimdalgssauth1 "&(heimdal_gssapi)& authenticator"
28221 .scindex IIDheimdalgssauth2 "authenticators" "&(heimdal_gssapi)&"
28222 .cindex "authentication" "GSSAPI"
28223 .cindex "authentication" "Kerberos"
28224 The &(heimdal_gssapi)& authenticator provides server integration for the
28225 Heimdal GSSAPI/Kerberos library, permitting Exim to set a keytab pathname
28226 reliably.
28227
28228 .option server_hostname heimdal_gssapi string&!! "see below"
28229 This option selects the hostname that is used, with &%server_service%&,
28230 for constructing the GSS server name, as a &'GSS_C_NT_HOSTBASED_SERVICE'&
28231 identifier.  The default value is &`$primary_hostname`&.
28232
28233 .option server_keytab heimdal_gssapi string&!! unset
28234 If set, then Heimdal will not use the system default keytab (typically
28235 &_/etc/krb5.keytab_&) but instead the pathname given in this option.
28236 The value should be a pathname, with no &"file:"& prefix.
28237
28238 .option server_service heimdal_gssapi string&!! "smtp"
28239 This option specifies the service identifier used, in conjunction with
28240 &%server_hostname%&, for building the identifier for finding credentials
28241 from the keytab.
28242
28243
28244 .section "&(heimdal_gssapi)& auth variables" "SECTheimdalgssauthvar"
28245 Beware that these variables will typically include a realm, thus will appear
28246 to be roughly like an email address already.  The &'authzid'& in &$auth2$& is
28247 not verified, so a malicious client can set it to anything.
28248
28249 The &$auth1$& field should be safely trustable as a value from the Key
28250 Distribution Center.  Note that these are not quite email addresses.
28251 Each identifier is for a role, and so the left-hand-side may include a
28252 role suffix.  For instance, &"joe/admin@EXAMPLE.ORG"&.
28253
28254 .vindex "&$auth1$&, &$auth2$&, etc"
28255 .ilist
28256 .vindex "&$auth1$&"
28257 &$auth1$&: the &'authentication id'&, set to the GSS Display Name.
28258 .next
28259 .vindex "&$auth2$&"
28260 &$auth2$&: the &'authorization id'&, sent within SASL encapsulation after
28261 authentication.  If that was empty, this will also be set to the
28262 GSS Display Name.
28263 .endlist
28264
28265
28266 . ////////////////////////////////////////////////////////////////////////////
28267 . ////////////////////////////////////////////////////////////////////////////
28268
28269 .chapter "The spa authenticator" "CHAPspa"
28270 .scindex IIDspaauth1 "&(spa)& authenticator"
28271 .scindex IIDspaauth2 "authenticators" "&(spa)&"
28272 .cindex "authentication" "Microsoft Secure Password"
28273 .cindex "authentication" "NTLM"
28274 .cindex "Microsoft Secure Password Authentication"
28275 .cindex "NTLM authentication"
28276 The &(spa)& authenticator provides client support for Microsoft's &'Secure
28277 Password Authentication'& mechanism,
28278 which is also sometimes known as NTLM (NT LanMan). The code for client side of
28279 this authenticator was contributed by Marc Prud'hommeaux, and much of it is
28280 taken from the Samba project (&url(https://www.samba.org/)). The code for the
28281 server side was subsequently contributed by Tom Kistner. The mechanism works as
28282 follows:
28283
28284 .ilist
28285 After the AUTH command has been accepted, the client sends an SPA
28286 authentication request based on the user name and optional domain.
28287 .next
28288 The server sends back a challenge.
28289 .next
28290 The client builds a challenge response which makes use of the user's password
28291 and sends it to the server, which then accepts or rejects it.
28292 .endlist
28293
28294 Encryption is used to protect the password in transit.
28295
28296
28297
28298 .section "Using spa as a server" "SECID179"
28299 .cindex "options" "&(spa)& authenticator (server)"
28300 The &(spa)& authenticator has just one server option:
28301
28302 .option server_password spa string&!! unset
28303 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(spa)& authenticator"
28304 This option is expanded, and the result must be the cleartext password for the
28305 authenticating user, whose name is at this point in &$auth1$&. For
28306 compatibility with previous releases of Exim, the user name is also placed in
28307 &$1$&. However, the use of this variable for this purpose is now deprecated, as
28308 it can lead to confusion in string expansions that also use numeric variables
28309 for other things. For example:
28310 .code
28311 spa:
28312   driver = spa
28313   public_name = NTLM
28314   server_password = \
28315     ${lookup{$auth1}lsearch{/etc/exim/spa_clearpass}{$value}fail}
28316 .endd
28317 If the expansion is forced to fail, authentication fails. Any other expansion
28318 failure causes a temporary error code to be returned.
28319
28320
28321
28322
28323
28324 .section "Using spa as a client" "SECID180"
28325 .cindex "options" "&(spa)& authenticator (client)"
28326 The &(spa)& authenticator has the following client options:
28327
28328
28329
28330 .option client_domain spa string&!! unset
28331 This option specifies an optional domain for the authentication.
28332
28333
28334 .option client_password spa string&!! unset
28335 This option specifies the user's password, and must be set.
28336
28337
28338 .option client_username spa string&!! unset
28339 This option specifies the user name, and must be set. Here is an example of a
28340 configuration of this authenticator for use with the mail servers at
28341 &'msn.com'&:
28342 .code
28343 msn:
28344   driver = spa
28345   public_name = MSN
28346   client_username = msn/msn_username
28347   client_password = msn_plaintext_password
28348   client_domain = DOMAIN_OR_UNSET
28349 .endd
28350 .ecindex IIDspaauth1
28351 .ecindex IIDspaauth2
28352
28353
28354
28355
28356
28357 . ////////////////////////////////////////////////////////////////////////////
28358 . ////////////////////////////////////////////////////////////////////////////
28359
28360 .chapter "The external authenticator" "CHAPexternauth"
28361 .scindex IIDexternauth1 "&(external)& authenticator"
28362 .scindex IIDexternauth2 "authenticators" "&(external)&"
28363 .cindex "authentication" "Client Certificate"
28364 .cindex "authentication" "X509"
28365 .cindex "Certificate-based authentication"
28366 The &(external)& authenticator provides support for
28367 authentication based on non-SMTP information.
28368 The specification is in RFC 4422 Appendix A
28369 (&url(https://tools.ietf.org/html/rfc4422)).
28370 It is only a transport and negotiation mechanism;
28371 the process of authentication is entirely controlled
28372 by the server configuration.
28373
28374 The client presents an identity in-clear.
28375 It is probably wise for a server to only advertise,
28376 and for clients to only attempt,
28377 this authentication method on a secure (eg. under TLS) connection.
28378
28379 One possible use, compatible with the
28380 K-9 Mail Andoid client (&url(https://k9mail.github.io/)),
28381 is for using X509 client certificates.
28382
28383 It thus overlaps in function with the TLS authenticator
28384 (see &<<CHAPtlsauth>>&)
28385 but is a full SMTP SASL authenticator
28386 rather than being implicit for TLS-connection carried
28387 client certificates only.
28388
28389 The examples and discussion in this chapter assume that
28390 client-certificate authentication is being done.
28391
28392 The client must present a certificate,
28393 for which it must have been requested via the
28394 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& main options
28395 (see &<<CHAPTLS>>&).
28396 For authentication to be effective the certificate should be
28397 verifiable against a trust-anchor certificate known to the server.
28398
28399 .section "External options" "SECTexternsoptions"
28400 .cindex "options" "&(external)& authenticator (server)"
28401 The &(external)& authenticator has two server options:
28402
28403 .option server_param2 external string&!! unset
28404 .option server_param3 external string&!! unset
28405 .cindex "variables (&$auth1$& &$auth2$& etc)" "in &(external)& authenticator"
28406 These options are expanded before the &%server_condition%& option
28407 and the result are placed in &$auth2$& and &$auth3$& resectively.
28408 If the expansion is forced to fail, authentication fails. Any other expansion
28409 failure causes a temporary error code to be returned.
28410
28411 They can be used to clarify the coding of a complex &%server_condition%&.
28412
28413 .section "Using external in a server" "SECTexternserver"
28414 .cindex "AUTH" "in &(external)& authenticator"
28415 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
28416         "in &(external)& authenticator"
28417 .vindex "&$auth1$&, &$auth2$&, etc"
28418 .cindex "base64 encoding" "in &(external)& authenticator"
28419
28420 When running as a server, &(external)& performs the authentication test by
28421 expanding a string. The data sent by the client with the AUTH command, or in
28422 response to subsequent prompts, is base64 encoded, and so may contain any byte
28423 values when decoded. The decoded value is treated as
28424 an identity for authentication and
28425 placed in the expansion variable &$auth1$&.
28426
28427 For compatibility with previous releases of Exim, the value is also placed in
28428 the expansion variable &$1$&. However, the use of this
28429 variable for this purpose is now deprecated, as it can lead to confusion in
28430 string expansions that also use them for other things.
28431
28432 .vindex "&$authenticated_id$&"
28433 Once an identity has been received,
28434 &%server_condition%& is expanded. If the expansion is forced to fail,
28435 authentication fails. Any other expansion failure causes a temporary error code
28436 to be returned. If the result of a successful expansion is an empty string,
28437 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
28438 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
28439 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
28440 For any other result, a temporary error code is returned, with the expanded
28441 string as the error text.
28442
28443 Example:
28444 .code
28445 ext_ccert_san_mail:
28446   driver =            external
28447   public_name =       EXTERNAL
28448
28449   server_advertise_condition = $tls_in_certificate_verified
28450   server_param2 =     ${certextract {subj_altname,mail,>:} \
28451                                     {$tls_in_peercert}}
28452   server_condition =  ${if forany {$auth2} \
28453                             {eq {$item}{$auth1}}}
28454   server_set_id =     $auth1
28455 .endd
28456 This accepts a client certificate that is verifiable against any
28457 of your configured trust-anchors
28458 (which usually means the full set of public CAs)
28459 and which has a mail-SAN matching the claimed identity sent by the client.
28460
28461 &*Note*&: up to TLS1.2, the client cert is on the wire in-clear, including the SAN.
28462 The account name is therefore guessable by an opponent.
28463 TLS 1.3 protects both server and client certificates, and is not vulnerable
28464 in this way.
28465
28466
28467 .section "Using external in a client" "SECTexternclient"
28468 .cindex "options" "&(external)& authenticator (client)"
28469 The &(external)& authenticator has one client option:
28470
28471 .option client_send external string&!! unset
28472 This option is expanded and sent with the AUTH command as the
28473 identity being asserted.
28474
28475 Example:
28476 .code
28477 ext_ccert:
28478   driver =      external
28479   public_name = EXTERNAL
28480
28481   client_condition = ${if !eq{$tls_out_cipher}{}}
28482   client_send = myaccount@smarthost.example.net
28483 .endd
28484
28485
28486 .ecindex IIDexternauth1
28487 .ecindex IIDexternauth2
28488
28489
28490
28491
28492
28493 . ////////////////////////////////////////////////////////////////////////////
28494 . ////////////////////////////////////////////////////////////////////////////
28495
28496 .chapter "The tls authenticator" "CHAPtlsauth"
28497 .scindex IIDtlsauth1 "&(tls)& authenticator"
28498 .scindex IIDtlsauth2 "authenticators" "&(tls)&"
28499 .cindex "authentication" "Client Certificate"
28500 .cindex "authentication" "X509"
28501 .cindex "Certificate-based authentication"
28502 The &(tls)& authenticator provides server support for
28503 authentication based on client certificates.
28504
28505 It is not an SMTP authentication mechanism and is not
28506 advertised by the server as part of the SMTP EHLO response.
28507 It is an Exim authenticator in the sense that it affects
28508 the protocol element of the log line, can be tested for
28509 by the &%authenticated%& ACL condition, and can set
28510 the &$authenticated_id$& variable.
28511
28512 The client must present a verifiable certificate,
28513 for which it must have been requested via the
28514 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& main options
28515 (see &<<CHAPTLS>>&).
28516
28517 If an authenticator of this type is configured it is
28518 run before any SMTP-level communication is done,
28519 and can authenticate the connection.
28520 If it does, SMTP authentication is not offered.
28521
28522 A maximum of one authenticator of this type may be present.
28523
28524
28525 .cindex "options" "&(tls)& authenticator (server)"
28526 The &(tls)& authenticator has three server options:
28527
28528 .option server_param1 tls string&!! unset
28529 .cindex "variables (&$auth1$& &$auth2$& etc)" "in &(tls)& authenticator"
28530 This option is expanded after the TLS negotiation and
28531 the result is placed in &$auth1$&.
28532 If the expansion is forced to fail, authentication fails. Any other expansion
28533 failure causes a temporary error code to be returned.
28534
28535 .option server_param2 tls string&!! unset
28536 .option server_param3 tls string&!! unset
28537 As above, for &$auth2$& and &$auth3$&.
28538
28539 &%server_param1%& may also be spelled &%server_param%&.
28540
28541
28542 Example:
28543 .code
28544 tls:
28545   driver = tls
28546   server_param1 =     ${certextract {subj_altname,mail,>:} \
28547                                     {$tls_in_peercert}}
28548   server_condition =  ${if and { {eq{$tls_in_certificate_verified}{1}} \
28549                                  {forany {$auth1} \
28550                             {!= {0} \
28551                                 {${lookup ldap{ldap:///\
28552                          mailname=${quote_ldap_dn:${lc:$item}},\
28553                          ou=users,LDAP_DC?mailid} {$value}{0} \
28554                        }    }  } }}}
28555   server_set_id =     ${if = {1}{${listcount:$auth1}} {$auth1}{}}
28556 .endd
28557 This accepts a client certificate that is verifiable against any
28558 of your configured trust-anchors
28559 (which usually means the full set of public CAs)
28560 and which has a SAN with a good account name.
28561
28562 Note that, up to TLS1.2, the client cert is on the wire in-clear, including the SAN,
28563 The account name is therefore guessable by an opponent.
28564 TLS 1.3 protects both server and client certificates, and is not vulnerable
28565 in this way.
28566 Likewise, a traditional plaintext SMTP AUTH done inside TLS is not.
28567
28568 . An alternative might use
28569 . .code
28570 .   server_param1 = ${sha256:$tls_in_peercert}
28571 . .endd
28572 . to require one of a set of specific certs that define a given account
28573 . (the verification is still required, but mostly irrelevant).
28574 . This would help for per-device use.
28575 .
28576 . However, for the future we really need support for checking a
28577 . user cert in LDAP - which probably wants a base-64 DER.
28578
28579 .ecindex IIDtlsauth1
28580 .ecindex IIDtlsauth2
28581
28582
28583 Note that because authentication is traditionally an SMTP operation,
28584 the &%authenticated%& ACL condition cannot be used in
28585 a connect- or helo-ACL.
28586
28587
28588
28589 . ////////////////////////////////////////////////////////////////////////////
28590 . ////////////////////////////////////////////////////////////////////////////
28591
28592 .chapter "Encrypted SMTP connections using TLS/SSL" "CHAPTLS" &&&
28593          "Encrypted SMTP connections"
28594 .scindex IIDencsmtp1 "encryption" "on SMTP connection"
28595 .scindex IIDencsmtp2 "SMTP" "encryption"
28596 .cindex "TLS" "on SMTP connection"
28597 .cindex "OpenSSL"
28598 .cindex "GnuTLS"
28599 Support for TLS (Transport Layer Security), formerly known as SSL (Secure
28600 Sockets Layer), is implemented by making use of the OpenSSL library or the
28601 GnuTLS library (Exim requires GnuTLS release 1.0 or later). There is no
28602 cryptographic code in the Exim distribution itself for implementing TLS. In
28603 order to use this feature you must install OpenSSL or GnuTLS, and then build a
28604 version of Exim that includes TLS support (see section &<<SECTinctlsssl>>&).
28605 You also need to understand the basic concepts of encryption at a managerial
28606 level, and in particular, the way that public keys, private keys, and
28607 certificates are used.
28608
28609 RFC 3207 defines how SMTP connections can make use of encryption. Once a
28610 connection is established, the client issues a STARTTLS command. If the
28611 server accepts this, the client and the server negotiate an encryption
28612 mechanism. If the negotiation succeeds, the data that subsequently passes
28613 between them is encrypted.
28614
28615 Exim's ACLs can detect whether the current SMTP session is encrypted or not,
28616 and if so, what cipher suite is in use, whether the client supplied a
28617 certificate, and whether or not that certificate was verified. This makes it
28618 possible for an Exim server to deny or accept certain commands based on the
28619 encryption state.
28620
28621 &*Warning*&: Certain types of firewall and certain anti-virus products can
28622 disrupt TLS connections. You need to turn off SMTP scanning for these products
28623 in order to get TLS to work.
28624
28625
28626
28627 .section "Support for the &""submissions""& (aka &""ssmtp""& and &""smtps""&) protocol" &&&
28628          "SECID284"
28629 .cindex "submissions protocol"
28630 .cindex "ssmtp protocol"
28631 .cindex "smtps protocol"
28632 .cindex "SMTP" "submissions protocol"
28633 .cindex "SMTP" "ssmtp protocol"
28634 .cindex "SMTP" "smtps protocol"
28635 The history of port numbers for TLS in SMTP is a little messy and has been
28636 contentious.  As of RFC 8314, the common practice of using the historically
28637 allocated port 465 for "email submission but with TLS immediately upon connect
28638 instead of using STARTTLS" is officially blessed by the IETF, and recommended
28639 by them in preference to STARTTLS.
28640
28641 The name originally assigned to the port was &"ssmtp"& or &"smtps"&, but as
28642 clarity emerged over the dual roles of SMTP, for MX delivery and Email
28643 Submission, nomenclature has shifted.  The modern name is now &"submissions"&.
28644
28645 This approach was, for a while, officially abandoned when encrypted SMTP was
28646 standardized, but many clients kept using it, even as the TCP port number was
28647 reassigned for other use.
28648 Thus you may encounter guidance claiming that you shouldn't enable use of
28649 this port.
28650 In practice, a number of mail-clients have only ever supported submissions,
28651 not submission with STARTTLS upgrade.
28652 Ideally, offer both submission (587) and submissions (465) service.
28653
28654 Exim supports TLS-on-connect by means of the &%tls_on_connect_ports%&
28655 global option. Its value must be a list of port numbers;
28656 the most common use is expected to be:
28657 .code
28658 tls_on_connect_ports = 465
28659 .endd
28660 The port numbers specified by this option apply to all SMTP connections, both
28661 via the daemon and via &'inetd'&. You still need to specify all the ports that
28662 the daemon uses (by setting &%daemon_smtp_ports%& or &%local_interfaces%& or
28663 the &%-oX%& command line option) because &%tls_on_connect_ports%& does not add
28664 an extra port &-- rather, it specifies different behaviour on a port that is
28665 defined elsewhere.
28666
28667 There is also a &%-tls-on-connect%& command line option. This overrides
28668 &%tls_on_connect_ports%&; it forces the TLS-only behaviour for all ports.
28669
28670
28671
28672
28673
28674
28675 .section "OpenSSL vs GnuTLS" "SECTopenvsgnu"
28676 .cindex "TLS" "OpenSSL &'vs'& GnuTLS"
28677 TLS is supported in Exim using either the OpenSSL or GnuTLS library.
28678 To build Exim to use OpenSSL you need to set
28679 .code
28680 USE_OPENSSL=yes
28681 .endd
28682 in Local/Makefile.
28683
28684 To build Exim to use GnuTLS, you need to set
28685 .code
28686 USE_GNUTLS=yes
28687 .endd
28688 in Local/Makefile.
28689
28690 You must also set TLS_LIBS and TLS_INCLUDE appropriately, so that the
28691 include files and libraries for GnuTLS can be found.
28692
28693 There are some differences in usage when using GnuTLS instead of OpenSSL:
28694
28695 .ilist
28696 The &%tls_verify_certificates%& option
28697 cannot be the path of a directory
28698 for GnuTLS versions before 3.3.6
28699 (for later versions, or OpenSSL, it can be either).
28700 .next
28701 The default value for &%tls_dhparam%& differs for historical reasons.
28702 .next
28703 .vindex "&$tls_in_peerdn$&"
28704 .vindex "&$tls_out_peerdn$&"
28705 Distinguished Name (DN) strings reported by the OpenSSL library use a slash for
28706 separating fields; GnuTLS uses commas, in accordance with RFC 2253. This
28707 affects the value of the &$tls_in_peerdn$& and &$tls_out_peerdn$& variables.
28708 .next
28709 OpenSSL identifies cipher suites using hyphens as separators, for example:
28710 DES-CBC3-SHA. GnuTLS historically used underscores, for example:
28711 RSA_ARCFOUR_SHA. What is more, OpenSSL complains if underscores are present
28712 in a cipher list. To make life simpler, Exim changes underscores to hyphens
28713 for OpenSSL and passes the string unchanged to GnuTLS (expecting the library
28714 to handle its own older variants) when processing lists of cipher suites in the
28715 &%tls_require_ciphers%& options (the global option and the &(smtp)& transport
28716 option).
28717 .next
28718 The &%tls_require_ciphers%& options operate differently, as described in the
28719 sections &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
28720 .next
28721 The &%tls_dh_min_bits%& SMTP transport option is only honoured by GnuTLS.
28722 When using OpenSSL, this option is ignored.
28723 (If an API is found to let OpenSSL be configured in this way,
28724 let the Exim Maintainers know and we'll likely use it).
28725 .next
28726 With GnuTLS, if an explicit list is used for the &%tls_privatekey%& main option
28727 main option, it must be ordered to match the &%tls_certificate%& list.
28728 .next
28729 Some other recently added features may only be available in one or the other.
28730 This should be documented with the feature.  If the documentation does not
28731 explicitly state that the feature is infeasible in the other TLS
28732 implementation, then patches are welcome.
28733 .endlist
28734
28735
28736 .section "GnuTLS parameter computation" "SECTgnutlsparam"
28737 This section only applies if &%tls_dhparam%& is set to &`historic`& or to
28738 an explicit path; if the latter, then the text about generation still applies,
28739 but not the chosen filename.
28740 By default, as of Exim 4.80 a hard-coded D-H prime is used.
28741 See the documentation of &%tls_dhparam%& for more information.
28742
28743 GnuTLS uses D-H parameters that may take a substantial amount of time
28744 to compute. It is unreasonable to re-compute them for every TLS session.
28745 Therefore, Exim keeps this data in a file in its spool directory, called
28746 &_gnutls-params-NNNN_& for some value of NNNN, corresponding to the number
28747 of bits requested.
28748 The file is owned by the Exim user and is readable only by
28749 its owner. Every Exim process that start up GnuTLS reads the D-H
28750 parameters from this file. If the file does not exist, the first Exim process
28751 that needs it computes the data and writes it to a temporary file which is
28752 renamed once it is complete. It does not matter if several Exim processes do
28753 this simultaneously (apart from wasting a few resources). Once a file is in
28754 place, new Exim processes immediately start using it.
28755
28756 For maximum security, the parameters that are stored in this file should be
28757 recalculated periodically, the frequency depending on your paranoia level.
28758 If you are avoiding using the fixed D-H primes published in RFCs, then you
28759 are concerned about some advanced attacks and will wish to do this; if you do
28760 not regenerate then you might as well stick to the standard primes.
28761
28762 Arranging this is easy in principle; just delete the file when you want new
28763 values to be computed. However, there may be a problem. The calculation of new
28764 parameters needs random numbers, and these are obtained from &_/dev/random_&.
28765 If the system is not very active, &_/dev/random_& may delay returning data
28766 until enough randomness (entropy) is available. This may cause Exim to hang for
28767 a substantial amount of time, causing timeouts on incoming connections.
28768
28769 The solution is to generate the parameters externally to Exim. They are stored
28770 in &_gnutls-params-N_& in PEM format, which means that they can be
28771 generated externally using the &(certtool)& command that is part of GnuTLS.
28772
28773 To replace the parameters with new ones, instead of deleting the file
28774 and letting Exim re-create it, you can generate new parameters using
28775 &(certtool)& and, when this has been done, replace Exim's cache file by
28776 renaming. The relevant commands are something like this:
28777 .code
28778 # ls
28779 [ look for file; assume gnutls-params-2236 is the most recent ]
28780 # rm -f new-params
28781 # touch new-params
28782 # chown exim:exim new-params
28783 # chmod 0600 new-params
28784 # certtool --generate-dh-params --bits 2236 >>new-params
28785 # openssl dhparam -noout -text -in new-params | head
28786 [ check the first line, make sure it's not more than 2236;
28787   if it is, then go back to the start ("rm") and repeat
28788   until the size generated is at most the size requested ]
28789 # chmod 0400 new-params
28790 # mv new-params gnutls-params-2236
28791 .endd
28792 If Exim never has to generate the parameters itself, the possibility of
28793 stalling is removed.
28794
28795 The filename changed in Exim 4.80, to gain the -bits suffix.  The value which
28796 Exim will choose depends upon the version of GnuTLS in use.  For older GnuTLS,
28797 the value remains hard-coded in Exim as 1024.  As of GnuTLS 2.12.x, there is
28798 a way for Exim to ask for the "normal" number of bits for D-H public-key usage,
28799 and Exim does so.  This attempt to remove Exim from TLS policy decisions
28800 failed, as GnuTLS 2.12 returns a value higher than the current hard-coded limit
28801 of the NSS library.  Thus Exim gains the &%tls_dh_max_bits%& global option,
28802 which applies to all D-H usage, client or server.  If the value returned by
28803 GnuTLS is greater than &%tls_dh_max_bits%& then the value will be clamped down
28804 to &%tls_dh_max_bits%&.  The default value has been set at the current NSS
28805 limit, which is still much higher than Exim historically used.
28806
28807 The filename and bits used will change as the GnuTLS maintainers change the
28808 value for their parameter &`GNUTLS_SEC_PARAM_NORMAL`&, as clamped by
28809 &%tls_dh_max_bits%&.  At the time of writing (mid 2012), GnuTLS 2.12 recommends
28810 2432 bits, while NSS is limited to 2236 bits.
28811
28812 In fact, the requested value will be *lower* than &%tls_dh_max_bits%&, to
28813 increase the chance of the generated prime actually being within acceptable
28814 bounds, as GnuTLS has been observed to overshoot.  Note the check step in the
28815 procedure above.  There is no sane procedure available to Exim to double-check
28816 the size of the generated prime, so it might still be too large.
28817
28818
28819 .section "Requiring specific ciphers in OpenSSL" "SECTreqciphssl"
28820 .cindex "TLS" "requiring specific ciphers (OpenSSL)"
28821 .oindex "&%tls_require_ciphers%&" "OpenSSL"
28822 There is a function in the OpenSSL library that can be passed a list of cipher
28823 suites before the cipher negotiation takes place. This specifies which ciphers
28824 are acceptable for TLS versions prior to 1.3.
28825 The list is colon separated and may contain names like
28826 DES-CBC3-SHA. Exim passes the expanded value of &%tls_require_ciphers%&
28827 directly to this function call.
28828 Many systems will install the OpenSSL manual-pages, so you may have
28829 &'ciphers(1)'& available to you.
28830 The following quotation from the OpenSSL
28831 documentation specifies what forms of item are allowed in the cipher string:
28832
28833 .ilist
28834 It can consist of a single cipher suite such as RC4-SHA.
28835 .next
28836 It can represent a list of cipher suites containing a certain algorithm,
28837 or cipher suites of a certain type. For example SHA1 represents all
28838 ciphers suites using the digest algorithm SHA1 and SSLv3 represents all
28839 SSL v3 algorithms.
28840 .next
28841 Lists of cipher suites can be combined in a single cipher string using
28842 the + character. This is used as a logical and operation. For example
28843 SHA1+DES represents all cipher suites containing the SHA1 and the DES
28844 algorithms.
28845 .endlist
28846
28847 Each cipher string can be optionally preceded by one of the characters &`!`&,
28848 &`-`& or &`+`&.
28849 .ilist
28850 If &`!`& is used, the ciphers are permanently deleted from the list. The
28851 ciphers deleted can never reappear in the list even if they are explicitly
28852 stated.
28853 .next
28854 If &`-`& is used, the ciphers are deleted from the list, but some or all
28855 of the ciphers can be added again by later options.
28856 .next
28857 If &`+`& is used, the ciphers are moved to the end of the list. This
28858 option does not add any new ciphers; it just moves matching existing ones.
28859 .endlist
28860
28861 If none of these characters is present, the string is interpreted as
28862 a list of ciphers to be appended to the current preference list. If the list
28863 includes any ciphers already present they will be ignored: that is, they will
28864 not be moved to the end of the list.
28865 .endlist
28866
28867 The OpenSSL &'ciphers(1)'& command may be used to test the results of a given
28868 string:
28869 .code
28870 # note single-quotes to get ! past any shell history expansion
28871 $ openssl ciphers 'HIGH:!MD5:!SHA1'
28872 .endd
28873
28874 This example will let the library defaults be permitted on the MX port, where
28875 there's probably no identity verification anyway, but ups the ante on the
28876 submission ports where the administrator might have some influence on the
28877 choice of clients used:
28878 .code
28879 # OpenSSL variant; see man ciphers(1)
28880 tls_require_ciphers = ${if =={$received_port}{25}\
28881                            {DEFAULT}\
28882                            {HIGH:!MD5:!SHA1}}
28883 .endd
28884
28885 This example will prefer ECDSA-authenticated ciphers over RSA ones:
28886 .code
28887 tls_require_ciphers = ECDSA:RSA:!COMPLEMENTOFDEFAULT
28888 .endd
28889
28890 For TLS version 1.3 the control available is less fine-grained
28891 and Exim does not provide access to it at present.
28892 The value of the &%tls_require_ciphers%& option is ignored when
28893 TLS version 1.3 is negotiated.
28894
28895 As of writing the library default cipher suite list for TLSv1.3 is
28896 .code
28897 TLS_AES_256_GCM_SHA384:TLS_CHACHA20_POLY1305_SHA256:TLS_AES_128_GCM_SHA256
28898 .endd
28899
28900
28901 .section "Requiring specific ciphers or other parameters in GnuTLS" &&&
28902          "SECTreqciphgnu"
28903 .cindex "GnuTLS" "specifying parameters for"
28904 .cindex "TLS" "specifying ciphers (GnuTLS)"
28905 .cindex "TLS" "specifying key exchange methods (GnuTLS)"
28906 .cindex "TLS" "specifying MAC algorithms (GnuTLS)"
28907 .cindex "TLS" "specifying protocols (GnuTLS)"
28908 .cindex "TLS" "specifying priority string (GnuTLS)"
28909 .oindex "&%tls_require_ciphers%&" "GnuTLS"
28910 The GnuTLS library allows the caller to provide a "priority string", documented
28911 as part of the &[gnutls_priority_init]& function.  This is very similar to the
28912 ciphersuite specification in OpenSSL.
28913
28914 The &%tls_require_ciphers%& option is treated as the GnuTLS priority string
28915 and controls both protocols and ciphers.
28916
28917 The &%tls_require_ciphers%& option is available both as an global option,
28918 controlling how Exim behaves as a server, and also as an option of the
28919 &(smtp)& transport, controlling how Exim behaves as a client.  In both cases
28920 the value is string expanded.  The resulting string is not an Exim list and
28921 the string is given to the GnuTLS library, so that Exim does not need to be
28922 aware of future feature enhancements of GnuTLS.
28923
28924 Documentation of the strings accepted may be found in the GnuTLS manual, under
28925 "Priority strings".  This is online as
28926 &url(https://www.gnutls.org/manual/html_node/Priority-Strings.html),
28927 but beware that this relates to GnuTLS 3, which may be newer than the version
28928 installed on your system.  If you are using GnuTLS 3,
28929 then the example code
28930 &url(https://www.gnutls.org/manual/gnutls.html#Listing-the-ciphersuites-in-a-priority-string)
28931 on that site can be used to test a given string.
28932
28933 For example:
28934 .code
28935 # Disable older versions of protocols
28936 tls_require_ciphers = NORMAL:%LATEST_RECORD_VERSION:-VERS-SSL3.0
28937 .endd
28938
28939 Prior to Exim 4.80, an older API of GnuTLS was used, and Exim supported three
28940 additional options, "&%gnutls_require_kx%&", "&%gnutls_require_mac%&" and
28941 "&%gnutls_require_protocols%&".  &%tls_require_ciphers%& was an Exim list.
28942
28943 This example will let the library defaults be permitted on the MX port, where
28944 there's probably no identity verification anyway, and lowers security further
28945 by increasing compatibility; but this ups the ante on the submission ports
28946 where the administrator might have some influence on the choice of clients
28947 used:
28948 .code
28949 # GnuTLS variant
28950 tls_require_ciphers = ${if =={$received_port}{25}\
28951                            {NORMAL:%COMPAT}\
28952                            {SECURE128}}
28953 .endd
28954
28955
28956 .section "Configuring an Exim server to use TLS" "SECID182"
28957 .cindex "TLS" "configuring an Exim server"
28958 .cindex "ESMTP extensions" STARTTLS
28959 When Exim has been built with TLS support, it advertises the availability of
28960 the STARTTLS command to client hosts that match &%tls_advertise_hosts%&,
28961 but not to any others. The default value of this option is *, which means
28962 that STARTTLS is always advertised.  Set it to blank to never advertise;
28963 this is reasonable for systems that want to use TLS only as a client.
28964
28965 If STARTTLS is to be used you
28966 need to set some other options in order to make TLS available.
28967
28968 If a client issues a STARTTLS command and there is some configuration
28969 problem in the server, the command is rejected with a 454 error. If the client
28970 persists in trying to issue SMTP commands, all except QUIT are rejected
28971 with the error
28972 .code
28973 554 Security failure
28974 .endd
28975 If a STARTTLS command is issued within an existing TLS session, it is
28976 rejected with a 554 error code.
28977
28978 To enable TLS operations on a server, the &%tls_advertise_hosts%& option
28979 must be set to match some hosts. The default is * which matches all hosts.
28980
28981 If this is all you do, TLS encryption will be enabled but not authentication -
28982 meaning that the peer has no assurance it is actually you he is talking to.
28983 You gain protection from a passive sniffer listening on the wire but not
28984 from someone able to intercept the communication.
28985
28986 Further protection requires some further configuration at the server end.
28987
28988 To make TLS work you need to set, in the server,
28989 .code
28990 tls_certificate = /some/file/name
28991 tls_privatekey = /some/file/name
28992 .endd
28993 These options are, in fact, expanded strings, so you can make them depend on
28994 the identity of the client that is connected if you wish. The first file
28995 contains the server's X509 certificate, and the second contains the private key
28996 that goes with it. These files need to be
28997 PEM format and readable by the Exim user, and must
28998 always be given as full path names.
28999 The key must not be password-protected.
29000 They can be the same file if both the
29001 certificate and the key are contained within it. If &%tls_privatekey%& is not
29002 set, or if its expansion is forced to fail or results in an empty string, this
29003 is assumed to be the case. The certificate file may also contain intermediate
29004 certificates that need to be sent to the client to enable it to authenticate
29005 the server's certificate.
29006
29007 For dual-stack (eg. RSA and ECDSA) configurations, these options can be
29008 colon-separated lists of file paths.  Ciphers using given authentication
29009 algorithms require the presence of a suitable certificate to supply the
29010 public-key.  The server selects among the certificates to present to the
29011 client depending on the selected cipher, hence the priority ordering for
29012 ciphers will affect which certificate is used.
29013
29014 If you do not understand about certificates and keys, please try to find a
29015 source of this background information, which is not Exim-specific. (There are a
29016 few comments below in section &<<SECTcerandall>>&.)
29017
29018 &*Note*&: These options do not apply when Exim is operating as a client &--
29019 they apply only in the case of a server. If you need to use a certificate in an
29020 Exim client, you must set the options of the same names in an &(smtp)&
29021 transport.
29022
29023 With just these options, an Exim server will be able to use TLS. It does not
29024 require the client to have a certificate (but see below for how to insist on
29025 this). There is one other option that may be needed in other situations. If
29026 .code
29027 tls_dhparam = /some/file/name
29028 .endd
29029 is set, the SSL library is initialized for the use of Diffie-Hellman ciphers
29030 with the parameters contained in the file.
29031 Set this to &`none`& to disable use of DH entirely, by making no prime
29032 available:
29033 .code
29034 tls_dhparam = none
29035 .endd
29036 This may also be set to a string identifying a standard prime to be used for
29037 DH; if it is set to &`default`& or, for OpenSSL, is unset, then the prime
29038 used is &`ike23`&.  There are a few standard primes available, see the
29039 documentation for &%tls_dhparam%& for the complete list.
29040
29041 See the command
29042 .code
29043 openssl dhparam
29044 .endd
29045 for a way of generating file data.
29046
29047 The strings supplied for these three options are expanded every time a client
29048 host connects. It is therefore possible to use different certificates and keys
29049 for different hosts, if you so wish, by making use of the client's IP address
29050 in &$sender_host_address$& to control the expansion. If a string expansion is
29051 forced to fail, Exim behaves as if the option is not set.
29052
29053 .cindex "cipher" "logging"
29054 .cindex "log" "TLS cipher"
29055 .vindex "&$tls_in_cipher$&"
29056 The variable &$tls_in_cipher$& is set to the cipher suite that was negotiated for
29057 an incoming TLS connection. It is included in the &'Received:'& header of an
29058 incoming message (by default &-- you can, of course, change this), and it is
29059 also included in the log line that records a message's arrival, keyed by
29060 &"X="&, unless the &%tls_cipher%& log selector is turned off. The &%encrypted%&
29061 condition can be used to test for specific cipher suites in ACLs.
29062
29063 Once TLS has been established, the ACLs that run for subsequent SMTP commands
29064 can check the name of the cipher suite and vary their actions accordingly. The
29065 cipher suite names vary, depending on which TLS library is being used. For
29066 example, OpenSSL uses the name DES-CBC3-SHA for the cipher suite which in other
29067 contexts is known as TLS_RSA_WITH_3DES_EDE_CBC_SHA. Check the OpenSSL or GnuTLS
29068 documentation for more details.
29069
29070 For outgoing SMTP deliveries, &$tls_out_cipher$& is used and logged
29071 (again depending on the &%tls_cipher%& log selector).
29072
29073
29074 .section "Requesting and verifying client certificates" "SECID183"
29075 .cindex "certificate" "verification of client"
29076 .cindex "TLS" "client certificate verification"
29077 If you want an Exim server to request a certificate when negotiating a TLS
29078 session with a client, you must set either &%tls_verify_hosts%& or
29079 &%tls_try_verify_hosts%&. You can, of course, set either of them to * to
29080 apply to all TLS connections. For any host that matches one of these options,
29081 Exim requests a certificate as part of the setup of the TLS session. The
29082 contents of the certificate are verified by comparing it with a list of
29083 expected trust-anchors or certificates.
29084 These may be the system default set (depending on library version),
29085 an explicit file or,
29086 depending on library version, a directory, identified by
29087 &%tls_verify_certificates%&.
29088
29089 A file can contain multiple certificates, concatenated end to end. If a
29090 directory is used
29091 (OpenSSL only),
29092 each certificate must be in a separate file, with a name (or a symbolic link)
29093 of the form <&'hash'&>.0, where <&'hash'&> is a hash value constructed from the
29094 certificate. You can compute the relevant hash by running the command
29095 .code
29096 openssl x509 -hash -noout -in /cert/file
29097 .endd
29098 where &_/cert/file_& contains a single certificate.
29099
29100 There is no checking of names of the client against the certificate
29101 Subject Name or Subject Alternate Names.
29102
29103 The difference between &%tls_verify_hosts%& and &%tls_try_verify_hosts%& is
29104 what happens if the client does not supply a certificate, or if the certificate
29105 does not match any of the certificates in the collection named by
29106 &%tls_verify_certificates%&. If the client matches &%tls_verify_hosts%&, the
29107 attempt to set up a TLS session is aborted, and the incoming connection is
29108 dropped. If the client matches &%tls_try_verify_hosts%&, the (encrypted) SMTP
29109 session continues. ACLs that run for subsequent SMTP commands can detect the
29110 fact that no certificate was verified, and vary their actions accordingly. For
29111 example, you can insist on a certificate before accepting a message for
29112 relaying, but not when the message is destined for local delivery.
29113
29114 .vindex "&$tls_in_peerdn$&"
29115 When a client supplies a certificate (whether it verifies or not), the value of
29116 the Distinguished Name of the certificate is made available in the variable
29117 &$tls_in_peerdn$& during subsequent processing of the message.
29118
29119 .cindex "log" "distinguished name"
29120 Because it is often a long text string, it is not included in the log line or
29121 &'Received:'& header by default. You can arrange for it to be logged, keyed by
29122 &"DN="&, by setting the &%tls_peerdn%& log selector, and you can use
29123 &%received_header_text%& to change the &'Received:'& header. When no
29124 certificate is supplied, &$tls_in_peerdn$& is empty.
29125
29126
29127 .section "Revoked certificates" "SECID184"
29128 .cindex "TLS" "revoked certificates"
29129 .cindex "revocation list"
29130 .cindex "certificate" "revocation list"
29131 .cindex "OCSP" "stapling"
29132 Certificate issuing authorities issue Certificate Revocation Lists (CRLs) when
29133 certificates are revoked. If you have such a list, you can pass it to an Exim
29134 server using the global option called &%tls_crl%& and to an Exim client using
29135 an identically named option for the &(smtp)& transport. In each case, the value
29136 of the option is expanded and must then be the name of a file that contains a
29137 CRL in PEM format.
29138 The downside is that clients have to periodically re-download a potentially huge
29139 file from every certificate authority they know of.
29140
29141 The way with most moving parts at query time is Online Certificate
29142 Status Protocol (OCSP), where the client verifies the certificate
29143 against an OCSP server run by the CA.  This lets the CA track all
29144 usage of the certs.  It requires running software with access to the
29145 private key of the CA, to sign the responses to the OCSP queries.  OCSP
29146 is based on HTTP and can be proxied accordingly.
29147
29148 The only widespread OCSP server implementation (known to this writer)
29149 comes as part of OpenSSL and aborts on an invalid request, such as
29150 connecting to the port and then disconnecting.  This requires
29151 re-entering the passphrase each time some random client does this.
29152
29153 The third way is OCSP Stapling; in this, the server using a certificate
29154 issued by the CA periodically requests an OCSP proof of validity from
29155 the OCSP server, then serves it up inline as part of the TLS
29156 negotiation.   This approach adds no extra round trips, does not let the
29157 CA track users, scales well with number of certs issued by the CA and is
29158 resilient to temporary OCSP server failures, as long as the server
29159 starts retrying to fetch an OCSP proof some time before its current
29160 proof expires.  The downside is that it requires server support.
29161
29162 Unless Exim is built with the support disabled,
29163 or with GnuTLS earlier than version 3.3.16 / 3.4.8
29164 support for OCSP stapling is included.
29165
29166 There is a global option called &%tls_ocsp_file%&.
29167 The file specified therein is expected to be in DER format, and contain
29168 an OCSP proof.  Exim will serve it as part of the TLS handshake.  This
29169 option will be re-expanded for SNI, if the &%tls_certificate%& option
29170 contains &`tls_in_sni`&, as per other TLS options.
29171
29172 Exim does not at this time implement any support for fetching a new OCSP
29173 proof.  The burden is on the administrator to handle this, outside of
29174 Exim.  The file specified should be replaced atomically, so that the
29175 contents are always valid.  Exim will expand the &%tls_ocsp_file%& option
29176 on each connection, so a new file will be handled transparently on the
29177 next connection.
29178
29179 When built with OpenSSL Exim will check for a valid next update timestamp
29180 in the OCSP proof; if not present, or if the proof has expired, it will be
29181 ignored.
29182
29183 For the client to be able to verify the stapled OCSP the server must
29184 also supply, in its stapled information, any intermediate
29185 certificates for the chain leading to the OCSP proof from the signer
29186 of the server certificate.  There may be zero or one such. These
29187 intermediate certificates should be added to the server OCSP stapling
29188 file named by &%tls_ocsp_file%&.
29189
29190 Note that the proof only covers the terminal server certificate,
29191 not any of the chain from CA to it.
29192
29193 There is no current way to staple a proof for a client certificate.
29194
29195 .code
29196   A helper script "ocsp_fetch.pl" for fetching a proof from a CA
29197   OCSP server is supplied.  The server URL may be included in the
29198   server certificate, if the CA is helpful.
29199
29200   One failure mode seen was the OCSP Signer cert expiring before the end
29201   of validity of the OCSP proof. The checking done by Exim/OpenSSL
29202   noted this as invalid overall, but the re-fetch script did not.
29203 .endd
29204
29205
29206
29207
29208 .section "Configuring an Exim client to use TLS" "SECTclientTLS"
29209 .cindex "cipher" "logging"
29210 .cindex "log" "TLS cipher"
29211 .cindex "log" "distinguished name"
29212 .cindex "TLS" "configuring an Exim client"
29213 The &%tls_cipher%& and &%tls_peerdn%& log selectors apply to outgoing SMTP
29214 deliveries as well as to incoming, the latter one causing logging of the
29215 server certificate's DN. The remaining client configuration for TLS is all
29216 within the &(smtp)& transport.
29217
29218 .cindex "ESMTP extensions" STARTTLS
29219 It is not necessary to set any options to have TLS work in the &(smtp)&
29220 transport. If Exim is built with TLS support, and TLS is advertised by a
29221 server, the &(smtp)& transport always tries to start a TLS session. However,
29222 this can be prevented by setting &%hosts_avoid_tls%& (an option of the
29223 transport) to a list of server hosts for which TLS should not be used.
29224
29225 If you do not want Exim to attempt to send messages unencrypted when an attempt
29226 to set up an encrypted connection fails in any way, you can set
29227 &%hosts_require_tls%& to a list of hosts for which encryption is mandatory. For
29228 those hosts, delivery is always deferred if an encrypted connection cannot be
29229 set up. If there are any other hosts for the address, they are tried in the
29230 usual way.
29231
29232 When the server host is not in &%hosts_require_tls%&, Exim may try to deliver
29233 the message unencrypted. It always does this if the response to STARTTLS is
29234 a 5&'xx'& code. For a temporary error code, or for a failure to negotiate a TLS
29235 session after a success response code, what happens is controlled by the
29236 &%tls_tempfail_tryclear%& option of the &(smtp)& transport. If it is false,
29237 delivery to this host is deferred, and other hosts (if available) are tried. If
29238 it is true, Exim attempts to deliver unencrypted after a 4&'xx'& response to
29239 STARTTLS, and if STARTTLS is accepted, but the subsequent TLS
29240 negotiation fails, Exim closes the current connection (because it is in an
29241 unknown state), opens a new one to the same host, and then tries the delivery
29242 unencrypted.
29243
29244 The &%tls_certificate%& and &%tls_privatekey%& options of the &(smtp)&
29245 transport provide the client with a certificate, which is passed to the server
29246 if it requests it. If the server is Exim, it will request a certificate only if
29247 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& matches the client.
29248
29249 &*Note*&: Do not use a certificate which has the OCSP-must-staple extension,
29250 for client use (they are usable for server use).
29251 As the TLS protocol has no means for the client to staple before TLS 1.3 it will result
29252 in failed connections.
29253
29254 If the &%tls_verify_certificates%& option is set on the &(smtp)& transport, it
29255 specifies a collection of expected server certificates.
29256 These may be
29257 the system default set (depending on library version),
29258 a file,
29259 or (depending on library version) a directory.
29260 The client verifies the server's certificate
29261 against this collection, taking into account any revoked certificates that are
29262 in the list defined by &%tls_crl%&.
29263 Failure to verify fails the TLS connection unless either of the
29264 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& options are set.
29265
29266 The &%tls_verify_hosts%& and &%tls_try_verify_hosts%& options restrict
29267 certificate verification to the listed servers.  Verification either must
29268 or need not succeed respectively.
29269
29270 The &%tls_verify_cert_hostnames%& option lists hosts for which additional
29271 name checks are made on the server certificate.
29272 .new
29273 The match against this list is, as per other Exim usage, the
29274 IP for the host.  That is most closely associated with the
29275 name on the DNS A (or AAAA) record for the host.
29276 However, the name that needs to be in the certificate
29277 is the one at the head of any CNAME chain leading to the A record.
29278 .wen
29279 The option defaults to always checking.
29280
29281 The &(smtp)& transport has two OCSP-related options:
29282 &%hosts_require_ocsp%&; a host-list for which a Certificate Status
29283 is requested and required for the connection to proceed.  The default
29284 value is empty.
29285 &%hosts_request_ocsp%&; a host-list for which (additionally)
29286 a Certificate Status is requested (but not necessarily verified).  The default
29287 value is "*" meaning that requests are made unless configured
29288 otherwise.
29289
29290 The host(s) should also be in &%hosts_require_tls%&, and
29291 &%tls_verify_certificates%& configured for the transport,
29292 for OCSP to be relevant.
29293
29294 If
29295 &%tls_require_ciphers%& is set on the &(smtp)& transport, it must contain a
29296 list of permitted cipher suites. If either of these checks fails, delivery to
29297 the current host is abandoned, and the &(smtp)& transport tries to deliver to
29298 alternative hosts, if any.
29299
29300  &*Note*&:
29301 These options must be set in the &(smtp)& transport for Exim to use TLS when it
29302 is operating as a client. Exim does not assume that a server certificate (set
29303 by the global options of the same name) should also be used when operating as a
29304 client.
29305
29306 .vindex "&$host$&"
29307 .vindex "&$host_address$&"
29308 All the TLS options in the &(smtp)& transport are expanded before use, with
29309 &$host$& and &$host_address$& containing the name and address of the server to
29310 which the client is connected. Forced failure of an expansion causes Exim to
29311 behave as if the relevant option were unset.
29312
29313 .vindex &$tls_out_bits$&
29314 .vindex &$tls_out_cipher$&
29315 .vindex &$tls_out_peerdn$&
29316 .vindex &$tls_out_sni$&
29317 Before an SMTP connection is established, the
29318 &$tls_out_bits$&, &$tls_out_cipher$&, &$tls_out_peerdn$& and &$tls_out_sni$&
29319 variables are emptied. (Until the first connection, they contain the values
29320 that were set when the message was received.) If STARTTLS is subsequently
29321 successfully obeyed, these variables are set to the relevant values for the
29322 outgoing connection.
29323
29324
29325
29326 .section "Use of TLS Server Name Indication" "SECTtlssni"
29327 .cindex "TLS" "Server Name Indication"
29328 .cindex "TLS" SNI
29329 .cindex SNI
29330 .vindex "&$tls_in_sni$&"
29331 .oindex "&%tls_in_sni%&"
29332 With TLS1.0 or above, there is an extension mechanism by which extra
29333 information can be included at various points in the protocol.  One of these
29334 extensions, documented in RFC 6066 (and before that RFC 4366) is
29335 &"Server Name Indication"&, commonly &"SNI"&.  This extension is sent by the
29336 client in the initial handshake, so that the server can examine the servername
29337 within and possibly choose to use different certificates and keys (and more)
29338 for this session.
29339
29340 This is analogous to HTTP's &"Host:"& header, and is the main mechanism by
29341 which HTTPS-enabled web-sites can be virtual-hosted, many sites to one IP
29342 address.
29343
29344 With SMTP to MX, there are the same problems here as in choosing the identity
29345 against which to validate a certificate: you can't rely on insecure DNS to
29346 provide the identity which you then cryptographically verify.  So this will
29347 be of limited use in that environment.
29348
29349 With SMTP to Submission, there is a well-defined hostname which clients are
29350 connecting to and can validate certificates against.  Thus clients &*can*&
29351 choose to include this information in the TLS negotiation.  If this becomes
29352 wide-spread, then hosters can choose to present different certificates to
29353 different clients.  Or even negotiate different cipher suites.
29354
29355 The &%tls_sni%& option on an SMTP transport is an expanded string; the result,
29356 if not empty, will be sent on a TLS session as part of the handshake.  There's
29357 nothing more to it.  Choosing a sensible value not derived insecurely is the
29358 only point of caution.  The &$tls_out_sni$& variable will be set to this string
29359 for the lifetime of the client connection (including during authentication).
29360
29361 Except during SMTP client sessions, if &$tls_in_sni$& is set then it is a string
29362 received from a client.
29363 It can be logged with the &%log_selector%& item &`+tls_sni`&.
29364
29365 If the string &`tls_in_sni`& appears in the main section's &%tls_certificate%&
29366 option (prior to expansion) then the following options will be re-expanded
29367 during TLS session handshake, to permit alternative values to be chosen:
29368
29369 .ilist
29370 &%tls_certificate%&
29371 .next
29372 &%tls_crl%&
29373 .next
29374 &%tls_privatekey%&
29375 .next
29376 &%tls_verify_certificates%&
29377 .next
29378 &%tls_ocsp_file%&
29379 .endlist
29380
29381 Great care should be taken to deal with matters of case, various injection
29382 attacks in the string (&`../`& or SQL), and ensuring that a valid filename
29383 can always be referenced; it is important to remember that &$tls_in_sni$& is
29384 arbitrary unverified data provided prior to authentication.
29385 Further, the initial certificate is loaded before SNI has arrived, so
29386 an expansion for &%tls_certificate%& must have a default which is used
29387 when &$tls_in_sni$& is empty.
29388
29389 The Exim developers are proceeding cautiously and so far no other TLS options
29390 are re-expanded.
29391
29392 When Exim is built against OpenSSL, OpenSSL must have been built with support
29393 for TLS Extensions.  This holds true for OpenSSL 1.0.0+ and 0.9.8+ with
29394 enable-tlsext in EXTRACONFIGURE.  If you invoke &(openssl s_client -h)& and
29395 see &`-servername`& in the output, then OpenSSL has support.
29396
29397 When Exim is built against GnuTLS, SNI support is available as of GnuTLS
29398 0.5.10.  (Its presence predates the current API which Exim uses, so if Exim
29399 built, then you have SNI support).
29400
29401
29402
29403 .section "Multiple messages on the same encrypted TCP/IP connection" &&&
29404          "SECTmulmessam"
29405 .cindex "multiple SMTP deliveries with TLS"
29406 .cindex "TLS" "multiple message deliveries"
29407 Exim sends multiple messages down the same TCP/IP connection by starting up
29408 an entirely new delivery process for each message, passing the socket from
29409 one process to the next. This implementation does not fit well with the use
29410 of TLS, because there is quite a lot of state information associated with a TLS
29411 connection, not just a socket identification. Passing all the state information
29412 to a new process is not feasible. Consequently, for sending using TLS Exim
29413 starts an additional proxy process for handling the encryption, piping the
29414 unencrypted data stream from and to the delivery processes.
29415
29416 An older mode of operation can be enabled on a per-host basis by the
29417 &%hosts_noproxy_tls%& option on the &(smtp)& transport.  If the host matches
29418 this list the proxy process described above is not used; instead Exim
29419 shuts down an existing TLS session being run by the delivery process
29420 before passing the socket to a new process. The new process may then
29421 try to start a new TLS session, and if successful, may try to re-authenticate
29422 if AUTH is in use, before sending the next message.
29423
29424 The RFC is not clear as to whether or not an SMTP session continues in clear
29425 after TLS has been shut down, or whether TLS may be restarted again later, as
29426 just described. However, if the server is Exim, this shutdown and
29427 reinitialization works. It is not known which (if any) other servers operate
29428 successfully if the client closes a TLS session and continues with unencrypted
29429 SMTP, but there are certainly some that do not work. For such servers, Exim
29430 should not pass the socket to another process, because the failure of the
29431 subsequent attempt to use it would cause Exim to record a temporary host error,
29432 and delay other deliveries to that host.
29433
29434 To test for this case, Exim sends an EHLO command to the server after
29435 closing down the TLS session. If this fails in any way, the connection is
29436 closed instead of being passed to a new delivery process, but no retry
29437 information is recorded.
29438
29439 There is also a manual override; you can set &%hosts_nopass_tls%& on the
29440 &(smtp)& transport to match those hosts for which Exim should not pass
29441 connections to new processes if TLS has been used.
29442
29443
29444
29445
29446 .section "Certificates and all that" "SECTcerandall"
29447 .cindex "certificate" "references to discussion"
29448 In order to understand fully how TLS works, you need to know about
29449 certificates, certificate signing, and certificate authorities.
29450 This is a large topic and an introductory guide is unsuitable for the Exim
29451 reference manual, so instead we provide pointers to existing documentation.
29452
29453 The Apache web-server was for a long time the canonical guide, so their
29454 documentation is a good place to start; their SSL module's Introduction
29455 document is currently at
29456 .display
29457 &url(https://httpd.apache.org/docs/current/ssl/ssl_intro.html)
29458 .endd
29459 and their FAQ is at
29460 .display
29461 &url(https://httpd.apache.org/docs/current/ssl/ssl_faq.html)
29462 .endd
29463
29464 Eric Rescorla's book, &'SSL and TLS'&, published by Addison-Wesley (ISBN
29465 0-201-61598-3) in 2001, contains both introductory and more in-depth
29466 descriptions.
29467 More recently Ivan Ristić's book &'Bulletproof SSL and TLS'&,
29468 published by Feisty Duck (ISBN 978-1907117046) in 2013 is good.
29469 Ivan is the author of the popular TLS testing tools at
29470 &url(https://www.ssllabs.com/).
29471
29472
29473 .section "Certificate chains" "SECID186"
29474 The file named by &%tls_certificate%& may contain more than one
29475 certificate. This is useful in the case where the certificate that is being
29476 sent is validated by an intermediate certificate which the other end does
29477 not have. Multiple certificates must be in the correct order in the file.
29478 First the host's certificate itself, then the first intermediate
29479 certificate to validate the issuer of the host certificate, then the next
29480 intermediate certificate to validate the issuer of the first intermediate
29481 certificate, and so on, until finally (optionally) the root certificate.
29482 The root certificate must already be trusted by the recipient for
29483 validation to succeed, of course, but if it's not preinstalled, sending the
29484 root certificate along with the rest makes it available for the user to
29485 install if the receiving end is a client MUA that can interact with a user.
29486
29487 Note that certificates using MD5 are unlikely to work on today's Internet;
29488 even if your libraries allow loading them for use in Exim when acting as a
29489 server, increasingly clients will not accept such certificates.  The error
29490 diagnostics in such a case can be frustratingly vague.
29491
29492
29493
29494 .section "Self-signed certificates" "SECID187"
29495 .cindex "certificate" "self-signed"
29496 You can create a self-signed certificate using the &'req'& command provided
29497 with OpenSSL, like this:
29498 . ==== Do not shorten the duration here without reading and considering
29499 . ==== the text below.  Please leave it at 9999 days.
29500 .code
29501 openssl req -x509 -newkey rsa:1024 -keyout file1 -out file2 \
29502             -days 9999 -nodes
29503 .endd
29504 &_file1_& and &_file2_& can be the same file; the key and the certificate are
29505 delimited and so can be identified independently. The &%-days%& option
29506 specifies a period for which the certificate is valid. The &%-nodes%& option is
29507 important: if you do not set it, the key is encrypted with a passphrase
29508 that you are prompted for, and any use that is made of the key causes more
29509 prompting for the passphrase. This is not helpful if you are going to use
29510 this certificate and key in an MTA, where prompting is not possible.
29511
29512 . ==== I expect to still be working 26 years from now.  The less technical
29513 . ==== debt I create, in terms of storing up trouble for my later years, the
29514 . ==== happier I will be then.  We really have reached the point where we
29515 . ==== should start, at the very least, provoking thought and making folks
29516 . ==== pause before proceeding, instead of leaving all the fixes until two
29517 . ==== years before 2^31 seconds after the 1970 Unix epoch.
29518 . ==== -pdp, 2012
29519 NB: we are now past the point where 9999 days takes us past the 32-bit Unix
29520 epoch.  If your system uses unsigned time_t (most do) and is 32-bit, then
29521 the above command might produce a date in the past.  Think carefully about
29522 the lifetime of the systems you're deploying, and either reduce the duration
29523 of the certificate or reconsider your platform deployment.  (At time of
29524 writing, reducing the duration is the most likely choice, but the inexorable
29525 progression of time takes us steadily towards an era where this will not
29526 be a sensible resolution).
29527
29528 A self-signed certificate made in this way is sufficient for testing, and
29529 may be adequate for all your requirements if you are mainly interested in
29530 encrypting transfers, and not in secure identification.
29531
29532 However, many clients require that the certificate presented by the server be a
29533 user (also called &"leaf"& or &"site"&) certificate, and not a self-signed
29534 certificate. In this situation, the self-signed certificate described above
29535 must be installed on the client host as a trusted root &'certification
29536 authority'& (CA), and the certificate used by Exim must be a user certificate
29537 signed with that self-signed certificate.
29538
29539 For information on creating self-signed CA certificates and using them to sign
29540 user certificates, see the &'General implementation overview'& chapter of the
29541 Open-source PKI book, available online at
29542 &url(https://sourceforge.net/projects/ospkibook/).
29543 .ecindex IIDencsmtp1
29544 .ecindex IIDencsmtp2
29545
29546
29547 .new
29548 .section "TLS Resumption" "SECTresumption"
29549 .cindex TLS resumption
29550 TLS Session Resumption for TLS 1.2 and TLS 1.3 connections can be used (defined
29551 in RFC 5077 for 1.2).  The support for this requires GnuTLS 3.6.3 or OpenSSL 1.1.1
29552 (or later).
29553
29554 Session resumption (this is the "stateless" variant) involves the server sending
29555 a "session ticket" to the client on one connection, which can be stored by the
29556 client and used for a later session.  The ticket contains sufficient state for
29557 the server to reconstruct the TLS session, avoiding some expensive crypto
29558 calculation and (on TLS1.2) one full packet roundtrip time.
29559
29560 .ilist
29561 Operational cost/benefit:
29562
29563  The extra data being transmitted costs a minor amount, and the client has
29564  extra costs in storing and retrieving the data.
29565
29566  In the Exim/Gnutls implementation the extra cost on an initial connection
29567  which is TLS1.2 over a loopback path is about 6ms on 2017-laptop class hardware.
29568  The saved cost on a subsequent connection is about 4ms; three or more
29569  connections become a net win.  On longer network paths, two or more
29570  connections will have an average lower startup time thanks to the one
29571  saved packet roundtrip.  TLS1.3 will save the crypto cpu costs but not any
29572  packet roundtrips.
29573
29574 .cindex "hints database" tls
29575  Since a new hints DB is used on the TLS client,
29576  the hints DB maintenance should be updated to additionally handle "tls".
29577
29578 .next
29579 Security aspects:
29580
29581  The session ticket is encrypted, but is obviously an additional security
29582  vulnarability surface.  An attacker able to decrypt it would have access
29583  all connections using the resumed session.
29584  The session ticket encryption key is not committed to storage by the server
29585  and is rotated regularly (OpenSSL: 1hr, and one previous key is used for
29586  overlap; GnuTLS 6hr but does not specify any overlap).
29587  Tickets have limited lifetime (2hr, and new ones issued after 1hr under
29588  OpenSSL.  GnuTLS 2hr, appears to not do overlap).
29589
29590  There is a question-mark over the security of the Diffie-Helman parameters
29591  used for session negotiation.
29592
29593 .next
29594 Observability:
29595
29596  The &%log_selector%& "tls_resumption" appends an asterisk to the tls_cipher "X="
29597  element.
29598
29599  The variables &$tls_in_resumption$& and &$tls_out_resumption$&
29600  have bits 0-4 indicating respectively
29601  support built, client requested ticket, client offered session,
29602  server issued ticket, resume used.  A suitable decode list is provided
29603  in the builtin macro _RESUME_DECODE for in &%listextract%& expansions.
29604
29605 .next
29606 Control:
29607
29608 The &%tls_resumption_hosts%& main option specifies a hostlist for which
29609 exim, operating as a server, will offer resumption to clients.
29610 Current best practice is to not offer the feature to MUA connection.
29611 Commonly this can be done like this:
29612 .code
29613 tls_resumption_hosts = ${if inlist {$received_port}{587:465} {:}{*}}
29614 .endd
29615 If the peer host matches the list after expansion then resumption
29616 is offered and/or accepted.
29617
29618 The &%tls_resumption_hosts%& smtp transport option performs the
29619 equivalent function for operation as a client.
29620 If the peer host matches the list after expansion then resumption
29621 is attempted (if a stored session is available) or the information
29622 stored (if supplied by the peer).
29623
29624
29625 .next
29626 Issues:
29627
29628  In a resumed session:
29629 .ilist
29630   The variables &$tls_{in,out}_cipher$& will have values different
29631  to the original (under GnuTLS).
29632 .next
29633   The variables &$tls_{in,out}_ocsp$& will be "not requested" or "no response",
29634  and the &%hosts_require_ocsp%& smtp trasnport option will fail.
29635 . XXX need to do something with that hosts_require_ocsp
29636 .endlist
29637
29638 .endlist
29639 .wen
29640
29641
29642 .section DANE "SECDANE"
29643 .cindex DANE
29644 DNS-based Authentication of Named Entities, as applied to SMTP over TLS, provides assurance to a client that
29645 it is actually talking to the server it wants to rather than some attacker operating a Man In The Middle (MITM)
29646 operation.  The latter can terminate the TLS connection you make, and make another one to the server (so both
29647 you and the server still think you have an encrypted connection) and, if one of the "well known" set of
29648 Certificate Authorities has been suborned - something which *has* been seen already (2014), a verifiable
29649 certificate (if you're using normal root CAs, eg. the Mozilla set, as your trust anchors).
29650
29651 What DANE does is replace the CAs with the DNS as the trust anchor.  The assurance is limited to a) the possibility
29652 that the DNS has been suborned, b) mistakes made by the admins of the target server.   The attack surface presented
29653 by (a) is thought to be smaller than that of the set of root CAs.
29654
29655 It also allows the server to declare (implicitly) that connections to it should use TLS.  An MITM could simply
29656 fail to pass on a server's STARTTLS.
29657
29658 DANE scales better than having to maintain (and side-channel communicate) copies of server certificates
29659 for every possible target server.  It also scales (slightly) better than having to maintain on an SMTP
29660 client a copy of the standard CAs bundle.  It also means not having to pay a CA for certificates.
29661
29662 DANE requires a server operator to do three things: 1) run DNSSEC.  This provides assurance to clients
29663 that DNS lookups they do for the server have not been tampered with.  The domain MX record applying
29664 to this server, its A record, its TLSA record and any associated CNAME records must all be covered by
29665 DNSSEC.
29666 2) add TLSA DNS records.  These say what the server certificate for a TLS connection should be.
29667 3) offer a server certificate, or certificate chain, in TLS connections which is is anchored by one of the TLSA records.
29668
29669 There are no changes to Exim specific to server-side operation of DANE.
29670 Support for client-side operation of DANE can be included at compile time by defining SUPPORT_DANE=yes
29671 in &_Local/Makefile_&.
29672 If it has been included, the macro "_HAVE_DANE" will be defined.
29673
29674 A TLSA record consist of 4 fields, the "Certificate Usage", the
29675 "Selector", the "Matching type", and the "Certificate Association Data".
29676 For a detailed description of the TLSA record see
29677 &url(https://tools.ietf.org/html/rfc7671#page-5,RFC 7671).
29678
29679 The TLSA record for the server may have "Certificate Usage" (1st) field of DANE-TA(2) or DANE-EE(3).
29680 These are the "Trust Anchor" and "End Entity" variants.
29681 The latter specifies the End Entity directly, i.e. the certificate involved is that of the server
29682 (and if only DANE-EE is used then it should be the sole one transmitted during the TLS handshake);
29683 this is appropriate for a single system, using a self-signed certificate.
29684 DANE-TA usage is effectively declaring a specific CA to be used; this might be a private CA or a public,
29685 well-known one.
29686 A private CA at simplest is just a self-signed certificate (with certain
29687 attributes) which is used to sign server certificates, but running one securely
29688 does require careful arrangement.
29689 With DANE-TA, as implemented in Exim and commonly in other MTAs,
29690 the server TLS handshake must transmit the entire certificate chain from CA to server-certificate.
29691 DANE-TA is commonly used for several services and/or servers, each having a TLSA query-domain CNAME record,
29692 all of which point to a single TLSA record.
29693 DANE-TA and DANE-EE can both be used together.
29694
29695 Our recommendation is to use DANE with a certificate from a public CA,
29696 because this enables a variety of strategies for remote clients to verify
29697 your certificate.
29698 You can then publish information both via DANE and another technology,
29699 "MTA-STS", described below.
29700
29701 When you use DANE-TA to publish trust anchor information, you ask entities
29702 outside your administrative control to trust the Certificate Authority for
29703 connections to you.
29704 If using a private CA then you should expect others to still apply the
29705 technical criteria they'd use for a public CA to your certificates.
29706 In particular, you should probably try to follow current best practices for CA
29707 operation around hash algorithms and key sizes.
29708 Do not expect other organizations to lower their security expectations just
29709 because a particular profile might be reasonable for your own internal use.
29710
29711 When this text was last updated, this in practice means to avoid use of SHA-1
29712 and MD5; if using RSA to use key sizes of at least 2048 bits (and no larger
29713 than 4096, for interoperability); to use keyUsage fields correctly; to use
29714 random serial numbers.
29715 The list of requirements is subject to change as best practices evolve.
29716 If you're not already using a private CA, or it doesn't meet these
29717 requirements, then we encourage you to avoid all these issues and use a public
29718 CA such as &url(https://letsencrypt.org/,Let's Encrypt) instead.
29719
29720 The TLSA record should have a "Selector" (2nd) field of SPKI(1) and
29721 a "Matching Type" (3rd) field of SHA2-512(2).
29722
29723 For the "Certificate Authority Data" (4th) field, commands like
29724
29725 .code
29726   openssl x509 -pubkey -noout <certificate.pem \
29727   | openssl rsa -outform der -pubin 2>/dev/null \
29728   | openssl sha512 \
29729   | awk '{print $2}'
29730 .endd
29731
29732 are workable to create a hash of the certificate's public key.
29733
29734 An example TLSA record for DANE-EE(3), SPKI(1), and SHA-512 (2) looks like
29735
29736 .code
29737   _25._tcp.mail.example.com. TLSA 3 1 2 8BA8A336E...
29738 .endd
29739
29740 At the time of writing, &url(https://www.huque.com/bin/gen_tlsa)
29741 is useful for quickly generating TLSA records.
29742
29743
29744 For use with the DANE-TA model, server certificates must have a correct name (SubjectName or SubjectAltName).
29745
29746 The Certificate issued by the CA published in the DANE-TA model should be
29747 issued using a strong hash algorithm.
29748 Exim, and importantly various other MTAs sending to you, will not
29749 re-enable hash algorithms which have been disabled by default in TLS
29750 libraries.
29751 This means no MD5 and no SHA-1.  SHA2-256 is the minimum for reliable
29752 interoperability (and probably the maximum too, in 2018).
29753
29754 The use of OCSP-stapling should be considered, allowing for fast revocation of certificates (which would otherwise
29755 be limited by the DNS TTL on the TLSA records).  However, this is likely to only be usable with DANE-TA.  NOTE: the
29756 default of requesting OCSP for all hosts is modified iff DANE is in use, to:
29757
29758 .code
29759   hosts_request_ocsp = ${if or { {= {0}{$tls_out_tlsa_usage}} \
29760                                  {= {4}{$tls_out_tlsa_usage}} } \
29761                          {*}{}}
29762 .endd
29763
29764 The (new) variable &$tls_out_tlsa_usage$& is a bitfield with numbered bits set for TLSA record usage codes.
29765 The zero above means DANE was not in use, the four means that only DANE-TA usage TLSA records were
29766 found. If the definition of &%hosts_request_ocsp%& includes the
29767 string "tls_out_tlsa_usage", they are re-expanded in time to
29768 control the OCSP request.
29769
29770 This modification of hosts_request_ocsp is only done if it has the default value of "*".  Admins who change it, and
29771 those who use &%hosts_require_ocsp%&, should consider the interaction with DANE in their OCSP settings.
29772
29773
29774 For client-side DANE there are three new smtp transport options, &%hosts_try_dane%&, &%hosts_require_dane%&
29775 and &%dane_require_tls_ciphers%&.
29776 The &"require"& variant will result in failure if the target host is not
29777 DNSSEC-secured. To get DNSSEC-secured hostname resolution, use
29778 the &%dnssec_request_domains%& router or transport option.
29779
29780 DANE will only be usable if the target host has DNSSEC-secured MX, A and TLSA records.
29781
29782 A TLSA lookup will be done if either of the above options match and the host-lookup succeeded using dnssec.
29783 If a TLSA lookup is done and succeeds, a DANE-verified TLS connection
29784 will be required for the host.  If it does not, the host will not
29785 be used; there is no fallback to non-DANE or non-TLS.
29786
29787 If DANE is requested and usable, then the TLS cipher list configuration
29788 prefers to use the option &%dane_require_tls_ciphers%& and falls
29789 back to &%tls_require_ciphers%& only if that is unset.
29790 This lets you configure "decent crypto" for DANE and "better than nothing
29791 crypto" as the default.  Note though that while GnuTLS lets the string control
29792 which versions of TLS/SSL will be negotiated, OpenSSL does not and you're
29793 limited to ciphersuite constraints.
29794
29795 If DANE is requested and useable (see above) the following transport options are ignored:
29796 .code
29797   hosts_require_tls
29798   tls_verify_hosts
29799   tls_try_verify_hosts
29800   tls_verify_certificates
29801   tls_crl
29802   tls_verify_cert_hostnames
29803 .endd
29804
29805 If DANE is not usable, whether requested or not, and CA-anchored
29806 verification evaluation is wanted, the above variables should be set appropriately.
29807
29808 The router and transport option &%dnssec_request_domains%& must not be
29809 set to &"never"&, and &%dnssec_require_domains%& is ignored.
29810
29811 If verification was successful using DANE then the "CV" item in the delivery log line will show as "CV=dane".
29812
29813 There is a new variable &$tls_out_dane$& which will have "yes" if
29814 verification succeeded using DANE and "no" otherwise (only useful
29815 in combination with events; see &<<CHAPevents>>&),
29816 and a new variable &$tls_out_tlsa_usage$& (detailed above).
29817
29818 .cindex DANE reporting
29819 An event (see &<<CHAPevents>>&) of type "dane:fail" will be raised on failures
29820 to achieve DANE-verified connection, if one was either requested and offered, or
29821 required.  This is intended to support TLS-reporting as defined in
29822 &url(https://tools.ietf.org/html/draft-ietf-uta-smtp-tlsrpt-17).
29823 The &$event_data$& will be one of the Result Types defined in
29824 Section 4.3 of that document.
29825
29826 Under GnuTLS, DANE is only supported from version 3.0.0 onwards.
29827
29828 DANE is specified in published RFCs and decouples certificate authority trust
29829 selection from a "race to the bottom" of "you must trust everything for mail
29830 to get through".  There is an alternative technology called MTA-STS, which
29831 instead publishes MX trust anchor information on an HTTPS website.  At the
29832 time this text was last updated, MTA-STS was still a draft, not yet an RFC.
29833 Exim has no support for MTA-STS as a client, but Exim mail server operators
29834 can choose to publish information describing their TLS configuration using
29835 MTA-STS to let those clients who do use that protocol derive trust
29836 information.
29837
29838 The MTA-STS design requires a certificate from a public Certificate Authority
29839 which is recognized by clients sending to you.
29840 That selection of which CAs are trusted by others is outside your control.
29841
29842 The most interoperable course of action is probably to use
29843 &url(https://letsencrypt.org/,Let's Encrypt), with automated certificate
29844 renewal; to publish the anchor information in DNSSEC-secured DNS via TLSA
29845 records for DANE clients (such as Exim and Postfix) and to publish anchor
29846 information for MTA-STS as well.  This is what is done for the &'exim.org'&
29847 domain itself (with caveats around occasionally broken MTA-STS because of
29848 incompatible specification changes prior to reaching RFC status).
29849
29850
29851
29852 . ////////////////////////////////////////////////////////////////////////////
29853 . ////////////////////////////////////////////////////////////////////////////
29854
29855 .chapter "Access control lists" "CHAPACL"
29856 .scindex IIDacl "&ACL;" "description"
29857 .cindex "control of incoming mail"
29858 .cindex "message" "controlling incoming"
29859 .cindex "policy control" "access control lists"
29860 Access Control Lists (ACLs) are defined in a separate section of the runtime
29861 configuration file, headed by &"begin acl"&. Each ACL definition starts with a
29862 name, terminated by a colon. Here is a complete ACL section that contains just
29863 one very small ACL:
29864 .code
29865 begin acl
29866 small_acl:
29867   accept   hosts = one.host.only
29868 .endd
29869 You can have as many lists as you like in the ACL section, and the order in
29870 which they appear does not matter. The lists are self-terminating.
29871
29872 The majority of ACLs are used to control Exim's behaviour when it receives
29873 certain SMTP commands. This applies both to incoming TCP/IP connections, and
29874 when a local process submits a message using SMTP by specifying the &%-bs%&
29875 option. The most common use is for controlling which recipients are accepted
29876 in incoming messages. In addition, you can define an ACL that is used to check
29877 local non-SMTP messages. The default configuration file contains an example of
29878 a realistic ACL for checking RCPT commands. This is discussed in chapter
29879 &<<CHAPdefconfil>>&.
29880
29881
29882 .section "Testing ACLs" "SECID188"
29883 The &%-bh%& command line option provides a way of testing your ACL
29884 configuration locally by running a fake SMTP session with which you interact.
29885
29886
29887 .section "Specifying when ACLs are used" "SECID189"
29888 .cindex "&ACL;" "options for specifying"
29889 In order to cause an ACL to be used, you have to name it in one of the relevant
29890 options in the main part of the configuration. These options are:
29891 .cindex "AUTH" "ACL for"
29892 .cindex "DATA" "ACLs for"
29893 .cindex "ETRN" "ACL for"
29894 .cindex "EXPN" "ACL for"
29895 .cindex "HELO" "ACL for"
29896 .cindex "EHLO" "ACL for"
29897 .cindex "DKIM" "ACL for"
29898 .cindex "MAIL" "ACL for"
29899 .cindex "QUIT, ACL for"
29900 .cindex "RCPT" "ACL for"
29901 .cindex "STARTTLS, ACL for"
29902 .cindex "VRFY" "ACL for"
29903 .cindex "SMTP" "connection, ACL for"
29904 .cindex "non-SMTP messages" "ACLs for"
29905 .cindex "MIME content scanning" "ACL for"
29906 .cindex "PRDR" "ACL for"
29907
29908 .table2 140pt
29909 .irow &%acl_not_smtp%&         "ACL for non-SMTP messages"
29910 .irow &%acl_not_smtp_mime%&    "ACL for non-SMTP MIME parts"
29911 .irow &%acl_not_smtp_start%&   "ACL at start of non-SMTP message"
29912 .irow &%acl_smtp_auth%&        "ACL for AUTH"
29913 .irow &%acl_smtp_connect%&     "ACL for start of SMTP connection"
29914 .irow &%acl_smtp_data%&        "ACL after DATA is complete"
29915 .irow &%acl_smtp_data_prdr%&   "ACL for each recipient, after DATA is complete"
29916 .irow &%acl_smtp_dkim%&        "ACL for each DKIM signer"
29917 .irow &%acl_smtp_etrn%&        "ACL for ETRN"
29918 .irow &%acl_smtp_expn%&        "ACL for EXPN"
29919 .irow &%acl_smtp_helo%&        "ACL for HELO or EHLO"
29920 .irow &%acl_smtp_mail%&        "ACL for MAIL"
29921 .irow &%acl_smtp_mailauth%&    "ACL for the AUTH parameter of MAIL"
29922 .irow &%acl_smtp_mime%&        "ACL for content-scanning MIME parts"
29923 .irow &%acl_smtp_notquit%&     "ACL for non-QUIT terminations"
29924 .irow &%acl_smtp_predata%&     "ACL at start of DATA command"
29925 .irow &%acl_smtp_quit%&        "ACL for QUIT"
29926 .irow &%acl_smtp_rcpt%&        "ACL for RCPT"
29927 .irow &%acl_smtp_starttls%&    "ACL for STARTTLS"
29928 .irow &%acl_smtp_vrfy%&        "ACL for VRFY"
29929 .endtable
29930
29931 For example, if you set
29932 .code
29933 acl_smtp_rcpt = small_acl
29934 .endd
29935 the little ACL defined above is used whenever Exim receives a RCPT command
29936 in an SMTP dialogue. The majority of policy tests on incoming messages can be
29937 done when RCPT commands arrive. A rejection of RCPT should cause the
29938 sending MTA to give up on the recipient address contained in the RCPT
29939 command, whereas rejection at other times may cause the client MTA to keep on
29940 trying to deliver the message. It is therefore recommended that you do as much
29941 testing as possible at RCPT time.
29942
29943
29944 .section "The non-SMTP ACLs" "SECID190"
29945 .cindex "non-SMTP messages" "ACLs for"
29946 The non-SMTP ACLs apply to all non-interactive incoming messages, that is, they
29947 apply to batched SMTP as well as to non-SMTP messages. (Batched SMTP is not
29948 really SMTP.) Many of the ACL conditions (for example, host tests, and tests on
29949 the state of the SMTP connection such as encryption and authentication) are not
29950 relevant and are forbidden in these ACLs. However, the sender and recipients
29951 are known, so the &%senders%& and &%sender_domains%& conditions and the
29952 &$sender_address$& and &$recipients$& variables can be used. Variables such as
29953 &$authenticated_sender$& are also available. You can specify added header lines
29954 in any of these ACLs.
29955
29956 The &%acl_not_smtp_start%& ACL is run right at the start of receiving a
29957 non-SMTP message, before any of the message has been read. (This is the
29958 analogue of the &%acl_smtp_predata%& ACL for SMTP input.) In the case of
29959 batched SMTP input, it runs after the DATA command has been reached. The
29960 result of this ACL is ignored; it cannot be used to reject a message. If you
29961 really need to, you could set a value in an ACL variable here and reject based
29962 on that in the &%acl_not_smtp%& ACL. However, this ACL can be used to set
29963 controls, and in particular, it can be used to set
29964 .code
29965 control = suppress_local_fixups
29966 .endd
29967 This cannot be used in the other non-SMTP ACLs because by the time they are
29968 run, it is too late.
29969
29970 The &%acl_not_smtp_mime%& ACL is available only when Exim is compiled with the
29971 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
29972
29973 The &%acl_not_smtp%& ACL is run just before the &[local_scan()]& function. Any
29974 kind of rejection is treated as permanent, because there is no way of sending a
29975 temporary error for these kinds of message.
29976
29977
29978 .section "The SMTP connect ACL" "SECID191"
29979 .cindex "SMTP" "connection, ACL for"
29980 .oindex &%smtp_banner%&
29981 The ACL test specified by &%acl_smtp_connect%& happens at the start of an SMTP
29982 session, after the test specified by &%host_reject_connection%& (which is now
29983 an anomaly) and any TCP Wrappers testing (if configured). If the connection is
29984 accepted by an &%accept%& verb that has a &%message%& modifier, the contents of
29985 the message override the banner message that is otherwise specified by the
29986 &%smtp_banner%& option.
29987
29988
29989 .section "The EHLO/HELO ACL" "SECID192"
29990 .cindex "EHLO" "ACL for"
29991 .cindex "HELO" "ACL for"
29992 The ACL test specified by &%acl_smtp_helo%& happens when the client issues an
29993 EHLO or HELO command, after the tests specified by &%helo_accept_junk_hosts%&,
29994 &%helo_allow_chars%&, &%helo_verify_hosts%&, and &%helo_try_verify_hosts%&.
29995 Note that a client may issue more than one EHLO or HELO command in an SMTP
29996 session, and indeed is required to issue a new EHLO or HELO after successfully
29997 setting up encryption following a STARTTLS command.
29998
29999 Note also that a deny neither forces the client to go away nor means that
30000 mail will be refused on the connection.  Consider checking for
30001 &$sender_helo_name$& being defined in a MAIL or RCPT ACL to do that.
30002
30003 If the command is accepted by an &%accept%& verb that has a &%message%&
30004 modifier, the message may not contain more than one line (it will be truncated
30005 at the first newline and a panic logged if it does). Such a message cannot
30006 affect the EHLO options that are listed on the second and subsequent lines of
30007 an EHLO response.
30008
30009
30010 .section "The DATA ACLs" "SECID193"
30011 .cindex "DATA" "ACLs for"
30012 Two ACLs are associated with the DATA command, because it is two-stage
30013 command, with two responses being sent to the client.
30014 When the DATA command is received, the ACL defined by &%acl_smtp_predata%&
30015 is obeyed. This gives you control after all the RCPT commands, but before
30016 the message itself is received. It offers the opportunity to give a negative
30017 response to the DATA command before the data is transmitted. Header lines
30018 added by MAIL or RCPT ACLs are not visible at this time, but any that
30019 are defined here are visible when the &%acl_smtp_data%& ACL is run.
30020
30021 You cannot test the contents of the message, for example, to verify addresses
30022 in the headers, at RCPT time or when the DATA command is received. Such
30023 tests have to appear in the ACL that is run after the message itself has been
30024 received, before the final response to the DATA command is sent. This is
30025 the ACL specified by &%acl_smtp_data%&, which is the second ACL that is
30026 associated with the DATA command.
30027
30028 .cindex CHUNKING "BDAT command"
30029 .cindex BDAT "SMTP command"
30030 .cindex "RFC 3030" CHUNKING
30031 If CHUNKING was advertised and a BDAT command sequence is received,
30032 the &%acl_smtp_predata%& ACL is not run.
30033 . XXX why not?  It should be possible, for the first BDAT.
30034 The &%acl_smtp_data%& is run after the last BDAT command and all of
30035 the data specified is received.
30036
30037 For both of these ACLs, it is not possible to reject individual recipients. An
30038 error response rejects the entire message. Unfortunately, it is known that some
30039 MTAs do not treat hard (5&'xx'&) responses to the DATA command (either
30040 before or after the data) correctly &-- they keep the message on their queues
30041 and try again later, but that is their problem, though it does waste some of
30042 your resources.
30043
30044 The &%acl_smtp_data%& ACL is run after
30045 the &%acl_smtp_data_prdr%&,
30046 the &%acl_smtp_dkim%&
30047 and the &%acl_smtp_mime%& ACLs.
30048
30049 .section "The SMTP DKIM ACL" "SECTDKIMACL"
30050 The &%acl_smtp_dkim%& ACL is available only when Exim is compiled with DKIM support
30051 enabled (which is the default).
30052
30053 The ACL test specified by &%acl_smtp_dkim%& happens after a message has been
30054 received, and is executed for each DKIM signature found in a message.  If not
30055 otherwise specified, the default action is to accept.
30056
30057 This ACL is evaluated before &%acl_smtp_mime%& and &%acl_smtp_data%&.
30058
30059 For details on the operation of DKIM, see section &<<SECDKIM>>&.
30060
30061
30062 .section "The SMTP MIME ACL" "SECID194"
30063 The &%acl_smtp_mime%& option is available only when Exim is compiled with the
30064 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
30065
30066 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
30067
30068
30069 .section "The SMTP PRDR ACL" "SECTPRDRACL"
30070 .cindex "PRDR" "ACL for"
30071 .oindex "&%prdr_enable%&"
30072 The &%acl_smtp_data_prdr%& ACL is available only when Exim is compiled
30073 with PRDR support enabled (which is the default).
30074 It becomes active only when the PRDR feature is negotiated between
30075 client and server for a message, and more than one recipient
30076 has been accepted.
30077
30078 The ACL test specified by &%acl_smtp_data_prdr%& happens after a message
30079 has been received, and is executed once for each recipient of the message
30080 with &$local_part$& and &$domain$& valid.
30081 The test may accept, defer or deny for individual recipients.
30082 The &%acl_smtp_data%& will still be called after this ACL and
30083 can reject the message overall, even if this ACL has accepted it
30084 for some or all recipients.
30085
30086 PRDR may be used to support per-user content filtering.  Without it
30087 one must defer any recipient after the first that has a different
30088 content-filter configuration.  With PRDR, the RCPT-time check
30089 .cindex "PRDR" "variable for"
30090 for this can be disabled when the variable &$prdr_requested$&
30091 is &"yes"&.
30092 Any required difference in behaviour of the main DATA-time
30093 ACL should however depend on the PRDR-time ACL having run, as Exim
30094 will avoid doing so in some situations (e.g. single-recipient mails).
30095
30096 See also the &%prdr_enable%& global option
30097 and the &%hosts_try_prdr%& smtp transport option.
30098
30099 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
30100 If the ACL is not defined, processing completes as if
30101 the feature was not requested by the client.
30102
30103 .section "The QUIT ACL" "SECTQUITACL"
30104 .cindex "QUIT, ACL for"
30105 The ACL for the SMTP QUIT command is anomalous, in that the outcome of the ACL
30106 does not affect the response code to QUIT, which is always 221. Thus, the ACL
30107 does not in fact control any access.
30108 For this reason, it may only accept
30109 or warn as its final result.
30110
30111 This ACL can be used for tasks such as custom logging at the end of an SMTP
30112 session. For example, you can use ACL variables in other ACLs to count
30113 messages, recipients, etc., and log the totals at QUIT time using one or
30114 more &%logwrite%& modifiers on a &%warn%& verb.
30115
30116 &*Warning*&: Only the &$acl_c$&&'x'& variables can be used for this, because
30117 the &$acl_m$&&'x'& variables are reset at the end of each incoming message.
30118
30119 You do not need to have a final &%accept%&, but if you do, you can use a
30120 &%message%& modifier to specify custom text that is sent as part of the 221
30121 response to QUIT.
30122
30123 This ACL is run only for a &"normal"& QUIT. For certain kinds of disastrous
30124 failure (for example, failure to open a log file, or when Exim is bombing out
30125 because it has detected an unrecoverable error), all SMTP commands from the
30126 client are given temporary error responses until QUIT is received or the
30127 connection is closed. In these special cases, the QUIT ACL does not run.
30128
30129
30130 .section "The not-QUIT ACL" "SECTNOTQUITACL"
30131 .vindex &$acl_smtp_notquit$&
30132 The not-QUIT ACL, specified by &%acl_smtp_notquit%&, is run in most cases when
30133 an SMTP session ends without sending QUIT. However, when Exim itself is in bad
30134 trouble, such as being unable to write to its log files, this ACL is not run,
30135 because it might try to do things (such as write to log files) that make the
30136 situation even worse.
30137
30138 Like the QUIT ACL, this ACL is provided to make it possible to do customized
30139 logging or to gather statistics, and its outcome is ignored. The &%delay%&
30140 modifier is forbidden in this ACL, and the only permitted verbs are &%accept%&
30141 and &%warn%&.
30142
30143 .vindex &$smtp_notquit_reason$&
30144 When the not-QUIT ACL is running, the variable &$smtp_notquit_reason$& is set
30145 to a string that indicates the reason for the termination of the SMTP
30146 connection. The possible values are:
30147 .table2
30148 .irow &`acl-drop`&                 "Another ACL issued a &%drop%& command"
30149 .irow &`bad-commands`&             "Too many unknown or non-mail commands"
30150 .irow &`command-timeout`&          "Timeout while reading SMTP commands"
30151 .irow &`connection-lost`&          "The SMTP connection has been lost"
30152 .irow &`data-timeout`&             "Timeout while reading message data"
30153 .irow &`local-scan-error`&         "The &[local_scan()]& function crashed"
30154 .irow &`local-scan-timeout`&       "The &[local_scan()]& function timed out"
30155 .irow &`signal-exit`&              "SIGTERM or SIGINT"
30156 .irow &`synchronization-error`&    "SMTP synchronization error"
30157 .irow &`tls-failed`&               "TLS failed to start"
30158 .endtable
30159 In most cases when an SMTP connection is closed without having received QUIT,
30160 Exim sends an SMTP response message before actually closing the connection.
30161 With the exception of the &`acl-drop`& case, the default message can be
30162 overridden by the &%message%& modifier in the not-QUIT ACL. In the case of a
30163 &%drop%& verb in another ACL, it is the message from the other ACL that is
30164 used.
30165
30166
30167 .section "Finding an ACL to use" "SECID195"
30168 .cindex "&ACL;" "finding which to use"
30169 The value of an &%acl_smtp_%&&'xxx'& option is expanded before use, so
30170 you can use different ACLs in different circumstances. For example,
30171 .code
30172 acl_smtp_rcpt = ${if ={25}{$interface_port} \
30173                      {acl_check_rcpt} {acl_check_rcpt_submit} }
30174 .endd
30175 In the default configuration file there are some example settings for
30176 providing an RFC 4409 message &"submission"& service on port 587 and
30177 an RFC 8314 &"submissions"& service on port 465. You can use a string
30178 expansion like this to choose an ACL for MUAs on these ports which is
30179 more appropriate for this purpose than the default ACL on port 25.
30180
30181 The expanded string does not have to be the name of an ACL in the
30182 configuration file; there are other possibilities. Having expanded the
30183 string, Exim searches for an ACL as follows:
30184
30185 .ilist
30186 If the string begins with a slash, Exim uses it as a filename, and reads its
30187 contents as an ACL. The lines are processed in the same way as lines in the
30188 Exim configuration file. In particular, continuation lines are supported, blank
30189 lines are ignored, as are lines whose first non-whitespace character is &"#"&.
30190 If the file does not exist or cannot be read, an error occurs (typically
30191 causing a temporary failure of whatever caused the ACL to be run). For example:
30192 .code
30193 acl_smtp_data = /etc/acls/\
30194   ${lookup{$sender_host_address}lsearch\
30195   {/etc/acllist}{$value}{default}}
30196 .endd
30197 This looks up an ACL file to use on the basis of the host's IP address, falling
30198 back to a default if the lookup fails. If an ACL is successfully read from a
30199 file, it is retained in memory for the duration of the Exim process, so that it
30200 can be re-used without having to re-read the file.
30201 .next
30202 If the string does not start with a slash, and does not contain any spaces,
30203 Exim searches the ACL section of the configuration for an ACL whose name
30204 matches the string.
30205 .next
30206 If no named ACL is found, or if the string contains spaces, Exim parses
30207 the string as an inline ACL. This can save typing in cases where you just
30208 want to have something like
30209 .code
30210 acl_smtp_vrfy = accept
30211 .endd
30212 in order to allow free use of the VRFY command. Such a string may contain
30213 newlines; it is processed in the same way as an ACL that is read from a file.
30214 .endlist
30215
30216
30217
30218
30219 .section "ACL return codes" "SECID196"
30220 .cindex "&ACL;" "return codes"
30221 Except for the QUIT ACL, which does not affect the SMTP return code (see
30222 section &<<SECTQUITACL>>& above), the result of running an ACL is either
30223 &"accept"& or &"deny"&, or, if some test cannot be completed (for example, if a
30224 database is down), &"defer"&. These results cause 2&'xx'&, 5&'xx'&, and 4&'xx'&
30225 return codes, respectively, to be used in the SMTP dialogue. A fourth return,
30226 &"error"&, occurs when there is an error such as invalid syntax in the ACL.
30227 This also causes a 4&'xx'& return code.
30228
30229 For the non-SMTP ACL, &"defer"& and &"error"& are treated in the same way as
30230 &"deny"&, because there is no mechanism for passing temporary errors to the
30231 submitters of non-SMTP messages.
30232
30233
30234 ACLs that are relevant to message reception may also return &"discard"&. This
30235 has the effect of &"accept"&, but causes either the entire message or an
30236 individual recipient address to be discarded. In other words, it is a
30237 blackholing facility. Use it with care.
30238
30239 If the ACL for MAIL returns &"discard"&, all recipients are discarded, and no
30240 ACL is run for subsequent RCPT commands. The effect of &"discard"& in a
30241 RCPT ACL is to discard just the one recipient address. If there are no
30242 recipients left when the message's data is received, the DATA ACL is not
30243 run. A &"discard"& return from the DATA or the non-SMTP ACL discards all the
30244 remaining recipients. The &"discard"& return is not permitted for the
30245 &%acl_smtp_predata%& ACL.
30246
30247 If the ACL for VRFY returns &"accept"&, a recipient verify (without callout)
30248 is done on the address and the result determines the SMTP response.
30249
30250
30251 .cindex "&[local_scan()]& function" "when all recipients discarded"
30252 The &[local_scan()]& function is always run, even if there are no remaining
30253 recipients; it may create new recipients.
30254
30255
30256
30257 .section "Unset ACL options" "SECID197"
30258 .cindex "&ACL;" "unset options"
30259 The default actions when any of the &%acl_%&&'xxx'& options are unset are not
30260 all the same. &*Note*&: These defaults apply only when the relevant ACL is
30261 not defined at all. For any defined ACL, the default action when control
30262 reaches the end of the ACL statements is &"deny"&.
30263
30264 For &%acl_smtp_quit%& and &%acl_not_smtp_start%& there is no default because
30265 these two are ACLs that are used only for their side effects. They cannot be
30266 used to accept or reject anything.
30267
30268 For &%acl_not_smtp%&, &%acl_smtp_auth%&, &%acl_smtp_connect%&,
30269 &%acl_smtp_data%&, &%acl_smtp_helo%&, &%acl_smtp_mail%&, &%acl_smtp_mailauth%&,
30270 &%acl_smtp_mime%&, &%acl_smtp_predata%&, and &%acl_smtp_starttls%&, the action
30271 when the ACL is not defined is &"accept"&.
30272
30273 For the others (&%acl_smtp_etrn%&, &%acl_smtp_expn%&, &%acl_smtp_rcpt%&, and
30274 &%acl_smtp_vrfy%&), the action when the ACL is not defined is &"deny"&.
30275 This means that &%acl_smtp_rcpt%& must be defined in order to receive any
30276 messages over an SMTP connection. For an example, see the ACL in the default
30277 configuration file.
30278
30279
30280
30281
30282 .section "Data for message ACLs" "SECID198"
30283 .cindex "&ACL;" "data for message ACL"
30284 .vindex &$domain$&
30285 .vindex &$local_part$&
30286 .vindex &$sender_address$&
30287 .vindex &$sender_host_address$&
30288 .vindex &$smtp_command$&
30289 When a MAIL or RCPT ACL, or either of the DATA ACLs, is running, the variables
30290 that contain information about the host and the message's sender (for example,
30291 &$sender_host_address$& and &$sender_address$&) are set, and can be used in ACL
30292 statements. In the case of RCPT (but not MAIL or DATA), &$domain$& and
30293 &$local_part$& are set from the argument address. The entire SMTP command
30294 is available in &$smtp_command$&.
30295
30296 When an ACL for the AUTH parameter of MAIL is running, the variables that
30297 contain information about the host are set, but &$sender_address$& is not yet
30298 set. Section &<<SECTauthparamail>>& contains a discussion of this parameter and
30299 how it is used.
30300
30301 .vindex "&$message_size$&"
30302 The &$message_size$& variable is set to the value of the SIZE parameter on
30303 the MAIL command at MAIL, RCPT and pre-data time, or to -1 if
30304 that parameter is not given. The value is updated to the true message size by
30305 the time the final DATA ACL is run (after the message data has been
30306 received).
30307
30308 .vindex "&$rcpt_count$&"
30309 .vindex "&$recipients_count$&"
30310 The &$rcpt_count$& variable increases by one for each RCPT command received.
30311 The &$recipients_count$& variable increases by one each time a RCPT command is
30312 accepted, so while an ACL for RCPT is being processed, it contains the number
30313 of previously accepted recipients. At DATA time (for both the DATA ACLs),
30314 &$rcpt_count$& contains the total number of RCPT commands, and
30315 &$recipients_count$& contains the total number of accepted recipients.
30316
30317
30318
30319
30320
30321 .section "Data for non-message ACLs" "SECTdatfornon"
30322 .cindex "&ACL;" "data for non-message ACL"
30323 .vindex &$smtp_command_argument$&
30324 .vindex &$smtp_command$&
30325 When an ACL is being run for AUTH, EHLO, ETRN, EXPN, HELO, STARTTLS, or VRFY,
30326 the remainder of the SMTP command line is placed in &$smtp_command_argument$&,
30327 and the entire SMTP command is available in &$smtp_command$&.
30328 These variables can be tested using a &%condition%& condition. For example,
30329 here is an ACL for use with AUTH, which insists that either the session is
30330 encrypted, or the CRAM-MD5 authentication method is used. In other words, it
30331 does not permit authentication methods that use cleartext passwords on
30332 unencrypted connections.
30333 .code
30334 acl_check_auth:
30335   accept encrypted = *
30336   accept condition = ${if eq{${uc:$smtp_command_argument}}\
30337                      {CRAM-MD5}}
30338   deny   message   = TLS encryption or CRAM-MD5 required
30339 .endd
30340 (Another way of applying this restriction is to arrange for the authenticators
30341 that use cleartext passwords not to be advertised when the connection is not
30342 encrypted. You can use the generic &%server_advertise_condition%& authenticator
30343 option to do this.)
30344
30345
30346
30347 .section "Format of an ACL" "SECID199"
30348 .cindex "&ACL;" "format of"
30349 .cindex "&ACL;" "verbs, definition of"
30350 An individual ACL consists of a number of statements. Each statement starts
30351 with a verb, optionally followed by a number of conditions and &"modifiers"&.
30352 Modifiers can change the way the verb operates, define error and log messages,
30353 set variables, insert delays, and vary the processing of accepted messages.
30354
30355 If all the conditions are met, the verb is obeyed. The same condition may be
30356 used (with different arguments) more than once in the same statement. This
30357 provides a means of specifying an &"and"& conjunction between conditions. For
30358 example:
30359 .code
30360 deny  dnslists = list1.example
30361       dnslists = list2.example
30362 .endd
30363 If there are no conditions, the verb is always obeyed. Exim stops evaluating
30364 the conditions and modifiers when it reaches a condition that fails. What
30365 happens then depends on the verb (and in one case, on a special modifier). Not
30366 all the conditions make sense at every testing point. For example, you cannot
30367 test a sender address in the ACL that is run for a VRFY command.
30368
30369
30370 .section "ACL verbs" "SECID200"
30371 The ACL verbs are as follows:
30372
30373 .ilist
30374 .cindex "&%accept%& ACL verb"
30375 &%accept%&: If all the conditions are met, the ACL returns &"accept"&. If any
30376 of the conditions are not met, what happens depends on whether &%endpass%&
30377 appears among the conditions (for syntax see below). If the failing condition
30378 is before &%endpass%&, control is passed to the next ACL statement; if it is
30379 after &%endpass%&, the ACL returns &"deny"&. Consider this statement, used to
30380 check a RCPT command:
30381 .code
30382 accept domains = +local_domains
30383        endpass
30384        verify = recipient
30385 .endd
30386 If the recipient domain does not match the &%domains%& condition, control
30387 passes to the next statement. If it does match, the recipient is verified, and
30388 the command is accepted if verification succeeds. However, if verification
30389 fails, the ACL yields &"deny"&, because the failing condition is after
30390 &%endpass%&.
30391
30392 The &%endpass%& feature has turned out to be confusing to many people, so its
30393 use is not recommended nowadays. It is always possible to rewrite an ACL so
30394 that &%endpass%& is not needed, and it is no longer used in the default
30395 configuration.
30396
30397 .cindex "&%message%& ACL modifier" "with &%accept%&"
30398 If a &%message%& modifier appears on an &%accept%& statement, its action
30399 depends on whether or not &%endpass%& is present. In the absence of &%endpass%&
30400 (when an &%accept%& verb either accepts or passes control to the next
30401 statement), &%message%& can be used to vary the message that is sent when an
30402 SMTP command is accepted. For example, in a RCPT ACL you could have:
30403 .display
30404 &`accept  `&<&'some conditions'&>
30405 &`        message = OK, I will allow you through today`&
30406 .endd
30407 You can specify an SMTP response code, optionally followed by an &"extended
30408 response code"& at the start of the message, but the first digit must be the
30409 same as would be sent by default, which is 2 for an &%accept%& verb.
30410
30411 If &%endpass%& is present in an &%accept%& statement, &%message%& specifies
30412 an error message that is used when access is denied. This behaviour is retained
30413 for backward compatibility, but current &"best practice"& is to avoid the use
30414 of &%endpass%&.
30415
30416
30417 .next
30418 .cindex "&%defer%& ACL verb"
30419 &%defer%&: If all the conditions are true, the ACL returns &"defer"& which, in
30420 an SMTP session, causes a 4&'xx'& response to be given. For a non-SMTP ACL,
30421 &%defer%& is the same as &%deny%&, because there is no way of sending a
30422 temporary error. For a RCPT command, &%defer%& is much the same as using a
30423 &(redirect)& router and &`:defer:`& while verifying, but the &%defer%& verb can
30424 be used in any ACL, and even for a recipient it might be a simpler approach.
30425
30426
30427 .next
30428 .cindex "&%deny%& ACL verb"
30429 &%deny%&: If all the conditions are met, the ACL returns &"deny"&. If any of
30430 the conditions are not met, control is passed to the next ACL statement. For
30431 example,
30432 .code
30433 deny dnslists = blackholes.mail-abuse.org
30434 .endd
30435 rejects commands from hosts that are on a DNS black list.
30436
30437
30438 .next
30439 .cindex "&%discard%& ACL verb"
30440 &%discard%&: This verb behaves like &%accept%&, except that it returns
30441 &"discard"& from the ACL instead of &"accept"&. It is permitted only on ACLs
30442 that are concerned with receiving messages. When all the conditions are true,
30443 the sending entity receives a &"success"& response. However, &%discard%& causes
30444 recipients to be discarded. If it is used in an ACL for RCPT, just the one
30445 recipient is discarded; if used for MAIL, DATA or in the non-SMTP ACL, all the
30446 message's recipients are discarded. Recipients that are discarded before DATA
30447 do not appear in the log line when the &%received_recipients%& log selector is set.
30448
30449 If the &%log_message%& modifier is set when &%discard%& operates,
30450 its contents are added to the line that is automatically written to the log.
30451 The &%message%& modifier operates exactly as it does for &%accept%&.
30452
30453
30454 .next
30455 .cindex "&%drop%& ACL verb"
30456 &%drop%&: This verb behaves like &%deny%&, except that an SMTP connection is
30457 forcibly closed after the 5&'xx'& error message has been sent. For example:
30458 .code
30459 drop   condition = ${if > {$rcpt_count}{20}}
30460        message   = I don't take more than 20 RCPTs
30461 .endd
30462 There is no difference between &%deny%& and &%drop%& for the connect-time ACL.
30463 The connection is always dropped after sending a 550 response.
30464
30465 .next
30466 .cindex "&%require%& ACL verb"
30467 &%require%&: If all the conditions are met, control is passed to the next ACL
30468 statement. If any of the conditions are not met, the ACL returns &"deny"&. For
30469 example, when checking a RCPT command,
30470 .code
30471 require message = Sender did not verify
30472         verify  = sender
30473 .endd
30474 passes control to subsequent statements only if the message's sender can be
30475 verified. Otherwise, it rejects the command. Note the positioning of the
30476 &%message%& modifier, before the &%verify%& condition. The reason for this is
30477 discussed in section &<<SECTcondmodproc>>&.
30478
30479 .next
30480 .cindex "&%warn%& ACL verb"
30481 &%warn%&: If all the conditions are true, a line specified by the
30482 &%log_message%& modifier is written to Exim's main log. Control always passes
30483 to the next ACL statement. If any condition is false, the log line is not
30484 written. If an identical log line is requested several times in the same
30485 message, only one copy is actually written to the log. If you want to force
30486 duplicates to be written, use the &%logwrite%& modifier instead.
30487
30488 If &%log_message%& is not present, a &%warn%& verb just checks its conditions
30489 and obeys any &"immediate"& modifiers (such as &%control%&, &%set%&,
30490 &%logwrite%&, &%add_header%&, and &%remove_header%&) that appear before the
30491 first failing condition. There is more about adding header lines in section
30492 &<<SECTaddheadacl>>&.
30493
30494 If any condition on a &%warn%& statement cannot be completed (that is, there is
30495 some sort of defer), the log line specified by &%log_message%& is not written.
30496 This does not include the case of a forced failure from a lookup, which
30497 is considered to be a successful completion. After a defer, no further
30498 conditions or modifiers in the &%warn%& statement are processed. The incident
30499 is logged, and the ACL continues to be processed, from the next statement
30500 onwards.
30501
30502
30503 .vindex "&$acl_verify_message$&"
30504 When one of the &%warn%& conditions is an address verification that fails, the
30505 text of the verification failure message is in &$acl_verify_message$&. If you
30506 want this logged, you must set it up explicitly. For example:
30507 .code
30508 warn   !verify = sender
30509        log_message = sender verify failed: $acl_verify_message
30510 .endd
30511 .endlist
30512
30513 At the end of each ACL there is an implicit unconditional &%deny%&.
30514
30515 As you can see from the examples above, the conditions and modifiers are
30516 written one to a line, with the first one on the same line as the verb, and
30517 subsequent ones on following lines. If you have a very long condition, you can
30518 continue it onto several physical lines by the usual backslash continuation
30519 mechanism. It is conventional to align the conditions vertically.
30520
30521
30522
30523 .section "ACL variables" "SECTaclvariables"
30524 .cindex "&ACL;" "variables"
30525 There are some special variables that can be set during ACL processing. They
30526 can be used to pass information between different ACLs, different invocations
30527 of the same ACL in the same SMTP connection, and between ACLs and the routers,
30528 transports, and filters that are used to deliver a message. The names of these
30529 variables must begin with &$acl_c$& or &$acl_m$&, followed either by a digit or
30530 an underscore, but the remainder of the name can be any sequence of
30531 alphanumeric characters and underscores that you choose. There is no limit on
30532 the number of ACL variables. The two sets act as follows:
30533 .ilist
30534 The values of those variables whose names begin with &$acl_c$& persist
30535 throughout an SMTP connection. They are never reset. Thus, a value that is set
30536 while receiving one message is still available when receiving the next message
30537 on the same SMTP connection.
30538 .next
30539 The values of those variables whose names begin with &$acl_m$& persist only
30540 while a message is being received. They are reset afterwards. They are also
30541 reset by MAIL, RSET, EHLO, HELO, and after starting up a TLS session.
30542 .endlist
30543
30544 When a message is accepted, the current values of all the ACL variables are
30545 preserved with the message and are subsequently made available at delivery
30546 time. The ACL variables are set by a modifier called &%set%&. For example:
30547 .code
30548 accept hosts = whatever
30549        set acl_m4 = some value
30550 accept authenticated = *
30551        set acl_c_auth = yes
30552 .endd
30553 &*Note*&: A leading dollar sign is not used when naming a variable that is to
30554 be set. If you want to set a variable without taking any action, you can use a
30555 &%warn%& verb without any other modifiers or conditions.
30556
30557 .oindex &%strict_acl_vars%&
30558 What happens if a syntactically valid but undefined ACL variable is
30559 referenced depends on the setting of the &%strict_acl_vars%& option. If it is
30560 false (the default), an empty string is substituted; if it is true, an
30561 error is generated.
30562
30563 Versions of Exim before 4.64 have a limited set of numbered variables, but
30564 their names are compatible, so there is no problem with upgrading.
30565
30566
30567 .section "Condition and modifier processing" "SECTcondmodproc"
30568 .cindex "&ACL;" "conditions; processing"
30569 .cindex "&ACL;" "modifiers; processing"
30570 An exclamation mark preceding a condition negates its result. For example:
30571 .code
30572 deny   domains = *.dom.example
30573       !verify  = recipient
30574 .endd
30575 causes the ACL to return &"deny"& if the recipient domain ends in
30576 &'dom.example'& and the recipient address cannot be verified. Sometimes
30577 negation can be used on the right-hand side of a condition. For example, these
30578 two statements are equivalent:
30579 .code
30580 deny  hosts = !192.168.3.4
30581 deny !hosts =  192.168.3.4
30582 .endd
30583 However, for many conditions (&%verify%& being a good example), only left-hand
30584 side negation of the whole condition is possible.
30585
30586 The arguments of conditions and modifiers are expanded. A forced failure
30587 of an expansion causes a condition to be ignored, that is, it behaves as if the
30588 condition is true. Consider these two statements:
30589 .code
30590 accept  senders = ${lookup{$host_name}lsearch\
30591                   {/some/file}{$value}fail}
30592 accept  senders = ${lookup{$host_name}lsearch\
30593                   {/some/file}{$value}{}}
30594 .endd
30595 Each attempts to look up a list of acceptable senders. If the lookup succeeds,
30596 the returned list is searched, but if the lookup fails the behaviour is
30597 different in the two cases. The &%fail%& in the first statement causes the
30598 condition to be ignored, leaving no further conditions. The &%accept%& verb
30599 therefore succeeds. The second statement, however, generates an empty list when
30600 the lookup fails. No sender can match an empty list, so the condition fails,
30601 and therefore the &%accept%& also fails.
30602
30603 ACL modifiers appear mixed in with conditions in ACL statements. Some of them
30604 specify actions that are taken as the conditions for a statement are checked;
30605 others specify text for messages that are used when access is denied or a
30606 warning is generated. The &%control%& modifier affects the way an incoming
30607 message is handled.
30608
30609 The positioning of the modifiers in an ACL statement is important, because the
30610 processing of a verb ceases as soon as its outcome is known. Only those
30611 modifiers that have already been encountered will take effect. For example,
30612 consider this use of the &%message%& modifier:
30613 .code
30614 require message = Can't verify sender
30615         verify  = sender
30616         message = Can't verify recipient
30617         verify  = recipient
30618         message = This message cannot be used
30619 .endd
30620 If sender verification fails, Exim knows that the result of the statement is
30621 &"deny"&, so it goes no further. The first &%message%& modifier has been seen,
30622 so its text is used as the error message. If sender verification succeeds, but
30623 recipient verification fails, the second message is used. If recipient
30624 verification succeeds, the third message becomes &"current"&, but is never used
30625 because there are no more conditions to cause failure.
30626
30627 For the &%deny%& verb, on the other hand, it is always the last &%message%&
30628 modifier that is used, because all the conditions must be true for rejection to
30629 happen. Specifying more than one &%message%& modifier does not make sense, and
30630 the message can even be specified after all the conditions. For example:
30631 .code
30632 deny   hosts = ...
30633       !senders = *@my.domain.example
30634        message = Invalid sender from client host
30635 .endd
30636 The &"deny"& result does not happen until the end of the statement is reached,
30637 by which time Exim has set up the message.
30638
30639
30640
30641 .section "ACL modifiers" "SECTACLmodi"
30642 .cindex "&ACL;" "modifiers; list of"
30643 The ACL modifiers are as follows:
30644
30645 .vlist
30646 .vitem &*add_header*&&~=&~<&'text'&>
30647 This modifier specifies one or more header lines that are to be added to an
30648 incoming message, assuming, of course, that the message is ultimately
30649 accepted. For details, see section &<<SECTaddheadacl>>&.
30650
30651 .vitem &*continue*&&~=&~<&'text'&>
30652 .cindex "&%continue%& ACL modifier"
30653 .cindex "database" "updating in ACL"
30654 This modifier does nothing of itself, and processing of the ACL always
30655 continues with the next condition or modifier. The value of &%continue%& is in
30656 the side effects of expanding its argument. Typically this could be used to
30657 update a database. It is really just a syntactic tidiness, to avoid having to
30658 write rather ugly lines like this:
30659 .display
30660 &`condition = ${if eq{0}{`&<&'some expansion'&>&`}{true}{true}}`&
30661 .endd
30662 Instead, all you need is
30663 .display
30664 &`continue = `&<&'some expansion'&>
30665 .endd
30666
30667 .vitem &*control*&&~=&~<&'text'&>
30668 .cindex "&%control%& ACL modifier"
30669 This modifier affects the subsequent processing of the SMTP connection or of an
30670 incoming message that is accepted. The effect of the first type of control
30671 lasts for the duration of the connection, whereas the effect of the second type
30672 lasts only until the current message has been received. The message-specific
30673 controls always apply to the whole message, not to individual recipients,
30674 even if the &%control%& modifier appears in a RCPT ACL.
30675
30676 As there are now quite a few controls that can be applied, they are described
30677 separately in section &<<SECTcontrols>>&. The &%control%& modifier can be used
30678 in several different ways. For example:
30679
30680 . ==== As this is a nested list, any displays it contains must be indented
30681 . ==== as otherwise they are too far to the left. That comment applies only
30682 . ==== when xmlto and fop are used; formatting with sdop gets it right either
30683 . ==== way.
30684
30685 .ilist
30686 It can be at the end of an &%accept%& statement:
30687 .code
30688     accept  ...some conditions
30689             control = queue
30690 .endd
30691 In this case, the control is applied when this statement yields &"accept"&, in
30692 other words, when the conditions are all true.
30693
30694 .next
30695 It can be in the middle of an &%accept%& statement:
30696 .code
30697     accept  ...some conditions...
30698             control = queue
30699             ...some more conditions...
30700 .endd
30701 If the first set of conditions are true, the control is applied, even if the
30702 statement does not accept because one of the second set of conditions is false.
30703 In this case, some subsequent statement must yield &"accept"& for the control
30704 to be relevant.
30705
30706 .next
30707 It can be used with &%warn%& to apply the control, leaving the
30708 decision about accepting or denying to a subsequent verb. For
30709 example:
30710 .code
30711     warn    ...some conditions...
30712             control = freeze
30713     accept  ...
30714 .endd
30715 This example of &%warn%& does not contain &%message%&, &%log_message%&, or
30716 &%logwrite%&, so it does not add anything to the message and does not write a
30717 log entry.
30718
30719 .next
30720 If you want to apply a control unconditionally, you can use it with a
30721 &%require%& verb. For example:
30722 .code
30723     require  control = no_multiline_responses
30724 .endd
30725 .endlist
30726
30727 .vitem &*delay*&&~=&~<&'time'&>
30728 .cindex "&%delay%& ACL modifier"
30729 .oindex "&%-bh%&"
30730 This modifier may appear in any ACL except notquit. It causes Exim to wait for
30731 the time interval before proceeding. However, when testing Exim using the
30732 &%-bh%& option, the delay is not actually imposed (an appropriate message is
30733 output instead). The time is given in the usual Exim notation, and the delay
30734 happens as soon as the modifier is processed. In an SMTP session, pending
30735 output is flushed before the delay is imposed.
30736
30737 Like &%control%&, &%delay%& can be used with &%accept%& or &%deny%&, for
30738 example:
30739 .code
30740 deny    ...some conditions...
30741         delay = 30s
30742 .endd
30743 The delay happens if all the conditions are true, before the statement returns
30744 &"deny"&. Compare this with:
30745 .code
30746 deny    delay = 30s
30747         ...some conditions...
30748 .endd
30749 which waits for 30s before processing the conditions. The &%delay%& modifier
30750 can also be used with &%warn%& and together with &%control%&:
30751 .code
30752 warn    ...some conditions...
30753         delay = 2m
30754         control = freeze
30755 accept  ...
30756 .endd
30757
30758 If &%delay%& is encountered when the SMTP PIPELINING extension is in use,
30759 responses to several commands are no longer buffered and sent in one packet (as
30760 they would normally be) because all output is flushed before imposing the
30761 delay. This optimization is disabled so that a number of small delays do not
30762 appear to the client as one large aggregated delay that might provoke an
30763 unwanted timeout. You can, however, disable output flushing for &%delay%& by
30764 using a &%control%& modifier to set &%no_delay_flush%&.
30765
30766
30767 .vitem &*endpass*&
30768 .cindex "&%endpass%& ACL modifier"
30769 This modifier, which has no argument, is recognized only in &%accept%& and
30770 &%discard%& statements. It marks the boundary between the conditions whose
30771 failure causes control to pass to the next statement, and the conditions whose
30772 failure causes the ACL to return &"deny"&. This concept has proved to be
30773 confusing to some people, so the use of &%endpass%& is no longer recommended as
30774 &"best practice"&. See the description of &%accept%& above for more details.
30775
30776
30777 .vitem &*log_message*&&~=&~<&'text'&>
30778 .cindex "&%log_message%& ACL modifier"
30779 This modifier sets up a message that is used as part of the log message if the
30780 ACL denies access or a &%warn%& statement's conditions are true. For example:
30781 .code
30782 require log_message = wrong cipher suite $tls_in_cipher
30783         encrypted   = DES-CBC3-SHA
30784 .endd
30785 &%log_message%& is also used when recipients are discarded by &%discard%&. For
30786 example:
30787 .display
30788 &`discard `&<&'some conditions'&>
30789 &`        log_message = Discarded $local_part@$domain because...`&
30790 .endd
30791 When access is denied, &%log_message%& adds to any underlying error message
30792 that may exist because of a condition failure. For example, while verifying a
30793 recipient address, a &':fail:'& redirection might have already set up a
30794 message.
30795
30796 The message may be defined before the conditions to which it applies, because
30797 the string expansion does not happen until Exim decides that access is to be
30798 denied. This means that any variables that are set by the condition are
30799 available for inclusion in the message. For example, the &$dnslist_$&<&'xxx'&>
30800 variables are set after a DNS black list lookup succeeds. If the expansion of
30801 &%log_message%& fails, or if the result is an empty string, the modifier is
30802 ignored.
30803
30804 .vindex "&$acl_verify_message$&"
30805 If you want to use a &%warn%& statement to log the result of an address
30806 verification, you can use &$acl_verify_message$& to include the verification
30807 error message.
30808
30809 If &%log_message%& is used with a &%warn%& statement, &"Warning:"& is added to
30810 the start of the logged message. If the same warning log message is requested
30811 more than once while receiving  a single email message, only one copy is
30812 actually logged. If you want to log multiple copies, use &%logwrite%& instead
30813 of &%log_message%&. In the absence of &%log_message%& and &%logwrite%&, nothing
30814 is logged for a successful &%warn%& statement.
30815
30816 If &%log_message%& is not present and there is no underlying error message (for
30817 example, from the failure of address verification), but &%message%& is present,
30818 the &%message%& text is used for logging rejections. However, if any text for
30819 logging contains newlines, only the first line is logged. In the absence of
30820 both &%log_message%& and &%message%&, a default built-in message is used for
30821 logging rejections.
30822
30823
30824 .vitem "&*log_reject_target*&&~=&~<&'log name list'&>"
30825 .cindex "&%log_reject_target%& ACL modifier"
30826 .cindex "logging in ACL" "specifying which log"
30827 This modifier makes it possible to specify which logs are used for messages
30828 about ACL rejections. Its argument is a colon-separated list of words that can
30829 be &"main"&, &"reject"&, or &"panic"&. The default is &`main:reject`&. The list
30830 may be empty, in which case a rejection is not logged at all. For example, this
30831 ACL fragment writes no logging information when access is denied:
30832 .display
30833 &`deny `&<&'some conditions'&>
30834 &`     log_reject_target =`&
30835 .endd
30836 This modifier can be used in SMTP and non-SMTP ACLs. It applies to both
30837 permanent and temporary rejections. Its effect lasts for the rest of the
30838 current ACL.
30839
30840
30841 .vitem &*logwrite*&&~=&~<&'text'&>
30842 .cindex "&%logwrite%& ACL modifier"
30843 .cindex "logging in ACL" "immediate"
30844 This modifier writes a message to a log file as soon as it is encountered when
30845 processing an ACL. (Compare &%log_message%&, which, except in the case of
30846 &%warn%& and &%discard%&, is used only if the ACL statement denies
30847 access.) The &%logwrite%& modifier can be used to log special incidents in
30848 ACLs. For example:
30849 .display
30850 &`accept `&<&'some special conditions'&>
30851 &`       control  = freeze`&
30852 &`       logwrite = froze message because ...`&
30853 .endd
30854 By default, the message is written to the main log. However, it may begin
30855 with a colon, followed by a comma-separated list of log names, and then
30856 another colon, to specify exactly which logs are to be written. For
30857 example:
30858 .code
30859 logwrite = :main,reject: text for main and reject logs
30860 logwrite = :panic: text for panic log only
30861 .endd
30862
30863
30864 .vitem &*message*&&~=&~<&'text'&>
30865 .cindex "&%message%& ACL modifier"
30866 This modifier sets up a text string that is expanded and used as a response
30867 message when an ACL statement terminates the ACL with an &"accept"&, &"deny"&,
30868 or &"defer"& response. (In the case of the &%accept%& and &%discard%& verbs,
30869 there is some complication if &%endpass%& is involved; see the description of
30870 &%accept%& for details.)
30871
30872 The expansion of the message happens at the time Exim decides that the ACL is
30873 to end, not at the time it processes &%message%&. If the expansion fails, or
30874 generates an empty string, the modifier is ignored. Here is an example where
30875 &%message%& must be specified first, because the ACL ends with a rejection if
30876 the &%hosts%& condition fails:
30877 .code
30878 require  message = Host not recognized
30879          hosts = 10.0.0.0/8
30880 .endd
30881 (Once a condition has failed, no further conditions or modifiers are
30882 processed.)
30883
30884 .cindex "SMTP" "error codes"
30885 .oindex "&%smtp_banner%&
30886 For ACLs that are triggered by SMTP commands, the message is returned as part
30887 of the SMTP response. The use of &%message%& with &%accept%& (or &%discard%&)
30888 is meaningful only for SMTP, as no message is returned when a non-SMTP message
30889 is accepted. In the case of the connect ACL, accepting with a message modifier
30890 overrides the value of &%smtp_banner%&. For the EHLO/HELO ACL, a customized
30891 accept message may not contain more than one line (otherwise it will be
30892 truncated at the first newline and a panic logged), and it cannot affect the
30893 EHLO options.
30894
30895 When SMTP is involved, the message may begin with an overriding response code,
30896 consisting of three digits optionally followed by an &"extended response code"&
30897 of the form &'n.n.n'&, each code being followed by a space. For example:
30898 .code
30899 deny  message = 599 1.2.3 Host not welcome
30900       hosts = 192.168.34.0/24
30901 .endd
30902 The first digit of the supplied response code must be the same as would be sent
30903 by default. A panic occurs if it is not. Exim uses a 550 code when it denies
30904 access, but for the predata ACL, note that the default success code is 354, not
30905 2&'xx'&.
30906
30907 Notwithstanding the previous paragraph, for the QUIT ACL, unlike the others,
30908 the message modifier cannot override the 221 response code.
30909
30910 The text in a &%message%& modifier is literal; any quotes are taken as
30911 literals, but because the string is expanded, backslash escapes are processed
30912 anyway. If the message contains newlines, this gives rise to a multi-line SMTP
30913 response.
30914
30915 .vindex "&$acl_verify_message$&"
30916 For ACLs that are called by an &%acl =%& ACL condition, the message is
30917 stored in &$acl_verify_message$&, from which the calling ACL may use it.
30918
30919 If &%message%& is used on a statement that verifies an address, the message
30920 specified overrides any message that is generated by the verification process.
30921 However, the original message is available in the variable
30922 &$acl_verify_message$&, so you can incorporate it into your message if you
30923 wish. In particular, if you want the text from &%:fail:%& items in &(redirect)&
30924 routers to be passed back as part of the SMTP response, you should either not
30925 use a &%message%& modifier, or make use of &$acl_verify_message$&.
30926
30927 For compatibility with previous releases of Exim, a &%message%& modifier that
30928 is used with a &%warn%& verb behaves in a similar way to the &%add_header%&
30929 modifier, but this usage is now deprecated. However, &%message%& acts only when
30930 all the conditions are true, wherever it appears in an ACL command, whereas
30931 &%add_header%& acts as soon as it is encountered. If &%message%& is used with
30932 &%warn%& in an ACL that is not concerned with receiving a message, it has no
30933 effect.
30934
30935
30936 .vitem &*queue*&&~=&~<&'text'&>
30937 .cindex "&%queue%& ACL modifier"
30938 .cindex "named queues" "selecting in ACL"
30939 This modifier specifies the use of a named queue for spool files
30940 for the message.
30941 It can only be used before the message is received (i.e. not in
30942 the DATA ACL).
30943 This could be used, for example, for known high-volume burst sources
30944 of traffic, or for quarantine of messages.
30945 Separate queue-runner processes will be needed for named queues.
30946 If the text after expansion is empty, the default queue is used.
30947
30948
30949 .vitem &*remove_header*&&~=&~<&'text'&>
30950 This modifier specifies one or more header names in a colon-separated list
30951  that are to be removed from an incoming message, assuming, of course, that
30952 the message is ultimately accepted. For details, see section &<<SECTremoveheadacl>>&.
30953
30954
30955 .vitem &*set*&&~<&'acl_name'&>&~=&~<&'value'&>
30956 .cindex "&%set%& ACL modifier"
30957 This modifier puts a value into one of the ACL variables (see section
30958 &<<SECTaclvariables>>&).
30959
30960
30961 .vitem &*udpsend*&&~=&~<&'parameters'&>
30962 .cindex "UDP communications"
30963 This modifier sends a UDP packet, for purposes such as statistics
30964 collection or behaviour monitoring. The parameters are expanded, and
30965 the result of the expansion must be a colon-separated list consisting
30966 of a destination server, port number, and the packet contents. The
30967 server can be specified as a host name or IPv4 or IPv6 address. The
30968 separator can be changed with the usual angle bracket syntax. For
30969 example, you might want to collect information on which hosts connect
30970 when:
30971 .code
30972 udpsend = <; 2001:dB8::dead:beef ; 1234 ;\
30973              $tod_zulu $sender_host_address
30974 .endd
30975 .endlist
30976
30977
30978
30979
30980 .section "Use of the control modifier" "SECTcontrols"
30981 .cindex "&%control%& ACL modifier"
30982 The &%control%& modifier supports the following settings:
30983
30984 .vlist
30985 .vitem &*control&~=&~allow_auth_unadvertised*&
30986 This modifier allows a client host to use the SMTP AUTH command even when it
30987 has not been advertised in response to EHLO. Furthermore, because there are
30988 apparently some really broken clients that do this, Exim will accept AUTH after
30989 HELO (rather than EHLO) when this control is set. It should be used only if you
30990 really need it, and you should limit its use to those broken clients that do
30991 not work without it. For example:
30992 .code
30993 warn hosts   = 192.168.34.25
30994      control = allow_auth_unadvertised
30995 .endd
30996 Normally, when an Exim server receives an AUTH command, it checks the name of
30997 the authentication mechanism that is given in the command to ensure that it
30998 matches an advertised mechanism. When this control is set, the check that a
30999 mechanism has been advertised is bypassed. Any configured mechanism can be used
31000 by the client. This control is permitted only in the connection and HELO ACLs.
31001
31002
31003 .vitem &*control&~=&~caseful_local_part*& &&&
31004        &*control&~=&~caselower_local_part*&
31005 .cindex "&ACL;" "case of local part in"
31006 .cindex "case of local parts"
31007 .vindex "&$local_part$&"
31008 These two controls are permitted only in the ACL specified by &%acl_smtp_rcpt%&
31009 (that is, during RCPT processing). By default, the contents of &$local_part$&
31010 are lower cased before ACL processing. If &"caseful_local_part"& is specified,
31011 any uppercase letters in the original local part are restored in &$local_part$&
31012 for the rest of the ACL, or until a control that sets &"caselower_local_part"&
31013 is encountered.
31014
31015 These controls affect only the current recipient. Moreover, they apply only to
31016 local part handling that takes place directly in the ACL (for example, as a key
31017 in lookups). If a test to verify the recipient is obeyed, the case-related
31018 handling of the local part during the verification is controlled by the router
31019 configuration (see the &%caseful_local_part%& generic router option).
31020
31021 This facility could be used, for example, to add a spam score to local parts
31022 containing upper case letters. For example, using &$acl_m4$& to accumulate the
31023 spam score:
31024 .code
31025 warn  control = caseful_local_part
31026       set acl_m4 = ${eval:\
31027                      $acl_m4 + \
31028                      ${if match{$local_part}{[A-Z]}{1}{0}}\
31029                     }
31030       control = caselower_local_part
31031 .endd
31032 Notice that we put back the lower cased version afterwards, assuming that
31033 is what is wanted for subsequent tests.
31034
31035
31036 .vitem &*control&~=&~cutthrough_delivery/*&<&'options'&>
31037 .cindex "&ACL;" "cutthrough routing"
31038 .cindex "cutthrough" "requesting"
31039 This option requests delivery be attempted while the item is being received.
31040
31041 The option is usable in the RCPT ACL.
31042 If enabled for a message received via smtp and routed to an smtp transport,
31043 and only one transport, interface, destination host and port combination
31044 is used for all recipients of the message,
31045 then the delivery connection is made while the receiving connection is open
31046 and data is copied from one to the other.
31047
31048 An attempt to set this option for any recipient but the first
31049 for a mail will be quietly ignored.
31050 If a recipient-verify callout
31051 (with use_sender)
31052 connection is subsequently
31053 requested in the same ACL it is held open and used for
31054 any subsequent recipients and the data,
31055 otherwise one is made after the initial RCPT ACL completes.
31056
31057 Note that routers are used in verify mode,
31058 and cannot depend on content of received headers.
31059 Note also that headers cannot be
31060 modified by any of the post-data ACLs (DATA, MIME and DKIM).
31061 Headers may be modified by routers (subject to the above) and transports.
31062 The &'Received-By:'& header is generated as soon as the body reception starts,
31063 rather than the traditional time after the full message is received;
31064 this will affect the timestamp.
31065
31066 All the usual ACLs are called; if one results in the message being
31067 rejected, all effort spent in delivery (including the costs on
31068 the ultimate destination) will be wasted.
31069 Note that in the case of data-time ACLs this includes the entire
31070 message body.
31071
31072 Cutthrough delivery is not supported via transport-filters or when DKIM signing
31073 of outgoing messages is done, because it sends data to the ultimate destination
31074 before the entire message has been received from the source.
31075 It is not supported for messages received with the SMTP PRDR
31076 or CHUNKING
31077 options in use.
31078
31079 Should the ultimate destination system positively accept or reject the mail,
31080 a corresponding indication is given to the source system and nothing is queued.
31081 If the item is successfully delivered in cutthrough mode
31082 the delivery log lines are tagged with ">>" rather than "=>" and appear
31083 before the acceptance "<=" line.
31084
31085 If there is a temporary error the item is queued for later delivery in the
31086 usual fashion.
31087 This behaviour can be adjusted by appending the option &*defer=*&<&'value'&>
31088 to the control; the default value is &"spool"& and the alternate value
31089 &"pass"& copies an SMTP defer response from the target back to the initiator
31090 and does not queue the message.
31091 Note that this is independent of any recipient verify conditions in the ACL.
31092
31093 Delivery in this mode avoids the generation of a bounce mail to a
31094 (possibly faked)
31095 sender when the destination system is doing content-scan based rejection.
31096
31097
31098 .vitem &*control&~=&~debug/*&<&'options'&>
31099 .cindex "&ACL;" "enabling debug logging"
31100 .cindex "debugging" "enabling from an ACL"
31101 This control turns on debug logging, almost as though Exim had been invoked
31102 with &`-d`&, with the output going to a new logfile in the usual logs directory,
31103 by default called &'debuglog'&.
31104 The filename can be adjusted with the &'tag'& option, which
31105 may access any variables already defined.  The logging may be adjusted with
31106 the &'opts'& option, which takes the same values as the &`-d`& command-line
31107 option.
31108 Logging started this way may be stopped, and the file removed,
31109 with the &'kill'& option.
31110 Some examples (which depend on variables that don't exist in all
31111 contexts):
31112 .code
31113       control = debug
31114       control = debug/tag=.$sender_host_address
31115       control = debug/opts=+expand+acl
31116       control = debug/tag=.$message_exim_id/opts=+expand
31117       control = debug/kill
31118 .endd
31119
31120
31121 .vitem &*control&~=&~dkim_disable_verify*&
31122 .cindex "disable DKIM verify"
31123 .cindex "DKIM" "disable verify"
31124 This control turns off DKIM verification processing entirely.  For details on
31125 the operation and configuration of DKIM, see section &<<SECDKIM>>&.
31126
31127
31128 .vitem &*control&~=&~dmarc_disable_verify*&
31129 .cindex "disable DMARC verify"
31130 .cindex "DMARC" "disable verify"
31131 This control turns off DMARC verification processing entirely.  For details on
31132 the operation and configuration of DMARC, see section &<<SECDMARC>>&.
31133
31134
31135 .vitem &*control&~=&~dscp/*&<&'value'&>
31136 .cindex "&ACL;" "setting DSCP value"
31137 .cindex "DSCP" "inbound"
31138 This option causes the DSCP value associated with the socket for the inbound
31139 connection to be adjusted to a given value, given as one of a number of fixed
31140 strings or to numeric value.
31141 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
31142 Common values include &`throughput`&, &`mincost`&, and on newer systems
31143 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
31144
31145 The outbound packets from Exim will be marked with this value in the header
31146 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
31147 that these values will have any effect, not be stripped by networking
31148 equipment, or do much of anything without cooperation with your Network
31149 Engineer and those of all network operators between the source and destination.
31150
31151
31152 .vitem &*control&~=&~enforce_sync*& &&&
31153        &*control&~=&~no_enforce_sync*&
31154 .cindex "SMTP" "synchronization checking"
31155 .cindex "synchronization checking in SMTP"
31156 These controls make it possible to be selective about when SMTP synchronization
31157 is enforced. The global option &%smtp_enforce_sync%& specifies the initial
31158 state of the switch (it is true by default). See the description of this option
31159 in chapter &<<CHAPmainconfig>>& for details of SMTP synchronization checking.
31160
31161 The effect of these two controls lasts for the remainder of the SMTP
31162 connection. They can appear in any ACL except the one for the non-SMTP
31163 messages. The most straightforward place to put them is in the ACL defined by
31164 &%acl_smtp_connect%&, which is run at the start of an incoming SMTP connection,
31165 before the first synchronization check. The expected use is to turn off the
31166 synchronization checks for badly-behaved hosts that you nevertheless need to
31167 work with.
31168
31169
31170 .vitem &*control&~=&~fakedefer/*&<&'message'&>
31171 .cindex "fake defer"
31172 .cindex "defer, fake"
31173 This control works in exactly the same way as &%fakereject%& (described below)
31174 except that it causes an SMTP 450 response after the message data instead of a
31175 550 response. You must take care when using &%fakedefer%& because it causes the
31176 messages to be duplicated when the sender retries. Therefore, you should not
31177 use &%fakedefer%& if the message is to be delivered normally.
31178
31179 .vitem &*control&~=&~fakereject/*&<&'message'&>
31180 .cindex "fake rejection"
31181 .cindex "rejection, fake"
31182 This control is permitted only for the MAIL, RCPT, and DATA ACLs, in other
31183 words, only when an SMTP message is being received. If Exim accepts the
31184 message, instead the final 250 response, a 550 rejection message is sent.
31185 However, Exim proceeds to deliver the message as normal. The control applies
31186 only to the current message, not to any subsequent ones that may be received in
31187 the same SMTP connection.
31188
31189 The text for the 550 response is taken from the &%control%& modifier. If no
31190 message is supplied, the following is used:
31191 .code
31192 550-Your message has been rejected but is being
31193 550-kept for evaluation.
31194 550-If it was a legitimate message, it may still be
31195 550 delivered to the target recipient(s).
31196 .endd
31197 This facility should be used with extreme caution.
31198
31199 .vitem &*control&~=&~freeze*&
31200 .cindex "frozen messages" "forcing in ACL"
31201 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
31202 other words, only when a message is being received. If the message is accepted,
31203 it is placed on Exim's queue and frozen. The control applies only to the
31204 current message, not to any subsequent ones that may be received in the same
31205 SMTP connection.
31206
31207 This modifier can optionally be followed by &`/no_tell`&. If the global option
31208 &%freeze_tell%& is set, it is ignored for the current message (that is, nobody
31209 is told about the freezing), provided all the &*control=freeze*& modifiers that
31210 are obeyed for the current message have the &`/no_tell`& option.
31211
31212 .vitem &*control&~=&~no_delay_flush*&
31213 .cindex "SMTP" "output flushing, disabling for delay"
31214 Exim normally flushes SMTP output before implementing a delay in an ACL, to
31215 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
31216 use. This control, as long as it is encountered before the &%delay%& modifier,
31217 disables such output flushing.
31218
31219 .vitem &*control&~=&~no_callout_flush*&
31220 .cindex "SMTP" "output flushing, disabling for callout"
31221 Exim normally flushes SMTP output before performing a callout in an ACL, to
31222 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
31223 use. This control, as long as it is encountered before the &%verify%& condition
31224 that causes the callout, disables such output flushing.
31225
31226 .vitem &*control&~=&~no_mbox_unspool*&
31227 This control is available when Exim is compiled with the content scanning
31228 extension. Content scanning may require a copy of the current message, or parts
31229 of it, to be written in &"mbox format"& to a spool file, for passing to a virus
31230 or spam scanner. Normally, such copies are deleted when they are no longer
31231 needed. If this control is set, the copies are not deleted. The control applies
31232 only to the current message, not to any subsequent ones that may be received in
31233 the same SMTP connection. It is provided for debugging purposes and is unlikely
31234 to be useful in production.
31235
31236 .vitem &*control&~=&~no_multiline_responses*&
31237 .cindex "multiline responses, suppressing"
31238 This control is permitted for any ACL except the one for non-SMTP messages.
31239 It seems that there are broken clients in use that cannot handle multiline
31240 SMTP responses, despite the fact that RFC 821 defined them over 20 years ago.
31241
31242 If this control is set, multiline SMTP responses from ACL rejections are
31243 suppressed. One way of doing this would have been to put out these responses as
31244 one long line. However, RFC 2821 specifies a maximum of 512 bytes per response
31245 (&"use multiline responses for more"& it says &-- ha!), and some of the
31246 responses might get close to that. So this facility, which is after all only a
31247 sop to broken clients, is implemented by doing two very easy things:
31248
31249 .ilist
31250 Extra information that is normally output as part of a rejection caused by
31251 sender verification failure is omitted. Only the final line (typically &"sender
31252 verification failed"&) is sent.
31253 .next
31254 If a &%message%& modifier supplies a multiline response, only the first
31255 line is output.
31256 .endlist
31257
31258 The setting of the switch can, of course, be made conditional on the
31259 calling host. Its effect lasts until the end of the SMTP connection.
31260
31261 .vitem &*control&~=&~no_pipelining*&
31262 .cindex "PIPELINING" "suppressing advertising"
31263 .cindex "ESMTP extensions" PIPELINING
31264 This control turns off the advertising of the PIPELINING extension to SMTP in
31265 the current session. To be useful, it must be obeyed before Exim sends its
31266 response to an EHLO command. Therefore, it should normally appear in an ACL
31267 controlled by &%acl_smtp_connect%& or &%acl_smtp_helo%&. See also
31268 &%pipelining_advertise_hosts%&.
31269
31270 .vitem &*control&~=&~queue/*&<&'options'&>* &&&
31271        &*control&~=&~queue_only*&
31272 .oindex "&%queue%&"
31273 .oindex "&%queue_only%&"
31274 .cindex "queueing incoming messages"
31275 .cindex queueing "forcing in ACL"
31276 .cindex "first pass routing"
31277 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
31278 other words, only when a message is being received. If the message is accepted,
31279 it is placed on Exim's queue and left there for delivery by a subsequent queue
31280 runner.
31281 If used with no options set,
31282 no immediate delivery process is started. In other words, it has the
31283 effect as the &%queue_only%& global option or &'-odq'& command-line option.
31284
31285 If the &'first_pass_route'& option is given then
31286 the behaviour is like the command-line &'-oqds'& option;
31287 a delivery process is started which stops short of making
31288 any SMTP delivery.  The benefit is that the hints database will be updated for
31289 the message being waiting for a specific host, and a later queue run will be
31290 able to send all such messages on a single connection.
31291
31292 The control only applies to the current message, not to any subsequent ones that
31293  may be received in the same SMTP connection.
31294
31295 .vitem &*control&~=&~submission/*&<&'options'&>
31296 .cindex "message" "submission"
31297 .cindex "submission mode"
31298 This control is permitted only for the MAIL, RCPT, and start of data ACLs (the
31299 latter is the one defined by &%acl_smtp_predata%&). Setting it tells Exim that
31300 the current message is a submission from a local MUA. In this case, Exim
31301 operates in &"submission mode"&, and applies certain fixups to the message if
31302 necessary. For example, it adds a &'Date:'& header line if one is not present.
31303 This control is not permitted in the &%acl_smtp_data%& ACL, because that is too
31304 late (the message has already been created).
31305
31306 Chapter &<<CHAPmsgproc>>& describes the processing that Exim applies to
31307 messages. Section &<<SECTsubmodnon>>& covers the processing that happens in
31308 submission mode; the available options for this control are described there.
31309 The control applies only to the current message, not to any subsequent ones
31310 that may be received in the same SMTP connection.
31311
31312 .vitem &*control&~=&~suppress_local_fixups*&
31313 .cindex "submission fixups, suppressing"
31314 This control applies to locally submitted (non TCP/IP) messages, and is the
31315 complement of &`control = submission`&. It disables the fixups that are
31316 normally applied to locally-submitted messages. Specifically:
31317
31318 .ilist
31319 Any &'Sender:'& header line is left alone (in this respect, it is a
31320 dynamic version of &%local_sender_retain%&).
31321 .next
31322 No &'Message-ID:'&, &'From:'&, or &'Date:'& header lines are added.
31323 .next
31324 There is no check that &'From:'& corresponds to the actual sender.
31325 .endlist ilist
31326
31327 This control may be useful when a remotely-originated message is accepted,
31328 passed to some scanning program, and then re-submitted for delivery. It can be
31329 used only in the &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
31330 and &%acl_not_smtp_start%& ACLs, because it has to be set before the message's
31331 data is read.
31332
31333 &*Note:*& This control applies only to the current message, not to any others
31334 that are being submitted at the same time using &%-bs%& or &%-bS%&.
31335
31336 .vitem &*control&~=&~utf8_downconvert*&
31337 This control enables conversion of UTF-8 in message envelope addresses
31338 to a-label form.
31339 For details see section &<<SECTi18nMTA>>&.
31340 .endlist vlist
31341
31342
31343 .section "Summary of message fixup control" "SECTsummesfix"
31344 All four possibilities for message fixups can be specified:
31345
31346 .ilist
31347 Locally submitted, fixups applied: the default.
31348 .next
31349 Locally submitted, no fixups applied: use
31350 &`control = suppress_local_fixups`&.
31351 .next
31352 Remotely submitted, no fixups applied: the default.
31353 .next
31354 Remotely submitted, fixups applied: use &`control = submission`&.
31355 .endlist
31356
31357
31358
31359 .section "Adding header lines in ACLs" "SECTaddheadacl"
31360 .cindex "header lines" "adding in an ACL"
31361 .cindex "header lines" "position of added lines"
31362 .cindex "&%add_header%& ACL modifier"
31363 The &%add_header%& modifier can be used to add one or more extra header lines
31364 to an incoming message, as in this example:
31365 .code
31366 warn dnslists = sbl.spamhaus.org : \
31367                 dialup.mail-abuse.org
31368      add_header = X-blacklisted-at: $dnslist_domain
31369 .endd
31370 The &%add_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
31371 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
31372 receiving a message). The message must ultimately be accepted for
31373 &%add_header%& to have any significant effect. You can use &%add_header%& with
31374 any ACL verb, including &%deny%& (though this is potentially useful only in a
31375 RCPT ACL).
31376
31377 Headers will not be added to the message if the modifier is used in
31378 DATA, MIME or DKIM ACLs for a message delivered by cutthrough routing.
31379
31380 Leading and trailing newlines are removed from
31381 the data for the &%add_header%& modifier; if it then
31382 contains one or more newlines that
31383 are not followed by a space or a tab, it is assumed to contain multiple header
31384 lines. Each one is checked for valid syntax; &`X-ACL-Warn:`& is added to the
31385 front of any line that is not a valid header line.
31386
31387 Added header lines are accumulated during the MAIL, RCPT, and predata ACLs.
31388 They are added to the message before processing the DATA and MIME ACLs.
31389 However, if an identical header line is requested more than once, only one copy
31390 is actually added to the message. Further header lines may be accumulated
31391 during the DATA and MIME ACLs, after which they are added to the message, again
31392 with duplicates suppressed. Thus, it is possible to add two identical header
31393 lines to an SMTP message, but only if one is added before DATA and one after.
31394 In the case of non-SMTP messages, new headers are accumulated during the
31395 non-SMTP ACLs, and are added to the message after all the ACLs have run. If a
31396 message is rejected after DATA or by the non-SMTP ACL, all added header lines
31397 are included in the entry that is written to the reject log.
31398
31399 .cindex "header lines" "added; visibility of"
31400 Header lines are not visible in string expansions
31401 of message headers
31402 until they are added to the
31403 message. It follows that header lines defined in the MAIL, RCPT, and predata
31404 ACLs are not visible until the DATA ACL and MIME ACLs are run. Similarly,
31405 header lines that are added by the DATA or MIME ACLs are not visible in those
31406 ACLs. Because of this restriction, you cannot use header lines as a way of
31407 passing data between (for example) the MAIL and RCPT ACLs. If you want to do
31408 this, you can use ACL variables, as described in section
31409 &<<SECTaclvariables>>&.
31410
31411 The list of headers yet to be added is given by the &%$headers_added%& variable.
31412
31413 The &%add_header%& modifier acts immediately as it is encountered during the
31414 processing of an ACL. Notice the difference between these two cases:
31415 .display
31416 &`accept add_header = ADDED: some text`&
31417 &`       `&<&'some condition'&>
31418
31419 &`accept `&<&'some condition'&>
31420 &`       add_header = ADDED: some text`&
31421 .endd
31422 In the first case, the header line is always added, whether or not the
31423 condition is true. In the second case, the header line is added only if the
31424 condition is true. Multiple occurrences of &%add_header%& may occur in the same
31425 ACL statement. All those that are encountered before a condition fails are
31426 honoured.
31427
31428 .cindex "&%warn%& ACL verb"
31429 For compatibility with previous versions of Exim, a &%message%& modifier for a
31430 &%warn%& verb acts in the same way as &%add_header%&, except that it takes
31431 effect only if all the conditions are true, even if it appears before some of
31432 them. Furthermore, only the last occurrence of &%message%& is honoured. This
31433 usage of &%message%& is now deprecated. If both &%add_header%& and &%message%&
31434 are present on a &%warn%& verb, both are processed according to their
31435 specifications.
31436
31437 By default, new header lines are added to a message at the end of the existing
31438 header lines. However, you can specify that any particular header line should
31439 be added right at the start (before all the &'Received:'& lines), immediately
31440 after the first block of &'Received:'& lines, or immediately before any line
31441 that is not a &'Received:'& or &'Resent-something:'& header.
31442
31443 This is done by specifying &":at_start:"&, &":after_received:"&, or
31444 &":at_start_rfc:"& (or, for completeness, &":at_end:"&) before the text of the
31445 header line, respectively. (Header text cannot start with a colon, as there has
31446 to be a header name first.) For example:
31447 .code
31448 warn add_header = \
31449        :after_received:X-My-Header: something or other...
31450 .endd
31451 If more than one header line is supplied in a single &%add_header%& modifier,
31452 each one is treated independently and can therefore be placed differently. If
31453 you add more than one line at the start, or after the Received: block, they end
31454 up in reverse order.
31455
31456 &*Warning*&: This facility currently applies only to header lines that are
31457 added in an ACL. It does NOT work for header lines that are added in a
31458 system filter or in a router or transport.
31459
31460
31461
31462 .section "Removing header lines in ACLs" "SECTremoveheadacl"
31463 .cindex "header lines" "removing in an ACL"
31464 .cindex "header lines" "position of removed lines"
31465 .cindex "&%remove_header%& ACL modifier"
31466 The &%remove_header%& modifier can be used to remove one or more header lines
31467 from an incoming message, as in this example:
31468 .code
31469 warn   message        = Remove internal headers
31470        remove_header  = x-route-mail1 : x-route-mail2
31471 .endd
31472 The &%remove_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
31473 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
31474 receiving a message). The message must ultimately be accepted for
31475 &%remove_header%& to have any significant effect. You can use &%remove_header%&
31476 with any ACL verb, including &%deny%&, though this is really not useful for
31477 any verb that doesn't result in a delivered message.
31478
31479 Headers will not be removed from the message if the modifier is used in
31480 DATA, MIME or DKIM ACLs for a message delivered by cutthrough routing.
31481
31482 More than one header can be removed at the same time by using a colon separated
31483 list of header names. The header matching is case insensitive. Wildcards are
31484 not permitted, nor is list expansion performed, so you cannot use hostlists to
31485 create a list of headers, however both connection and message variable expansion
31486 are performed (&%$acl_c_*%& and &%$acl_m_*%&), illustrated in this example:
31487 .code
31488 warn   hosts           = +internal_hosts
31489        set acl_c_ihdrs = x-route-mail1 : x-route-mail2
31490 warn   message         = Remove internal headers
31491        remove_header   = $acl_c_ihdrs
31492 .endd
31493 Header names for removal are accumulated during the MAIL, RCPT, and predata ACLs.
31494 Matching header lines are removed from the message before processing the DATA and MIME ACLs.
31495 If multiple header lines match, all are removed.
31496 There is no harm in attempting to remove the same header twice nor in removing
31497 a non-existent header. Further header lines to be removed may be accumulated
31498 during the DATA and MIME ACLs, after which they are removed from the message,
31499 if present. In the case of non-SMTP messages, headers to be removed are
31500 accumulated during the non-SMTP ACLs, and are removed from the message after
31501 all the ACLs have run. If a message is rejected after DATA or by the non-SMTP
31502 ACL, there really is no effect because there is no logging of what headers
31503 would have been removed.
31504
31505 .cindex "header lines" "removed; visibility of"
31506 Header lines are not visible in string expansions until the DATA phase when it
31507 is received. Any header lines removed in the MAIL, RCPT, and predata ACLs are
31508 not visible in the DATA ACL and MIME ACLs. Similarly, header lines that are
31509 removed by the DATA or MIME ACLs are still visible in those ACLs. Because of
31510 this restriction, you cannot use header lines as a way of controlling data
31511 passed between (for example) the MAIL and RCPT ACLs. If you want to do this,
31512 you should instead use ACL variables, as described in section
31513 &<<SECTaclvariables>>&.
31514
31515 The &%remove_header%& modifier acts immediately as it is encountered during the
31516 processing of an ACL. Notice the difference between these two cases:
31517 .display
31518 &`accept remove_header = X-Internal`&
31519 &`       `&<&'some condition'&>
31520
31521 &`accept `&<&'some condition'&>
31522 &`       remove_header = X-Internal`&
31523 .endd
31524 In the first case, the header line is always removed, whether or not the
31525 condition is true. In the second case, the header line is removed only if the
31526 condition is true. Multiple occurrences of &%remove_header%& may occur in the
31527 same ACL statement. All those that are encountered before a condition fails
31528 are honoured.
31529
31530 &*Warning*&: This facility currently applies only to header lines that are
31531 present during ACL processing. It does NOT remove header lines that are added
31532 in a system filter or in a router or transport.
31533
31534
31535
31536
31537 .section "ACL conditions" "SECTaclconditions"
31538 .cindex "&ACL;" "conditions; list of"
31539 Some of the conditions listed in this section are available only when Exim is
31540 compiled with the content-scanning extension. They are included here briefly
31541 for completeness. More detailed descriptions can be found in the discussion on
31542 content scanning in chapter &<<CHAPexiscan>>&.
31543
31544 Not all conditions are relevant in all circumstances. For example, testing
31545 senders and recipients does not make sense in an ACL that is being run as the
31546 result of the arrival of an ETRN command, and checks on message headers can be
31547 done only in the ACLs specified by &%acl_smtp_data%& and &%acl_not_smtp%&. You
31548 can use the same condition (with different parameters) more than once in the
31549 same ACL statement. This provides a way of specifying an &"and"& conjunction.
31550 The conditions are as follows:
31551
31552
31553 .vlist
31554 .vitem &*acl&~=&~*&<&'name&~of&~acl&~or&~ACL&~string&~or&~file&~name&~'&>
31555 .cindex "&ACL;" "nested"
31556 .cindex "&ACL;" "indirect"
31557 .cindex "&ACL;" "arguments"
31558 .cindex "&%acl%& ACL condition"
31559 The possible values of the argument are the same as for the
31560 &%acl_smtp_%&&'xxx'& options. The named or inline ACL is run. If it returns
31561 &"accept"& the condition is true; if it returns &"deny"& the condition is
31562 false. If it returns &"defer"&, the current ACL returns &"defer"& unless the
31563 condition is on a &%warn%& verb. In that case, a &"defer"& return makes the
31564 condition false. This means that further processing of the &%warn%& verb
31565 ceases, but processing of the ACL continues.
31566
31567 If the argument is a named ACL, up to nine space-separated optional values
31568 can be appended; they appear within the called ACL in $acl_arg1 to $acl_arg9,
31569 and $acl_narg is set to the count of values.
31570 Previous values of these variables are restored after the call returns.
31571 The name and values are expanded separately.
31572 Note that spaces in complex expansions which are used as arguments
31573 will act as argument separators.
31574
31575 If the nested &%acl%& returns &"drop"& and the outer condition denies access,
31576 the connection is dropped. If it returns &"discard"&, the verb must be
31577 &%accept%& or &%discard%&, and the action is taken immediately &-- no further
31578 conditions are tested.
31579
31580 ACLs may be nested up to 20 deep; the limit exists purely to catch runaway
31581 loops. This condition allows you to use different ACLs in different
31582 circumstances. For example, different ACLs can be used to handle RCPT commands
31583 for different local users or different local domains.
31584
31585 .vitem &*authenticated&~=&~*&<&'string&~list'&>
31586 .cindex "&%authenticated%& ACL condition"
31587 .cindex "authentication" "ACL checking"
31588 .cindex "&ACL;" "testing for authentication"
31589 If the SMTP connection is not authenticated, the condition is false. Otherwise,
31590 the name of the authenticator is tested against the list. To test for
31591 authentication by any authenticator, you can set
31592 .code
31593 authenticated = *
31594 .endd
31595
31596 .vitem &*condition&~=&~*&<&'string'&>
31597 .cindex "&%condition%& ACL condition"
31598 .cindex "customizing" "ACL condition"
31599 .cindex "&ACL;" "customized test"
31600 .cindex "&ACL;" "testing, customized"
31601 This feature allows you to make up custom conditions. If the result of
31602 expanding the string is an empty string, the number zero, or one of the strings
31603 &"no"& or &"false"&, the condition is false. If the result is any non-zero
31604 number, or one of the strings &"yes"& or &"true"&, the condition is true. For
31605 any other value, some error is assumed to have occurred, and the ACL returns
31606 &"defer"&. However, if the expansion is forced to fail, the condition is
31607 ignored. The effect is to treat it as true, whether it is positive or
31608 negative.
31609
31610 .vitem &*decode&~=&~*&<&'location'&>
31611 .cindex "&%decode%& ACL condition"
31612 This condition is available only when Exim is compiled with the
31613 content-scanning extension, and it is allowed only in the ACL defined by
31614 &%acl_smtp_mime%&. It causes the current MIME part to be decoded into a file.
31615 If all goes well, the condition is true. It is false only if there are
31616 problems such as a syntax error or a memory shortage. For more details, see
31617 chapter &<<CHAPexiscan>>&.
31618
31619 .vitem &*dnslists&~=&~*&<&'list&~of&~domain&~names&~and&~other&~data'&>
31620 .cindex "&%dnslists%& ACL condition"
31621 .cindex "DNS list" "in ACL"
31622 .cindex "black list (DNS)"
31623 .cindex "&ACL;" "testing a DNS list"
31624 This condition checks for entries in DNS black lists. These are also known as
31625 &"RBL lists"&, after the original Realtime Blackhole List, but note that the
31626 use of the lists at &'mail-abuse.org'& now carries a charge. There are too many
31627 different variants of this condition to describe briefly here. See sections
31628 &<<SECTmorednslists>>&&--&<<SECTmorednslistslast>>& for details.
31629
31630 .vitem &*domains&~=&~*&<&'domain&~list'&>
31631 .cindex "&%domains%& ACL condition"
31632 .cindex "domain" "ACL checking"
31633 .cindex "&ACL;" "testing a recipient domain"
31634 .vindex "&$domain_data$&"
31635 This condition is relevant only after a RCPT command. It checks that the domain
31636 of the recipient address is in the domain list. If percent-hack processing is
31637 enabled, it is done before this test is done. If the check succeeds with a
31638 lookup, the result of the lookup is placed in &$domain_data$& until the next
31639 &%domains%& test.
31640
31641 &*Note carefully*& (because many people seem to fall foul of this): you cannot
31642 use &%domains%& in a DATA ACL.
31643
31644
31645 .vitem &*encrypted&~=&~*&<&'string&~list'&>
31646 .cindex "&%encrypted%& ACL condition"
31647 .cindex "encryption" "checking in an ACL"
31648 .cindex "&ACL;" "testing for encryption"
31649 If the SMTP connection is not encrypted, the condition is false. Otherwise, the
31650 name of the cipher suite in use is tested against the list. To test for
31651 encryption without testing for any specific cipher suite(s), set
31652 .code
31653 encrypted = *
31654 .endd
31655
31656
31657 .vitem &*hosts&~=&~*&<&'host&~list'&>
31658 .cindex "&%hosts%& ACL condition"
31659 .cindex "host" "ACL checking"
31660 .cindex "&ACL;" "testing the client host"
31661 This condition tests that the calling host matches the host list. If you have
31662 name lookups or wildcarded host names and IP addresses in the same host list,
31663 you should normally put the IP addresses first. For example, you could have:
31664 .code
31665 accept hosts = 10.9.8.7 : dbm;/etc/friendly/hosts
31666 .endd
31667 The lookup in this example uses the host name for its key. This is implied by
31668 the lookup type &"dbm"&. (For a host address lookup you would use &"net-dbm"&
31669 and it wouldn't matter which way round you had these two items.)
31670
31671 The reason for the problem with host names lies in the left-to-right way that
31672 Exim processes lists. It can test IP addresses without doing any DNS lookups,
31673 but when it reaches an item that requires a host name, it fails if it cannot
31674 find a host name to compare with the pattern. If the above list is given in the
31675 opposite order, the &%accept%& statement fails for a host whose name cannot be
31676 found, even if its IP address is 10.9.8.7.
31677
31678 If you really do want to do the name check first, and still recognize the IP
31679 address even if the name lookup fails, you can rewrite the ACL like this:
31680 .code
31681 accept hosts = dbm;/etc/friendly/hosts
31682 accept hosts = 10.9.8.7
31683 .endd
31684 The default action on failing to find the host name is to assume that the host
31685 is not in the list, so the first &%accept%& statement fails. The second
31686 statement can then check the IP address.
31687
31688 .vindex "&$host_data$&"
31689 If a &%hosts%& condition is satisfied by means of a lookup, the result
31690 of the lookup is made available in the &$host_data$& variable. This
31691 allows you, for example, to set up a statement like this:
31692 .code
31693 deny  hosts = net-lsearch;/some/file
31694       message = $host_data
31695 .endd
31696 which gives a custom error message for each denied host.
31697
31698 .vitem &*local_parts&~=&~*&<&'local&~part&~list'&>
31699 .cindex "&%local_parts%& ACL condition"
31700 .cindex "local part" "ACL checking"
31701 .cindex "&ACL;" "testing a local part"
31702 .vindex "&$local_part_data$&"
31703 This condition is relevant only after a RCPT command. It checks that the local
31704 part of the recipient address is in the list. If percent-hack processing is
31705 enabled, it is done before this test. If the check succeeds with a lookup, the
31706 result of the lookup is placed in &$local_part_data$&, which remains set until
31707 the next &%local_parts%& test.
31708
31709 .vitem &*malware&~=&~*&<&'option'&>
31710 .cindex "&%malware%& ACL condition"
31711 .cindex "&ACL;" "virus scanning"
31712 .cindex "&ACL;" "scanning for viruses"
31713 This condition is available only when Exim is compiled with the
31714 content-scanning extension
31715 and only after a DATA command.
31716 It causes the incoming message to be scanned for
31717 viruses. For details, see chapter &<<CHAPexiscan>>&.
31718
31719 .vitem &*mime_regex&~=&~*&<&'list&~of&~regular&~expressions'&>
31720 .cindex "&%mime_regex%& ACL condition"
31721 .cindex "&ACL;" "testing by regex matching"
31722 This condition is available only when Exim is compiled with the
31723 content-scanning extension, and it is allowed only in the ACL defined by
31724 &%acl_smtp_mime%&. It causes the current MIME part to be scanned for a match
31725 with any of the regular expressions. For details, see chapter
31726 &<<CHAPexiscan>>&.
31727
31728 .vitem &*ratelimit&~=&~*&<&'parameters'&>
31729 .cindex "rate limiting"
31730 This condition can be used to limit the rate at which a user or host submits
31731 messages. Details are given in section &<<SECTratelimiting>>&.
31732
31733 .vitem &*recipients&~=&~*&<&'address&~list'&>
31734 .cindex "&%recipients%& ACL condition"
31735 .cindex "recipient" "ACL checking"
31736 .cindex "&ACL;" "testing a recipient"
31737 This condition is relevant only after a RCPT command. It checks the entire
31738 recipient address against a list of recipients.
31739
31740 .vitem &*regex&~=&~*&<&'list&~of&~regular&~expressions'&>
31741 .cindex "&%regex%& ACL condition"
31742 .cindex "&ACL;" "testing by regex matching"
31743 This condition is available only when Exim is compiled with the
31744 content-scanning extension, and is available only in the DATA, MIME, and
31745 non-SMTP ACLs. It causes the incoming message to be scanned for a match with
31746 any of the regular expressions. For details, see chapter &<<CHAPexiscan>>&.
31747
31748 .vitem &*sender_domains&~=&~*&<&'domain&~list'&>
31749 .cindex "&%sender_domains%& ACL condition"
31750 .cindex "sender" "ACL checking"
31751 .cindex "&ACL;" "testing a sender domain"
31752 .vindex "&$domain$&"
31753 .vindex "&$sender_address_domain$&"
31754 This condition tests the domain of the sender of the message against the given
31755 domain list. &*Note*&: The domain of the sender address is in
31756 &$sender_address_domain$&. It is &'not'& put in &$domain$& during the testing
31757 of this condition. This is an exception to the general rule for testing domain
31758 lists. It is done this way so that, if this condition is used in an ACL for a
31759 RCPT command, the recipient's domain (which is in &$domain$&) can be used to
31760 influence the sender checking.
31761
31762 &*Warning*&: It is a bad idea to use this condition on its own as a control on
31763 relaying, because sender addresses are easily, and commonly, forged.
31764
31765 .vitem &*senders&~=&~*&<&'address&~list'&>
31766 .cindex "&%senders%& ACL condition"
31767 .cindex "sender" "ACL checking"
31768 .cindex "&ACL;" "testing a sender"
31769 This condition tests the sender of the message against the given list. To test
31770 for a bounce message, which has an empty sender, set
31771 .code
31772 senders = :
31773 .endd
31774 &*Warning*&: It is a bad idea to use this condition on its own as a control on
31775 relaying, because sender addresses are easily, and commonly, forged.
31776
31777 .vitem &*spam&~=&~*&<&'username'&>
31778 .cindex "&%spam%& ACL condition"
31779 .cindex "&ACL;" "scanning for spam"
31780 This condition is available only when Exim is compiled with the
31781 content-scanning extension. It causes the incoming message to be scanned by
31782 SpamAssassin. For details, see chapter &<<CHAPexiscan>>&.
31783
31784 .vitem &*verify&~=&~certificate*&
31785 .cindex "&%verify%& ACL condition"
31786 .cindex "TLS" "client certificate verification"
31787 .cindex "certificate" "verification of client"
31788 .cindex "&ACL;" "certificate verification"
31789 .cindex "&ACL;" "testing a TLS certificate"
31790 This condition is true in an SMTP session if the session is encrypted, and a
31791 certificate was received from the client, and the certificate was verified. The
31792 server requests a certificate only if the client matches &%tls_verify_hosts%&
31793 or &%tls_try_verify_hosts%& (see chapter &<<CHAPTLS>>&).
31794
31795 .vitem &*verify&~=&~csa*&
31796 .cindex "CSA verification"
31797 This condition checks whether the sending host (the client) is authorized to
31798 send email. Details of how this works are given in section
31799 &<<SECTverifyCSA>>&.
31800
31801 .vitem &*verify&~=&~header_names_ascii*&
31802 .cindex "&%verify%& ACL condition"
31803 .cindex "&ACL;" "verifying header names only ASCII"
31804 .cindex "header lines" "verifying header names only ASCII"
31805 .cindex "verifying" "header names only ASCII"
31806 This condition is relevant only in an ACL that is run after a message has been
31807 received.
31808 This usually means an ACL specified by &%acl_smtp_data%& or &%acl_not_smtp%&.
31809 It checks all header names (not the content) to make sure
31810 there are no non-ASCII characters, also excluding control characters.  The
31811 allowable characters are decimal ASCII values 33 through 126.
31812
31813 Exim itself will handle headers with non-ASCII characters, but it can cause
31814 problems for downstream applications, so this option will allow their
31815 detection and rejection in the DATA ACL's.
31816
31817 .vitem &*verify&~=&~header_sender/*&<&'options'&>
31818 .cindex "&%verify%& ACL condition"
31819 .cindex "&ACL;" "verifying sender in the header"
31820 .cindex "header lines" "verifying the sender in"
31821 .cindex "sender" "verifying in header"
31822 .cindex "verifying" "sender in header"
31823 This condition is relevant only in an ACL that is run after a message has been
31824 received, that is, in an ACL specified by &%acl_smtp_data%& or
31825 &%acl_not_smtp%&. It checks that there is a verifiable address in at least one
31826 of the &'Sender:'&, &'Reply-To:'&, or &'From:'& header lines. Such an address
31827 is loosely thought of as a &"sender"& address (hence the name of the test).
31828 However, an address that appears in one of these headers need not be an address
31829 that accepts bounce messages; only sender addresses in envelopes are required
31830 to accept bounces. Therefore, if you use the callout option on this check, you
31831 might want to arrange for a non-empty address in the MAIL command.
31832
31833 Details of address verification and the options are given later, starting at
31834 section &<<SECTaddressverification>>& (callouts are described in section
31835 &<<SECTcallver>>&). You can combine this condition with the &%senders%&
31836 condition to restrict it to bounce messages only:
31837 .code
31838 deny    senders = :
31839        !verify  = header_sender
31840         message = A valid sender header is required for bounces
31841 .endd
31842
31843 .vitem &*verify&~=&~header_syntax*&
31844 .cindex "&%verify%& ACL condition"
31845 .cindex "&ACL;" "verifying header syntax"
31846 .cindex "header lines" "verifying syntax"
31847 .cindex "verifying" "header syntax"
31848 This condition is relevant only in an ACL that is run after a message has been
31849 received, that is, in an ACL specified by &%acl_smtp_data%& or
31850 &%acl_not_smtp%&. It checks the syntax of all header lines that can contain
31851 lists of addresses (&'Sender:'&, &'From:'&, &'Reply-To:'&, &'To:'&, &'Cc:'&,
31852 and &'Bcc:'&), returning true if there are no problems.
31853 Unqualified addresses (local parts without domains) are
31854 permitted only in locally generated messages and from hosts that match
31855 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
31856 appropriate.
31857
31858 Note that this condition is a syntax check only. However, a common spamming
31859 ploy used to be to send syntactically invalid headers such as
31860 .code
31861 To: @
31862 .endd
31863 and this condition can be used to reject such messages, though they are not as
31864 common as they used to be.
31865
31866 .vitem &*verify&~=&~helo*&
31867 .cindex "&%verify%& ACL condition"
31868 .cindex "&ACL;" "verifying HELO/EHLO"
31869 .cindex "HELO" "verifying"
31870 .cindex "EHLO" "verifying"
31871 .cindex "verifying" "EHLO"
31872 .cindex "verifying" "HELO"
31873 This condition is true if a HELO or EHLO command has been received from the
31874 client host, and its contents have been verified. If there has been no previous
31875 attempt to verify the HELO/EHLO contents, it is carried out when this
31876 condition is encountered. See the description of the &%helo_verify_hosts%& and
31877 &%helo_try_verify_hosts%& options for details of how to request verification
31878 independently of this condition, and for detail of the verification.
31879
31880 For SMTP input that does not come over TCP/IP (the &%-bs%& command line
31881 option), this condition is always true.
31882
31883
31884 .vitem &*verify&~=&~not_blind/*&<&'options'&>
31885 .cindex "verifying" "not blind"
31886 .cindex "bcc recipients, verifying none"
31887 This condition checks that there are no blind (bcc) recipients in the message.
31888 Every envelope recipient must appear either in a &'To:'& header line or in a
31889 &'Cc:'& header line for this condition to be true. Local parts are checked
31890 case-sensitively; domains are checked case-insensitively. If &'Resent-To:'& or
31891 &'Resent-Cc:'& header lines exist, they are also checked. This condition can be
31892 used only in a DATA or non-SMTP ACL.
31893
31894 There is one possible option, &`case_insensitive`&.  If this is present then
31895 local parts are checked case-insensitively.
31896
31897 There are, of course, many legitimate messages that make use of blind (bcc)
31898 recipients. This check should not be used on its own for blocking messages.
31899
31900
31901 .vitem &*verify&~=&~recipient/*&<&'options'&>
31902 .cindex "&%verify%& ACL condition"
31903 .cindex "&ACL;" "verifying recipient"
31904 .cindex "recipient" "verifying"
31905 .cindex "verifying" "recipient"
31906 .vindex "&$address_data$&"
31907 This condition is relevant only after a RCPT command. It verifies the current
31908 recipient. Details of address verification are given later, starting at section
31909 &<<SECTaddressverification>>&. After a recipient has been verified, the value
31910 of &$address_data$& is the last value that was set while routing the address.
31911 This applies even if the verification fails. When an address that is being
31912 verified is redirected to a single address, verification continues with the new
31913 address, and in that case, the subsequent value of &$address_data$& is the
31914 value for the child address.
31915
31916 .vitem &*verify&~=&~reverse_host_lookup/*&<&'options'&>
31917 .cindex "&%verify%& ACL condition"
31918 .cindex "&ACL;" "verifying host reverse lookup"
31919 .cindex "host" "verifying reverse lookup"
31920 This condition ensures that a verified host name has been looked up from the IP
31921 address of the client host. (This may have happened already if the host name
31922 was needed for checking a host list, or if the host matched &%host_lookup%&.)
31923 Verification ensures that the host name obtained from a reverse DNS lookup, or
31924 one of its aliases, does, when it is itself looked up in the DNS, yield the
31925 original IP address.
31926
31927 There is one possible option, &`defer_ok`&.  If this is present and a
31928 DNS operation returns a temporary error, the verify condition succeeds.
31929
31930 If this condition is used for a locally generated message (that is, when there
31931 is no client host involved), it always succeeds.
31932
31933 .vitem &*verify&~=&~sender/*&<&'options'&>
31934 .cindex "&%verify%& ACL condition"
31935 .cindex "&ACL;" "verifying sender"
31936 .cindex "sender" "verifying"
31937 .cindex "verifying" "sender"
31938 This condition is relevant only after a MAIL or RCPT command, or after a
31939 message has been received (the &%acl_smtp_data%& or &%acl_not_smtp%& ACLs). If
31940 the message's sender is empty (that is, this is a bounce message), the
31941 condition is true. Otherwise, the sender address is verified.
31942
31943 .vindex "&$address_data$&"
31944 .vindex "&$sender_address_data$&"
31945 If there is data in the &$address_data$& variable at the end of routing, its
31946 value is placed in &$sender_address_data$& at the end of verification. This
31947 value can be used in subsequent conditions and modifiers in the same ACL
31948 statement. It does not persist after the end of the current statement. If you
31949 want to preserve the value for longer, you can save it in an ACL variable.
31950
31951 Details of verification are given later, starting at section
31952 &<<SECTaddressverification>>&. Exim caches the result of sender verification,
31953 to avoid doing it more than once per message.
31954
31955 .vitem &*verify&~=&~sender=*&<&'address'&>&*/*&<&'options'&>
31956 .cindex "&%verify%& ACL condition"
31957 This is a variation of the previous option, in which a modified address is
31958 verified as a sender.
31959
31960 Note that '/' is legal in local-parts; if the address may have such
31961 (eg. is generated from the received message)
31962 they must be protected from the options parsing by doubling:
31963 .code
31964 verify = sender=${listquote{/}{${address:$h_sender:}}}
31965 .endd
31966 .endlist
31967
31968
31969
31970 .section "Using DNS lists" "SECTmorednslists"
31971 .cindex "DNS list" "in ACL"
31972 .cindex "black list (DNS)"
31973 .cindex "&ACL;" "testing a DNS list"
31974 In its simplest form, the &%dnslists%& condition tests whether the calling host
31975 is on at least one of a number of DNS lists by looking up the inverted IP
31976 address in one or more DNS domains. (Note that DNS list domains are not mail
31977 domains, so the &`+`& syntax for named lists doesn't work - it is used for
31978 special options instead.) For example, if the calling host's IP
31979 address is 192.168.62.43, and the ACL statement is
31980 .code
31981 deny dnslists = blackholes.mail-abuse.org : \
31982                 dialups.mail-abuse.org
31983 .endd
31984 the following records are looked up:
31985 .code
31986 43.62.168.192.blackholes.mail-abuse.org
31987 43.62.168.192.dialups.mail-abuse.org
31988 .endd
31989 As soon as Exim finds an existing DNS record, processing of the list stops.
31990 Thus, multiple entries on the list provide an &"or"& conjunction. If you want
31991 to test that a host is on more than one list (an &"and"& conjunction), you can
31992 use two separate conditions:
31993 .code
31994 deny dnslists = blackholes.mail-abuse.org
31995      dnslists = dialups.mail-abuse.org
31996 .endd
31997 If a DNS lookup times out or otherwise fails to give a decisive answer, Exim
31998 behaves as if the host does not match the list item, that is, as if the DNS
31999 record does not exist. If there are further items in the DNS list, they are
32000 processed.
32001
32002 This is usually the required action when &%dnslists%& is used with &%deny%&
32003 (which is the most common usage), because it prevents a DNS failure from
32004 blocking mail. However, you can change this behaviour by putting one of the
32005 following special items in the list:
32006 .display
32007 &`+include_unknown `&   behave as if the item is on the list
32008 &`+exclude_unknown `&   behave as if the item is not on the list (default)
32009 &`+defer_unknown   `&   give a temporary error
32010 .endd
32011 .cindex "&`+include_unknown`&"
32012 .cindex "&`+exclude_unknown`&"
32013 .cindex "&`+defer_unknown`&"
32014 Each of these applies to any subsequent items on the list. For example:
32015 .code
32016 deny dnslists = +defer_unknown : foo.bar.example
32017 .endd
32018 Testing the list of domains stops as soon as a match is found. If you want to
32019 warn for one list and block for another, you can use two different statements:
32020 .code
32021 deny  dnslists = blackholes.mail-abuse.org
32022 warn  dnslists = dialups.mail-abuse.org
32023       message  = X-Warn: sending host is on dialups list
32024 .endd
32025 .cindex caching "of dns lookup"
32026 .cindex DNS TTL
32027 DNS list lookups are cached by Exim for the duration of the SMTP session
32028 (but limited by the DNS return TTL value),
32029 so a lookup based on the IP address is done at most once for any incoming
32030 connection (assuming long-enough TTL).
32031 Exim does not share information between multiple incoming
32032 connections (but your local name server cache should be active).
32033
32034 There are a number of DNS lists to choose from, some commercial, some free,
32035 or free for small deployments.  An overview can be found at
32036 &url(https://en.wikipedia.org/wiki/Comparison_of_DNS_blacklists).
32037
32038
32039
32040 .section "Specifying the IP address for a DNS list lookup" "SECID201"
32041 .cindex "DNS list" "keyed by explicit IP address"
32042 By default, the IP address that is used in a DNS list lookup is the IP address
32043 of the calling host. However, you can specify another IP address by listing it
32044 after the domain name, introduced by a slash. For example:
32045 .code
32046 deny dnslists = black.list.tld/192.168.1.2
32047 .endd
32048 This feature is not very helpful with explicit IP addresses; it is intended for
32049 use with IP addresses that are looked up, for example, the IP addresses of the
32050 MX hosts or nameservers of an email sender address. For an example, see section
32051 &<<SECTmulkeyfor>>& below.
32052
32053
32054
32055
32056 .section "DNS lists keyed on domain names" "SECID202"
32057 .cindex "DNS list" "keyed by domain name"
32058 There are some lists that are keyed on domain names rather than inverted IP
32059 addresses (see, e.g., the &'domain based zones'& link at
32060 &url(http://www.rfc-ignorant.org/)). No reversing of components is used
32061 with these lists. You can change the name that is looked up in a DNS list by
32062 listing it after the domain name, introduced by a slash. For example,
32063 .code
32064 deny  dnslists = dsn.rfc-ignorant.org/$sender_address_domain
32065       message  = Sender's domain is listed at $dnslist_domain
32066 .endd
32067 This particular example is useful only in ACLs that are obeyed after the
32068 RCPT or DATA commands, when a sender address is available. If (for
32069 example) the message's sender is &'user@tld.example'& the name that is looked
32070 up by this example is
32071 .code
32072 tld.example.dsn.rfc-ignorant.org
32073 .endd
32074 A single &%dnslists%& condition can contain entries for both names and IP
32075 addresses. For example:
32076 .code
32077 deny dnslists = sbl.spamhaus.org : \
32078                 dsn.rfc-ignorant.org/$sender_address_domain
32079 .endd
32080 The first item checks the sending host's IP address; the second checks a domain
32081 name. The whole condition is true if either of the DNS lookups succeeds.
32082
32083
32084
32085
32086 .section "Multiple explicit keys for a DNS list" "SECTmulkeyfor"
32087 .cindex "DNS list" "multiple keys for"
32088 The syntax described above for looking up explicitly-defined values (either
32089 names or IP addresses) in a DNS blacklist is a simplification. After the domain
32090 name for the DNS list, what follows the slash can in fact be a list of items.
32091 As with all lists in Exim, the default separator is a colon. However, because
32092 this is a sublist within the list of DNS blacklist domains, it is necessary
32093 either to double the separators like this:
32094 .code
32095 dnslists = black.list.tld/name.1::name.2
32096 .endd
32097 or to change the separator character, like this:
32098 .code
32099 dnslists = black.list.tld/<;name.1;name.2
32100 .endd
32101 If an item in the list is an IP address, it is inverted before the DNS
32102 blacklist domain is appended. If it is not an IP address, no inversion
32103 occurs. Consider this condition:
32104 .code
32105 dnslists = black.list.tld/<;192.168.1.2;a.domain
32106 .endd
32107 The DNS lookups that occur are:
32108 .code
32109 2.1.168.192.black.list.tld
32110 a.domain.black.list.tld
32111 .endd
32112 Once a DNS record has been found (that matches a specific IP return
32113 address, if specified &-- see section &<<SECTaddmatcon>>&), no further lookups
32114 are done. If there is a temporary DNS error, the rest of the sublist of domains
32115 or IP addresses is tried. A temporary error for the whole dnslists item occurs
32116 only if no other DNS lookup in this sublist succeeds. In other words, a
32117 successful lookup for any of the items in the sublist overrides a temporary
32118 error for a previous item.
32119
32120 The ability to supply a list of items after the slash is in some sense just a
32121 syntactic convenience. These two examples have the same effect:
32122 .code
32123 dnslists = black.list.tld/a.domain : black.list.tld/b.domain
32124 dnslists = black.list.tld/a.domain::b.domain
32125 .endd
32126 However, when the data for the list is obtained from a lookup, the second form
32127 is usually much more convenient. Consider this example:
32128 .code
32129 deny dnslists = sbl.spamhaus.org/<|${lookup dnsdb {>|a=<|\
32130                                    ${lookup dnsdb {>|mxh=\
32131                                    $sender_address_domain} }} }
32132      message  = The mail servers for the domain \
32133                 $sender_address_domain \
32134                 are listed at $dnslist_domain ($dnslist_value); \
32135                 see $dnslist_text.
32136 .endd
32137 Note the use of &`>|`& in the dnsdb lookup to specify the separator for
32138 multiple DNS records. The inner dnsdb lookup produces a list of MX hosts
32139 and the outer dnsdb lookup finds the IP addresses for these hosts. The result
32140 of expanding the condition might be something like this:
32141 .code
32142 dnslists = sbl.spamhaus.org/<|192.168.2.3|192.168.5.6|...
32143 .endd
32144 Thus, this example checks whether or not the IP addresses of the sender
32145 domain's mail servers are on the Spamhaus black list.
32146
32147 The key that was used for a successful DNS list lookup is put into the variable
32148 &$dnslist_matched$& (see section &<<SECID204>>&).
32149
32150
32151
32152
32153 .section "Data returned by DNS lists" "SECID203"
32154 .cindex "DNS list" "data returned from"
32155 DNS lists are constructed using address records in the DNS. The original RBL
32156 just used the address 127.0.0.1 on the right hand side of each record, but the
32157 RBL+ list and some other lists use a number of values with different meanings.
32158 The values used on the RBL+ list are:
32159 .display
32160 127.1.0.1  RBL
32161 127.1.0.2  DUL
32162 127.1.0.3  DUL and RBL
32163 127.1.0.4  RSS
32164 127.1.0.5  RSS and RBL
32165 127.1.0.6  RSS and DUL
32166 127.1.0.7  RSS and DUL and RBL
32167 .endd
32168 Section &<<SECTaddmatcon>>& below describes how you can distinguish between
32169 different values. Some DNS lists may return more than one address record;
32170 see section &<<SECThanmuldnsrec>>& for details of how they are checked.
32171
32172
32173 .section "Variables set from DNS lists" "SECID204"
32174 .cindex "expansion" "variables, set from DNS list"
32175 .cindex "DNS list" "variables set from"
32176 .vindex "&$dnslist_domain$&"
32177 .vindex "&$dnslist_matched$&"
32178 .vindex "&$dnslist_text$&"
32179 .vindex "&$dnslist_value$&"
32180 When an entry is found in a DNS list, the variable &$dnslist_domain$& contains
32181 the name of the overall domain that matched (for example,
32182 &`spamhaus.example`&), &$dnslist_matched$& contains the key within that domain
32183 (for example, &`192.168.5.3`&), and &$dnslist_value$& contains the data from
32184 the DNS record. When the key is an IP address, it is not reversed in
32185 &$dnslist_matched$& (though it is, of course, in the actual lookup). In simple
32186 cases, for example:
32187 .code
32188 deny dnslists = spamhaus.example
32189 .endd
32190 the key is also available in another variable (in this case,
32191 &$sender_host_address$&). In more complicated cases, however, this is not true.
32192 For example, using a data lookup (as described in section &<<SECTmulkeyfor>>&)
32193 might generate a dnslists lookup like this:
32194 .code
32195 deny dnslists = spamhaus.example/<|192.168.1.2|192.168.6.7|...
32196 .endd
32197 If this condition succeeds, the value in &$dnslist_matched$& might be
32198 &`192.168.6.7`& (for example).
32199
32200 If more than one address record is returned by the DNS lookup, all the IP
32201 addresses are included in &$dnslist_value$&, separated by commas and spaces.
32202 The variable &$dnslist_text$& contains the contents of any associated TXT
32203 record. For lists such as RBL+ the TXT record for a merged entry is often not
32204 very meaningful. See section &<<SECTmordetinf>>& for a way of obtaining more
32205 information.
32206
32207 You can use the DNS list variables in &%message%& or &%log_message%& modifiers
32208 &-- even if these appear before the condition in the ACL, they are not
32209 expanded until after it has failed. For example:
32210 .code
32211 deny    hosts = !+local_networks
32212         message = $sender_host_address is listed \
32213                   at $dnslist_domain
32214         dnslists = rbl-plus.mail-abuse.example
32215 .endd
32216
32217
32218
32219 .section "Additional matching conditions for DNS lists" "SECTaddmatcon"
32220 .cindex "DNS list" "matching specific returned data"
32221 You can add an equals sign and an IP address after a &%dnslists%& domain name
32222 in order to restrict its action to DNS records with a matching right hand side.
32223 For example,
32224 .code
32225 deny dnslists = rblplus.mail-abuse.org=127.0.0.2
32226 .endd
32227 rejects only those hosts that yield 127.0.0.2. Without this additional data,
32228 any address record is considered to be a match. For the moment, we assume
32229 that the DNS lookup returns just one record. Section &<<SECThanmuldnsrec>>&
32230 describes how multiple records are handled.
32231
32232 More than one IP address may be given for checking, using a comma as a
32233 separator. These are alternatives &-- if any one of them matches, the
32234 &%dnslists%& condition is true. For example:
32235 .code
32236 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
32237 .endd
32238 If you want to specify a constraining address list and also specify names or IP
32239 addresses to be looked up, the constraining address list must be specified
32240 first. For example:
32241 .code
32242 deny dnslists = dsn.rfc-ignorant.org\
32243                 =127.0.0.2/$sender_address_domain
32244 .endd
32245
32246 If the character &`&&`& is used instead of &`=`&, the comparison for each
32247 listed IP address is done by a bitwise &"and"& instead of by an equality test.
32248 In other words, the listed addresses are used as bit masks. The comparison is
32249 true if all the bits in the mask are present in the address that is being
32250 tested. For example:
32251 .code
32252 dnslists = a.b.c&0.0.0.3
32253 .endd
32254 matches if the address is &'x.x.x.'&3, &'x.x.x.'&7, &'x.x.x.'&11, etc. If you
32255 want to test whether one bit or another bit is present (as opposed to both
32256 being present), you must use multiple values. For example:
32257 .code
32258 dnslists = a.b.c&0.0.0.1,0.0.0.2
32259 .endd
32260 matches if the final component of the address is an odd number or two times
32261 an odd number.
32262
32263
32264
32265 .section "Negated DNS matching conditions" "SECID205"
32266 You can supply a negative list of IP addresses as part of a &%dnslists%&
32267 condition. Whereas
32268 .code
32269 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
32270 .endd
32271 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
32272 IP address yielded by the list is either 127.0.0.2 or 127.0.0.3"&,
32273 .code
32274 deny  dnslists = a.b.c!=127.0.0.2,127.0.0.3
32275 .endd
32276 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
32277 IP address yielded by the list is not 127.0.0.2 and not 127.0.0.3"&. In other
32278 words, the result of the test is inverted if an exclamation mark appears before
32279 the &`=`& (or the &`&&`&) sign.
32280
32281 &*Note*&: This kind of negation is not the same as negation in a domain,
32282 host, or address list (which is why the syntax is different).
32283
32284 If you are using just one list, the negation syntax does not gain you much. The
32285 previous example is precisely equivalent to
32286 .code
32287 deny  dnslists = a.b.c
32288      !dnslists = a.b.c=127.0.0.2,127.0.0.3
32289 .endd
32290 However, if you are using multiple lists, the negation syntax is clearer.
32291 Consider this example:
32292 .code
32293 deny  dnslists = sbl.spamhaus.org : \
32294                  list.dsbl.org : \
32295                  dnsbl.njabl.org!=127.0.0.3 : \
32296                  relays.ordb.org
32297 .endd
32298 Using only positive lists, this would have to be:
32299 .code
32300 deny  dnslists = sbl.spamhaus.org : \
32301                  list.dsbl.org
32302 deny  dnslists = dnsbl.njabl.org
32303      !dnslists = dnsbl.njabl.org=127.0.0.3
32304 deny  dnslists = relays.ordb.org
32305 .endd
32306 which is less clear, and harder to maintain.
32307
32308
32309
32310
32311 .section "Handling multiple DNS records from a DNS list" "SECThanmuldnsrec"
32312 A DNS lookup for a &%dnslists%& condition may return more than one DNS record,
32313 thereby providing more than one IP address. When an item in a &%dnslists%& list
32314 is followed by &`=`& or &`&&`& and a list of IP addresses, in order to restrict
32315 the match to specific results from the DNS lookup, there are two ways in which
32316 the checking can be handled. For example, consider the condition:
32317 .code
32318 dnslists = a.b.c=127.0.0.1
32319 .endd
32320 What happens if the DNS lookup for the incoming IP address yields both
32321 127.0.0.1 and 127.0.0.2 by means of two separate DNS records? Is the
32322 condition true because at least one given value was found, or is it false
32323 because at least one of the found values was not listed? And how does this
32324 affect negated conditions? Both possibilities are provided for with the help of
32325 additional separators &`==`& and &`=&&`&.
32326
32327 .ilist
32328 If &`=`& or &`&&`& is used, the condition is true if any one of the looked up
32329 IP addresses matches one of the listed addresses. For the example above, the
32330 condition is true because 127.0.0.1 matches.
32331 .next
32332 If &`==`& or &`=&&`& is used, the condition is true only if every one of the
32333 looked up IP addresses matches one of the listed addresses. If the condition is
32334 changed to:
32335 .code
32336 dnslists = a.b.c==127.0.0.1
32337 .endd
32338 and the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
32339 false because 127.0.0.2 is not listed. You would need to have:
32340 .code
32341 dnslists = a.b.c==127.0.0.1,127.0.0.2
32342 .endd
32343 for the condition to be true.
32344 .endlist
32345
32346 When &`!`& is used to negate IP address matching, it inverts the result, giving
32347 the precise opposite of the behaviour above. Thus:
32348 .ilist
32349 If &`!=`& or &`!&&`& is used, the condition is true if none of the looked up IP
32350 addresses matches one of the listed addresses. Consider:
32351 .code
32352 dnslists = a.b.c!&0.0.0.1
32353 .endd
32354 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
32355 false because 127.0.0.1 matches.
32356 .next
32357 If &`!==`& or &`!=&&`& is used, the condition is true if there is at least one
32358 looked up IP address that does not match. Consider:
32359 .code
32360 dnslists = a.b.c!=&0.0.0.1
32361 .endd
32362 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
32363 true, because 127.0.0.2 does not match. You would need to have:
32364 .code
32365 dnslists = a.b.c!=&0.0.0.1,0.0.0.2
32366 .endd
32367 for the condition to be false.
32368 .endlist
32369 When the DNS lookup yields only a single IP address, there is no difference
32370 between &`=`& and &`==`& and between &`&&`& and &`=&&`&.
32371
32372
32373
32374
32375 .section "Detailed information from merged DNS lists" "SECTmordetinf"
32376 .cindex "DNS list" "information from merged"
32377 When the facility for restricting the matching IP values in a DNS list is used,
32378 the text from the TXT record that is set in &$dnslist_text$& may not reflect
32379 the true reason for rejection. This happens when lists are merged and the IP
32380 address in the A record is used to distinguish them; unfortunately there is
32381 only one TXT record. One way round this is not to use merged lists, but that
32382 can be inefficient because it requires multiple DNS lookups where one would do
32383 in the vast majority of cases when the host of interest is not on any of the
32384 lists.
32385
32386 A less inefficient way of solving this problem is available. If
32387 two domain names, comma-separated, are given, the second is used first to
32388 do an initial check, making use of any IP value restrictions that are set.
32389 If there is a match, the first domain is used, without any IP value
32390 restrictions, to get the TXT record. As a byproduct of this, there is also
32391 a check that the IP being tested is indeed on the first list. The first
32392 domain is the one that is put in &$dnslist_domain$&. For example:
32393 .code
32394 deny   dnslists = \
32395          sbl.spamhaus.org,sbl-xbl.spamhaus.org=127.0.0.2 : \
32396          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
32397        message  = \
32398          rejected because $sender_host_address is blacklisted \
32399          at $dnslist_domain\n$dnslist_text
32400 .endd
32401 For the first blacklist item, this starts by doing a lookup in
32402 &'sbl-xbl.spamhaus.org'& and testing for a 127.0.0.2 return. If there is a
32403 match, it then looks in &'sbl.spamhaus.org'&, without checking the return
32404 value, and as long as something is found, it looks for the corresponding TXT
32405 record. If there is no match in &'sbl-xbl.spamhaus.org'&, nothing more is done.
32406 The second blacklist item is processed similarly.
32407
32408 If you are interested in more than one merged list, the same list must be
32409 given several times, but because the results of the DNS lookups are cached,
32410 the DNS calls themselves are not repeated. For example:
32411 .code
32412 deny dnslists = \
32413          http.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.2 : \
32414          socks.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.3 : \
32415          misc.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.4 : \
32416          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
32417 .endd
32418 In this case there is one lookup in &'dnsbl.sorbs.net'&, and if none of the IP
32419 values matches (or if no record is found), this is the only lookup that is
32420 done. Only if there is a match is one of the more specific lists consulted.
32421
32422
32423
32424 .section "DNS lists and IPv6" "SECTmorednslistslast"
32425 .cindex "IPv6" "DNS black lists"
32426 .cindex "DNS list" "IPv6 usage"
32427 If Exim is asked to do a dnslist lookup for an IPv6 address, it inverts it
32428 nibble by nibble. For example, if the calling host's IP address is
32429 3ffe:ffff:836f:0a00:000a:0800:200a:c031, Exim might look up
32430 .code
32431 1.3.0.c.a.0.0.2.0.0.8.0.a.0.0.0.0.0.a.0.f.6.3.8.
32432   f.f.f.f.e.f.f.3.blackholes.mail-abuse.org
32433 .endd
32434 (split over two lines here to fit on the page). Unfortunately, some of the DNS
32435 lists contain wildcard records, intended for IPv4, that interact badly with
32436 IPv6. For example, the DNS entry
32437 .code
32438 *.3.some.list.example.    A    127.0.0.1
32439 .endd
32440 is probably intended to put the entire 3.0.0.0/8 IPv4 network on the list.
32441 Unfortunately, it also matches the entire 3::/4 IPv6 network.
32442
32443 You can exclude IPv6 addresses from DNS lookups by making use of a suitable
32444 &%condition%& condition, as in this example:
32445 .code
32446 deny   condition = ${if isip4{$sender_host_address}}
32447        dnslists  = some.list.example
32448 .endd
32449
32450 If an explicit key is being used for a DNS lookup and it may be an IPv6
32451 address you should specify alternate list separators for both the outer
32452 (DNS list name) list and inner (lookup keys) list:
32453 .code
32454        dnslists = <; dnsbl.example.com/<|$acl_m_addrslist
32455 .endd
32456
32457 .section "Rate limiting incoming messages" "SECTratelimiting"
32458 .cindex "rate limiting" "client sending"
32459 .cindex "limiting client sending rates"
32460 .oindex "&%smtp_ratelimit_*%&"
32461 The &%ratelimit%& ACL condition can be used to measure and control the rate at
32462 which clients can send email. This is more powerful than the
32463 &%smtp_ratelimit_*%& options, because those options control the rate of
32464 commands in a single SMTP session only, whereas the &%ratelimit%& condition
32465 works across all connections (concurrent and sequential) from the same client
32466 host. The syntax of the &%ratelimit%& condition is:
32467 .display
32468 &`ratelimit =`& <&'m'&> &`/`& <&'p'&> &`/`& <&'options'&> &`/`& <&'key'&>
32469 .endd
32470 If the average client sending rate is less than &'m'& messages per time
32471 period &'p'& then the condition is false; otherwise it is true.
32472
32473 As a side-effect, the &%ratelimit%& condition sets the expansion variable
32474 &$sender_rate$& to the client's computed rate, &$sender_rate_limit$& to the
32475 configured value of &'m'&, and &$sender_rate_period$& to the configured value
32476 of &'p'&.
32477
32478 The parameter &'p'& is the smoothing time constant, in the form of an Exim
32479 time interval, for example, &`8h`& for eight hours. A larger time constant
32480 means that it takes Exim longer to forget a client's past behaviour. The
32481 parameter &'m'& is the maximum number of messages that a client is permitted to
32482 send in each time interval. It also specifies the number of messages permitted
32483 in a fast burst. By increasing both &'m'& and &'p'& but keeping &'m/p'&
32484 constant, you can allow a client to send more messages in a burst without
32485 changing its long-term sending rate limit. Conversely, if &'m'& and &'p'& are
32486 both small, messages must be sent at an even rate.
32487
32488 There is a script in &_util/ratelimit.pl_& which extracts sending rates from
32489 log files, to assist with choosing appropriate settings for &'m'& and &'p'&
32490 when deploying the &%ratelimit%& ACL condition. The script prints usage
32491 instructions when it is run with no arguments.
32492
32493 The key is used to look up the data for calculating the client's average
32494 sending rate. This data is stored in Exim's spool directory, alongside the
32495 retry and other hints databases. The default key is &$sender_host_address$&,
32496 which means Exim computes the sending rate of each client host IP address.
32497 By changing the key you can change how Exim identifies clients for the purpose
32498 of ratelimiting. For example, to limit the sending rate of each authenticated
32499 user, independent of the computer they are sending from, set the key to
32500 &$authenticated_id$&. You must ensure that the lookup key is meaningful; for
32501 example, &$authenticated_id$& is only meaningful if the client has
32502 authenticated (which you can check with the &%authenticated%& ACL condition).
32503
32504 The lookup key does not have to identify clients: If you want to limit the
32505 rate at which a recipient receives messages, you can use the key
32506 &`$local_part@$domain`& with the &%per_rcpt%& option (see below) in a RCPT
32507 ACL.
32508
32509 Each &%ratelimit%& condition can have up to four options. A &%per_*%& option
32510 specifies what Exim measures the rate of, for example, messages or recipients
32511 or bytes. You can adjust the measurement using the &%unique=%& and/or
32512 &%count=%& options. You can also control when Exim updates the recorded rate
32513 using a &%strict%&, &%leaky%&, or &%readonly%& option. The options are
32514 separated by a slash, like the other parameters. They may appear in any order.
32515
32516 Internally, Exim appends the smoothing constant &'p'& onto the lookup key with
32517 any options that alter the meaning of the stored data. The limit &'m'& is not
32518 stored, so you can alter the configured maximum rate and Exim will still
32519 remember clients' past behaviour. If you change the &%per_*%& mode or add or
32520 remove the &%unique=%& option, the lookup key changes so Exim will forget past
32521 behaviour. The lookup key is not affected by changes to the update mode and
32522 the &%count=%& option.
32523
32524
32525 .section "Ratelimit options for what is being measured" "ratoptmea"
32526 .cindex "rate limiting" "per_* options"
32527 The &%per_conn%& option limits the client's connection rate. It is not
32528 normally used in the &%acl_not_smtp%&, &%acl_not_smtp_mime%&, or
32529 &%acl_not_smtp_start%& ACLs.
32530
32531 The &%per_mail%& option limits the client's rate of sending messages. This is
32532 the default if none of the &%per_*%& options is specified. It can be used in
32533 &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&, &%acl_smtp_mime%&,
32534 &%acl_smtp_data%&, or &%acl_not_smtp%&.
32535
32536 The &%per_byte%& option limits the sender's email bandwidth. It can be used in
32537 the same ACLs as the &%per_mail%& option, though it is best to use this option
32538 in the &%acl_smtp_mime%&, &%acl_smtp_data%& or &%acl_not_smtp%& ACLs; if it is
32539 used in an earlier ACL, Exim relies on the SIZE parameter given by the client
32540 in its MAIL command, which may be inaccurate or completely missing. You can
32541 follow the limit &'m'& in the configuration with K, M, or G to specify limits
32542 in kilobytes, megabytes, or gigabytes, respectively.
32543
32544 The &%per_rcpt%& option causes Exim to limit the rate at which recipients are
32545 accepted. It can be used in the &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
32546 &%acl_smtp_mime%&, &%acl_smtp_data%&, or &%acl_smtp_rcpt%& ACLs. In
32547 &%acl_smtp_rcpt%& the rate is updated one recipient at a time; in the other
32548 ACLs the rate is updated with the total (accepted) recipient count in one go. Note that
32549 in either case the rate limiting engine will see a message with many
32550 recipients as a large high-speed burst.
32551
32552 The &%per_addr%& option is like the &%per_rcpt%& option, except it counts the
32553 number of different recipients that the client has sent messages to in the
32554 last time period. That is, if the client repeatedly sends messages to the same
32555 recipient, its measured rate is not increased. This option can only be used in
32556 &%acl_smtp_rcpt%&.
32557
32558 The &%per_cmd%& option causes Exim to recompute the rate every time the
32559 condition is processed. This can be used to limit the rate of any SMTP
32560 command. If it is used in multiple ACLs it can limit the aggregate rate of
32561 multiple different commands.
32562
32563 The &%count=%& option can be used to alter how much Exim adds to the client's
32564 measured rate. For example, the &%per_byte%& option is equivalent to
32565 &`per_mail/count=$message_size`&. If there is no &%count=%& option, Exim
32566 increases the measured rate by one (except for the &%per_rcpt%& option in ACLs
32567 other than &%acl_smtp_rcpt%&). The count does not have to be an integer.
32568
32569 The &%unique=%& option is described in section &<<ratoptuniq>>& below.
32570
32571
32572 .section "Ratelimit update modes" "ratoptupd"
32573 .cindex "rate limiting" "reading data without updating"
32574 You can specify one of three options with the &%ratelimit%& condition to
32575 control when its database is updated. This section describes the &%readonly%&
32576 mode, and the next section describes the &%strict%& and &%leaky%& modes.
32577
32578 If the &%ratelimit%& condition is used in &%readonly%& mode, Exim looks up a
32579 previously-computed rate to check against the limit.
32580
32581 For example, you can test the client's sending rate and deny it access (when
32582 it is too fast) in the connect ACL. If the client passes this check then it
32583 can go on to send a message, in which case its recorded rate will be updated
32584 in the MAIL ACL. Subsequent connections from the same client will check this
32585 new rate.
32586 .code
32587 acl_check_connect:
32588  deny ratelimit = 100 / 5m / readonly
32589       log_message = RATE CHECK: $sender_rate/$sender_rate_period \
32590                   (max $sender_rate_limit)
32591 # ...
32592 acl_check_mail:
32593  warn ratelimit = 100 / 5m / strict
32594       log_message = RATE UPDATE: $sender_rate/$sender_rate_period \
32595                   (max $sender_rate_limit)
32596 .endd
32597
32598 If Exim encounters multiple &%ratelimit%& conditions with the same key when
32599 processing a message then it may increase the client's measured rate more than
32600 it should. For example, this will happen if you check the &%per_rcpt%& option
32601 in both &%acl_smtp_rcpt%& and &%acl_smtp_data%&. However it's OK to check the
32602 same &%ratelimit%& condition multiple times in the same ACL. You can avoid any
32603 multiple update problems by using the &%readonly%& option on later ratelimit
32604 checks.
32605
32606 The &%per_*%& options described above do not make sense in some ACLs. If you
32607 use a &%per_*%& option in an ACL where it is not normally permitted then the
32608 update mode defaults to &%readonly%& and you cannot specify the &%strict%& or
32609 &%leaky%& modes. In other ACLs the default update mode is &%leaky%& (see the
32610 next section) so you must specify the &%readonly%& option explicitly.
32611
32612
32613 .section "Ratelimit options for handling fast clients" "ratoptfast"
32614 .cindex "rate limiting" "strict and leaky modes"
32615 If a client's average rate is greater than the maximum, the rate limiting
32616 engine can react in two possible ways, depending on the presence of the
32617 &%strict%& or &%leaky%& update modes. This is independent of the other
32618 counter-measures (such as rejecting the message) that may be specified by the
32619 rest of the ACL.
32620
32621 The &%leaky%& (default) option means that the client's recorded rate is not
32622 updated if it is above the limit. The effect of this is that Exim measures the
32623 client's average rate of successfully sent email,
32624 up to the given limit.
32625 This is appropriate if the countermeasure when the condition is true
32626 consists of refusing the message, and
32627 is generally the better choice if you have clients that retry automatically.
32628 If the action when true is anything more complex then this option is
32629 likely not what is wanted.
32630
32631 The &%strict%& option means that the client's recorded rate is always
32632 updated. The effect of this is that Exim measures the client's average rate
32633 of attempts to send email, which can be much higher than the maximum it is
32634 actually allowed. If the client is over the limit it may be subjected to
32635 counter-measures by the ACL. It must slow down and allow sufficient time to
32636 pass that its computed rate falls below the maximum before it can send email
32637 again. The time (the number of smoothing periods) it must wait and not
32638 attempt to send mail can be calculated with this formula:
32639 .code
32640         ln(peakrate/maxrate)
32641 .endd
32642
32643
32644 .section "Limiting the rate of different events" "ratoptuniq"
32645 .cindex "rate limiting" "counting unique events"
32646 The &%ratelimit%& &%unique=%& option controls a mechanism for counting the
32647 rate of different events. For example, the &%per_addr%& option uses this
32648 mechanism to count the number of different recipients that the client has
32649 sent messages to in the last time period; it is equivalent to
32650 &`per_rcpt/unique=$local_part@$domain`&. You could use this feature to
32651 measure the rate that a client uses different sender addresses with the
32652 options &`per_mail/unique=$sender_address`&.
32653
32654 For each &%ratelimit%& key Exim stores the set of &%unique=%& values that it
32655 has seen for that key. The whole set is thrown away when it is older than the
32656 rate smoothing period &'p'&, so each different event is counted at most once
32657 per period. In the &%leaky%& update mode, an event that causes the client to
32658 go over the limit is not added to the set, in the same way that the client's
32659 recorded rate is not updated in the same situation.
32660
32661 When you combine the &%unique=%& and &%readonly%& options, the specific
32662 &%unique=%& value is ignored, and Exim just retrieves the client's stored
32663 rate.
32664
32665 The &%unique=%& mechanism needs more space in the ratelimit database than the
32666 other &%ratelimit%& options in order to store the event set. The number of
32667 unique values is potentially as large as the rate limit, so the extra space
32668 required increases with larger limits.
32669
32670 The uniqueification is not perfect: there is a small probability that Exim
32671 will think a new event has happened before. If the sender's rate is less than
32672 the limit, Exim should be more than 99.9% correct. However in &%strict%& mode
32673 the measured rate can go above the limit, in which case Exim may under-count
32674 events by a significant margin. Fortunately, if the rate is high enough (2.7
32675 times the limit) that the false positive rate goes above 9%, then Exim will
32676 throw away the over-full event set before the measured rate falls below the
32677 limit. Therefore the only harm should be that exceptionally high sending rates
32678 are logged incorrectly; any countermeasures you configure will be as effective
32679 as intended.
32680
32681
32682 .section "Using rate limiting" "useratlim"
32683 Exim's other ACL facilities are used to define what counter-measures are taken
32684 when the rate limit is exceeded. This might be anything from logging a warning
32685 (for example, while measuring existing sending rates in order to define
32686 policy), through time delays to slow down fast senders, up to rejecting the
32687 message. For example:
32688 .code
32689 # Log all senders' rates
32690 warn ratelimit = 0 / 1h / strict
32691      log_message = Sender rate $sender_rate / $sender_rate_period
32692
32693 # Slow down fast senders; note the need to truncate $sender_rate
32694 # at the decimal point.
32695 warn ratelimit = 100 / 1h / per_rcpt / strict
32696      delay     = ${eval: ${sg{$sender_rate}{[.].*}{}} - \
32697                    $sender_rate_limit }s
32698
32699 # Keep authenticated users under control
32700 deny authenticated = *
32701      ratelimit = 100 / 1d / strict / $authenticated_id
32702
32703 # System-wide rate limit
32704 defer ratelimit = 10 / 1s / $primary_hostname
32705       message = Sorry, too busy. Try again later.
32706
32707 # Restrict incoming rate from each host, with a default
32708 # set using a macro and special cases looked up in a table.
32709 defer ratelimit = ${lookup {$sender_host_address} \
32710                    cdb {DB/ratelimits.cdb} \
32711                    {$value} {RATELIMIT} }
32712       message = Sender rate exceeds $sender_rate_limit \
32713                messages per $sender_rate_period
32714 .endd
32715 &*Warning*&: If you have a busy server with a lot of &%ratelimit%& tests,
32716 especially with the &%per_rcpt%& option, you may suffer from a performance
32717 bottleneck caused by locking on the ratelimit hints database. Apart from
32718 making your ACLs less complicated, you can reduce the problem by using a
32719 RAM disk for Exim's hints directory (usually &_/var/spool/exim/db/_&). However
32720 this means that Exim will lose its hints data after a reboot (including retry
32721 hints, the callout cache, and ratelimit data).
32722
32723
32724
32725 .section "Address verification" "SECTaddressverification"
32726 .cindex "verifying address" "options for"
32727 .cindex "policy control" "address verification"
32728 Several of the &%verify%& conditions described in section
32729 &<<SECTaclconditions>>& cause addresses to be verified. Section
32730 &<<SECTsenaddver>>& discusses the reporting of sender verification failures.
32731 The verification conditions can be followed by options that modify the
32732 verification process. The options are separated from the keyword and from each
32733 other by slashes, and some of them contain parameters. For example:
32734 .code
32735 verify = sender/callout
32736 verify = recipient/defer_ok/callout=10s,defer_ok
32737 .endd
32738 The first stage of address verification, which always happens, is to run the
32739 address through the routers, in &"verify mode"&. Routers can detect the
32740 difference between verification and routing for delivery, and their actions can
32741 be varied by a number of generic options such as &%verify%& and &%verify_only%&
32742 (see chapter &<<CHAProutergeneric>>&). If routing fails, verification fails.
32743 The available options are as follows:
32744
32745 .ilist
32746 If the &%callout%& option is specified, successful routing to one or more
32747 remote hosts is followed by a &"callout"& to those hosts as an additional
32748 check. Callouts and their sub-options are discussed in the next section.
32749 .next
32750 If there is a defer error while doing verification routing, the ACL
32751 normally returns &"defer"&. However, if you include &%defer_ok%& in the
32752 options, the condition is forced to be true instead. Note that this is a main
32753 verification option as well as a suboption for callouts.
32754 .next
32755 The &%no_details%& option is covered in section &<<SECTsenaddver>>&, which
32756 discusses the reporting of sender address verification failures.
32757 .next
32758 The &%success_on_redirect%& option causes verification always to succeed
32759 immediately after a successful redirection. By default, if a redirection
32760 generates just one address, that address is also verified. See further
32761 discussion in section &<<SECTredirwhilveri>>&.
32762 .new
32763 .next
32764 If the &%quota%& option is specified for recipient verify,
32765 successful routing to an appendfile transport is followed by a call into
32766 the transport to evaluate the quota status for the recipient.
32767 No actual delivery is done, but verification will succeed if the quota
32768 is sufficient for the message (if the sender gave a message size) or
32769 not already exceeded (otherwise).
32770 .wen
32771 .endlist
32772
32773 .cindex "verifying address" "differentiating failures"
32774 .vindex "&$recipient_verify_failure$&"
32775 .vindex "&$sender_verify_failure$&"
32776 .vindex "&$acl_verify_message$&"
32777 After an address verification failure, &$acl_verify_message$& contains the
32778 error message that is associated with the failure. It can be preserved by
32779 coding like this:
32780 .code
32781 warn  !verify = sender
32782        set acl_m0 = $acl_verify_message
32783 .endd
32784 If you are writing your own custom rejection message or log message when
32785 denying access, you can use this variable to include information about the
32786 verification failure.
32787
32788 In addition, &$sender_verify_failure$& or &$recipient_verify_failure$& (as
32789 appropriate) contains one of the following words:
32790
32791 .ilist
32792 &%qualify%&: The address was unqualified (no domain), and the message
32793 was neither local nor came from an exempted host.
32794 .next
32795 &%route%&: Routing failed.
32796 .next
32797 &%mail%&: Routing succeeded, and a callout was attempted; rejection
32798 occurred at or before the MAIL command (that is, on initial
32799 connection, HELO, or MAIL).
32800 .next
32801 &%recipient%&: The RCPT command in a callout was rejected.
32802 .next
32803 &%postmaster%&: The postmaster check in a callout was rejected.
32804 .new
32805 .next
32806 &%quota%&: The quota check for a local recipient did non pass.
32807 .endlist
32808
32809 The main use of these variables is expected to be to distinguish between
32810 rejections of MAIL and rejections of RCPT in callouts.
32811
32812 The above variables may also be set after a &*successful*&
32813 address verification to:
32814
32815 .ilist
32816 &%random%&: A random local-part callout succeeded
32817 .endlist
32818
32819
32820
32821
32822 .section "Callout verification" "SECTcallver"
32823 .cindex "verifying address" "by callout"
32824 .cindex "callout" "verification"
32825 .cindex "SMTP" "callout verification"
32826 For non-local addresses, routing verifies the domain, but is unable to do any
32827 checking of the local part. There are situations where some means of verifying
32828 the local part is desirable. One way this can be done is to make an SMTP
32829 &'callback'& to a delivery host for the sender address or a &'callforward'& to
32830 a subsequent host for a recipient address, to see if the host accepts the
32831 address. We use the term &'callout'& to cover both cases. Note that for a
32832 sender address, the callback is not to the client host that is trying to
32833 deliver the message, but to one of the hosts that accepts incoming mail for the
32834 sender's domain.
32835
32836 Exim does not do callouts by default. If you want them to happen, you must
32837 request them by setting appropriate options on the &%verify%& condition, as
32838 described below. This facility should be used with care, because it can add a
32839 lot of resource usage to the cost of verifying an address. However, Exim does
32840 cache the results of callouts, which helps to reduce the cost. Details of
32841 caching are in section &<<SECTcallvercache>>&.
32842
32843 Recipient callouts are usually used only between hosts that are controlled by
32844 the same administration. For example, a corporate gateway host could use
32845 callouts to check for valid recipients on an internal mailserver. A successful
32846 callout does not guarantee that a real delivery to the address would succeed;
32847 on the other hand, a failing callout does guarantee that a delivery would fail.
32848
32849 If the &%callout%& option is present on a condition that verifies an address, a
32850 second stage of verification occurs if the address is successfully routed to
32851 one or more remote hosts. The usual case is routing by a &(dnslookup)& or a
32852 &(manualroute)& router, where the router specifies the hosts. However, if a
32853 router that does not set up hosts routes to an &(smtp)& transport with a
32854 &%hosts%& setting, the transport's hosts are used. If an &(smtp)& transport has
32855 &%hosts_override%& set, its hosts are always used, whether or not the router
32856 supplies a host list.
32857 Callouts are only supported on &(smtp)& transports.
32858
32859 The port that is used is taken from the transport, if it is specified and is a
32860 remote transport. (For routers that do verification only, no transport need be
32861 specified.) Otherwise, the default SMTP port is used. If a remote transport
32862 specifies an outgoing interface, this is used; otherwise the interface is not
32863 specified. Likewise, the text that is used for the HELO command is taken from
32864 the transport's &%helo_data%& option; if there is no transport, the value of
32865 &$smtp_active_hostname$& is used.
32866
32867 For a sender callout check, Exim makes SMTP connections to the remote hosts, to
32868 test whether a bounce message could be delivered to the sender address. The
32869 following SMTP commands are sent:
32870 .display
32871 &`HELO `&<&'local host name'&>
32872 &`MAIL FROM:<>`&
32873 &`RCPT TO:`&<&'the address to be tested'&>
32874 &`QUIT`&
32875 .endd
32876 LHLO is used instead of HELO if the transport's &%protocol%& option is
32877 set to &"lmtp"&.
32878
32879 The callout may use EHLO, AUTH and/or STARTTLS given appropriate option
32880 settings.
32881
32882 A recipient callout check is similar. By default, it also uses an empty address
32883 for the sender. This default is chosen because most hosts do not make use of
32884 the sender address when verifying a recipient. Using the same address means
32885 that a single cache entry can be used for each recipient. Some sites, however,
32886 do make use of the sender address when verifying. These are catered for by the
32887 &%use_sender%& and &%use_postmaster%& options, described in the next section.
32888
32889 If the response to the RCPT command is a 2&'xx'& code, the verification
32890 succeeds. If it is 5&'xx'&, the verification fails. For any other condition,
32891 Exim tries the next host, if any. If there is a problem with all the remote
32892 hosts, the ACL yields &"defer"&, unless the &%defer_ok%& parameter of the
32893 &%callout%& option is given, in which case the condition is forced to succeed.
32894
32895 .cindex "SMTP" "output flushing, disabling for callout"
32896 A callout may take a little time. For this reason, Exim normally flushes SMTP
32897 output before performing a callout in an ACL, to avoid unexpected timeouts in
32898 clients when the SMTP PIPELINING extension is in use. The flushing can be
32899 disabled by using a &%control%& modifier to set &%no_callout_flush%&.
32900
32901
32902
32903
32904 .section "Additional parameters for callouts" "CALLaddparcall"
32905 .cindex "callout" "additional parameters for"
32906 The &%callout%& option can be followed by an equals sign and a number of
32907 optional parameters, separated by commas. For example:
32908 .code
32909 verify = recipient/callout=10s,defer_ok
32910 .endd
32911 The old syntax, which had &%callout_defer_ok%& and &%check_postmaster%& as
32912 separate verify options, is retained for backwards compatibility, but is now
32913 deprecated. The additional parameters for &%callout%& are as follows:
32914
32915
32916 .vlist
32917 .vitem <&'a&~time&~interval'&>
32918 .cindex "callout" "timeout, specifying"
32919 This specifies the timeout that applies for the callout attempt to each host.
32920 For example:
32921 .code
32922 verify = sender/callout=5s
32923 .endd
32924 The default is 30 seconds. The timeout is used for each response from the
32925 remote host. It is also used for the initial connection, unless overridden by
32926 the &%connect%& parameter.
32927
32928
32929 .vitem &*connect&~=&~*&<&'time&~interval'&>
32930 .cindex "callout" "connection timeout, specifying"
32931 This parameter makes it possible to set a different (usually smaller) timeout
32932 for making the SMTP connection. For example:
32933 .code
32934 verify = sender/callout=5s,connect=1s
32935 .endd
32936 If not specified, this timeout defaults to the general timeout value.
32937
32938 .vitem &*defer_ok*&
32939 .cindex "callout" "defer, action on"
32940 When this parameter is present, failure to contact any host, or any other kind
32941 of temporary error, is treated as success by the ACL. However, the cache is not
32942 updated in this circumstance.
32943
32944 .vitem &*fullpostmaster*&
32945 .cindex "callout" "full postmaster check"
32946 This operates like the &%postmaster%& option (see below), but if the check for
32947 &'postmaster@domain'& fails, it tries just &'postmaster'&, without a domain, in
32948 accordance with the specification in RFC 2821. The RFC states that the
32949 unqualified address &'postmaster'& should be accepted.
32950
32951
32952 .vitem &*mailfrom&~=&~*&<&'email&~address'&>
32953 .cindex "callout" "sender when verifying header"
32954 When verifying addresses in header lines using the &%header_sender%&
32955 verification option, Exim behaves by default as if the addresses are envelope
32956 sender addresses from a message. Callout verification therefore tests to see
32957 whether a bounce message could be delivered, by using an empty address in the
32958 MAIL command. However, it is arguable that these addresses might never be used
32959 as envelope senders, and could therefore justifiably reject bounce messages
32960 (empty senders). The &%mailfrom%& callout parameter allows you to specify what
32961 address to use in the MAIL command. For example:
32962 .code
32963 require  verify = header_sender/callout=mailfrom=abcd@x.y.z
32964 .endd
32965 This parameter is available only for the &%header_sender%& verification option.
32966
32967
32968 .vitem &*maxwait&~=&~*&<&'time&~interval'&>
32969 .cindex "callout" "overall timeout, specifying"
32970 This parameter sets an overall timeout for performing a callout verification.
32971 For example:
32972 .code
32973 verify = sender/callout=5s,maxwait=30s
32974 .endd
32975 This timeout defaults to four times the callout timeout for individual SMTP
32976 commands. The overall timeout applies when there is more than one host that can
32977 be tried. The timeout is checked before trying the next host. This prevents
32978 very long delays if there are a large number of hosts and all are timing out
32979 (for example, when network connections are timing out).
32980
32981
32982 .vitem &*no_cache*&
32983 .cindex "callout" "cache, suppressing"
32984 .cindex "caching callout, suppressing"
32985 When this parameter is given, the callout cache is neither read nor updated.
32986
32987 .vitem &*postmaster*&
32988 .cindex "callout" "postmaster; checking"
32989 When this parameter is set, a successful callout check is followed by a similar
32990 check for the local part &'postmaster'& at the same domain. If this address is
32991 rejected, the callout fails (but see &%fullpostmaster%& above). The result of
32992 the postmaster check is recorded in a cache record; if it is a failure, this is
32993 used to fail subsequent callouts for the domain without a connection being
32994 made, until the cache record expires.
32995
32996 .vitem &*postmaster_mailfrom&~=&~*&<&'email&~address'&>
32997 The postmaster check uses an empty sender in the MAIL command by default.
32998 You can use this parameter to do a postmaster check using a different address.
32999 For example:
33000 .code
33001 require  verify = sender/callout=postmaster_mailfrom=abc@x.y.z
33002 .endd
33003 If both &%postmaster%& and &%postmaster_mailfrom%& are present, the rightmost
33004 one overrides. The &%postmaster%& parameter is equivalent to this example:
33005 .code
33006 require  verify = sender/callout=postmaster_mailfrom=
33007 .endd
33008 &*Warning*&: The caching arrangements for postmaster checking do not take
33009 account of the sender address. It is assumed that either the empty address or
33010 a fixed non-empty address will be used. All that Exim remembers is that the
33011 postmaster check for the domain succeeded or failed.
33012
33013
33014 .vitem &*random*&
33015 .cindex "callout" "&""random""& check"
33016 When this parameter is set, before doing the normal callout check, Exim does a
33017 check for a &"random"& local part at the same domain. The local part is not
33018 really random &-- it is defined by the expansion of the option
33019 &%callout_random_local_part%&, which defaults to
33020 .code
33021 $primary_hostname-$tod_epoch-testing
33022 .endd
33023 The idea here is to try to determine whether the remote host accepts all local
33024 parts without checking. If it does, there is no point in doing callouts for
33025 specific local parts. If the &"random"& check succeeds, the result is saved in
33026 a cache record, and used to force the current and subsequent callout checks to
33027 succeed without a connection being made, until the cache record expires.
33028
33029 .vitem &*use_postmaster*&
33030 .cindex "callout" "sender for recipient check"
33031 This parameter applies to recipient callouts only. For example:
33032 .code
33033 deny  !verify = recipient/callout=use_postmaster
33034 .endd
33035 .vindex "&$qualify_domain$&"
33036 It causes a non-empty postmaster address to be used in the MAIL command when
33037 performing the callout for the recipient, and also for a &"random"& check if
33038 that is configured. The local part of the address is &`postmaster`& and the
33039 domain is the contents of &$qualify_domain$&.
33040
33041 .vitem &*use_sender*&
33042 This option applies to recipient callouts only. For example:
33043 .code
33044 require  verify = recipient/callout=use_sender
33045 .endd
33046 It causes the message's actual sender address to be used in the MAIL
33047 command when performing the callout, instead of an empty address. There is no
33048 need to use this option unless you know that the called hosts make use of the
33049 sender when checking recipients. If used indiscriminately, it reduces the
33050 usefulness of callout caching.
33051
33052 .vitem &*hold*&
33053 This option applies to recipient callouts only. For example:
33054 .code
33055 require  verify = recipient/callout=use_sender,hold
33056 .endd
33057 It causes the connection to be held open and used for any further recipients
33058 and for eventual delivery (should that be done quickly).
33059 Doing this saves on TCP and SMTP startup costs, and TLS costs also
33060 when that is used for the connections.
33061 The advantage is only gained if there are no callout cache hits
33062 (which could be enforced by the no_cache option),
33063 if the use_sender option is used,
33064 if neither the random nor the use_postmaster option is used,
33065 and if no other callouts intervene.
33066 .endlist
33067
33068 If you use any of the parameters that set a non-empty sender for the MAIL
33069 command (&%mailfrom%&, &%postmaster_mailfrom%&, &%use_postmaster%&, or
33070 &%use_sender%&), you should think about possible loops. Recipient checking is
33071 usually done between two hosts that are under the same management, and the host
33072 that receives the callouts is not normally configured to do callouts itself.
33073 Therefore, it is normally safe to use &%use_postmaster%& or &%use_sender%& in
33074 these circumstances.
33075
33076 However, if you use a non-empty sender address for a callout to an arbitrary
33077 host, there is the likelihood that the remote host will itself initiate a
33078 callout check back to your host. As it is checking what appears to be a message
33079 sender, it is likely to use an empty address in MAIL, thus avoiding a
33080 callout loop. However, to be on the safe side it would be best to set up your
33081 own ACLs so that they do not do sender verification checks when the recipient
33082 is the address you use for header sender or postmaster callout checking.
33083
33084 Another issue to think about when using non-empty senders for callouts is
33085 caching. When you set &%mailfrom%& or &%use_sender%&, the cache record is keyed
33086 by the sender/recipient combination; thus, for any given recipient, many more
33087 actual callouts are performed than when an empty sender or postmaster is used.
33088
33089
33090
33091
33092 .section "Callout caching" "SECTcallvercache"
33093 .cindex "hints database" "callout cache"
33094 .cindex "callout" "cache, description of"
33095 .cindex "caching" "callout"
33096 Exim caches the results of callouts in order to reduce the amount of resources
33097 used, unless you specify the &%no_cache%& parameter with the &%callout%&
33098 option. A hints database called &"callout"& is used for the cache. Two
33099 different record types are used: one records the result of a callout check for
33100 a specific address, and the other records information that applies to the
33101 entire domain (for example, that it accepts the local part &'postmaster'&).
33102
33103 When an original callout fails, a detailed SMTP error message is given about
33104 the failure. However, for subsequent failures use the cache data, this message
33105 is not available.
33106
33107 The expiry times for negative and positive address cache records are
33108 independent, and can be set by the global options &%callout_negative_expire%&
33109 (default 2h) and &%callout_positive_expire%& (default 24h), respectively.
33110
33111 If a host gives a negative response to an SMTP connection, or rejects any
33112 commands up to and including
33113 .code
33114 MAIL FROM:<>
33115 .endd
33116 (but not including the MAIL command with a non-empty address),
33117 any callout attempt is bound to fail. Exim remembers such failures in a
33118 domain cache record, which it uses to fail callouts for the domain without
33119 making new connections, until the domain record times out. There are two
33120 separate expiry times for domain cache records:
33121 &%callout_domain_negative_expire%& (default 3h) and
33122 &%callout_domain_positive_expire%& (default 7d).
33123
33124 Domain records expire when the negative expiry time is reached if callouts
33125 cannot be made for the domain, or if the postmaster check failed.
33126 Otherwise, they expire when the positive expiry time is reached. This
33127 ensures that, for example, a host that stops accepting &"random"& local parts
33128 will eventually be noticed.
33129
33130 The callout caching mechanism is based on the domain of the address that is
33131 being tested. If the domain routes to several hosts, it is assumed that their
33132 behaviour will be the same.
33133
33134
33135
33136 .new
33137 .section "Quota caching" "SECTquotacache"
33138 .cindex "hints database" "quota cache"
33139 .cindex "quota" "cache, description of"
33140 .cindex "caching" "quota"
33141 Exim caches the results of quota verification
33142 in order to reduce the amount of resources used.
33143 The &"callout"& hints database is used.
33144
33145 The default cache periods are five minutes for a positive (good) result
33146 and one hour for a negative result.
33147 To change the periods the &%quota%& option can be followed by an equals sign
33148 and a number of optional paramemters, separated by commas.
33149 For example:
33150 .code
33151 verify = recipient/quota=cachepos=1h,cacheneg=1d
33152 .endd
33153 Possible parameters are:
33154 .vlist
33155 .vitem &*cachepos&~=&~*&<&'time&~interval'&>
33156 .cindex "quota cache" "positive entry expiry, specifying"
33157 Set the lifetime for a positive cache entry.
33158 A value of zero seconds is legitimate.
33159
33160 .vitem &*cacheneg&~=&~*&<&'time&~interval'&>
33161 .cindex "quota cache" "negative entry expiry, specifying"
33162 As above, for a negative entry.
33163
33164 .vitem &*no_cache*&
33165 Set both positive and negative lifetimes to zero.
33166 .wen
33167
33168 .section "Sender address verification reporting" "SECTsenaddver"
33169 .cindex "verifying" "suppressing error details"
33170 See section &<<SECTaddressverification>>& for a general discussion of
33171 verification. When sender verification fails in an ACL, the details of the
33172 failure are given as additional output lines before the 550 response to the
33173 relevant SMTP command (RCPT or DATA). For example, if sender callout is in use,
33174 you might see:
33175 .code
33176 MAIL FROM:<xyz@abc.example>
33177 250 OK
33178 RCPT TO:<pqr@def.example>
33179 550-Verification failed for <xyz@abc.example>
33180 550-Called:   192.168.34.43
33181 550-Sent:     RCPT TO:<xyz@abc.example>
33182 550-Response: 550 Unknown local part xyz in <xyz@abc.example>
33183 550 Sender verification failed
33184 .endd
33185 If more than one RCPT command fails in the same way, the details are given
33186 only for the first of them. However, some administrators do not want to send
33187 out this much information. You can suppress the details by adding
33188 &`/no_details`& to the ACL statement that requests sender verification. For
33189 example:
33190 .code
33191 verify = sender/no_details
33192 .endd
33193
33194 .section "Redirection while verifying" "SECTredirwhilveri"
33195 .cindex "verifying" "redirection while"
33196 .cindex "address redirection" "while verifying"
33197 A dilemma arises when a local address is redirected by aliasing or forwarding
33198 during verification: should the generated addresses themselves be verified,
33199 or should the successful expansion of the original address be enough to verify
33200 it? By default, Exim takes the following pragmatic approach:
33201
33202 .ilist
33203 When an incoming address is redirected to just one child address, verification
33204 continues with the child address, and if that fails to verify, the original
33205 verification also fails.
33206 .next
33207 When an incoming address is redirected to more than one child address,
33208 verification does not continue. A success result is returned.
33209 .endlist
33210
33211 This seems the most reasonable behaviour for the common use of aliasing as a
33212 way of redirecting different local parts to the same mailbox. It means, for
33213 example, that a pair of alias entries of the form
33214 .code
33215 A.Wol:   aw123
33216 aw123:   :fail: Gone away, no forwarding address
33217 .endd
33218 work as expected, with both local parts causing verification failure. When a
33219 redirection generates more than one address, the behaviour is more like a
33220 mailing list, where the existence of the alias itself is sufficient for
33221 verification to succeed.
33222
33223 It is possible, however, to change the default behaviour so that all successful
33224 redirections count as successful verifications, however many new addresses are
33225 generated. This is specified by the &%success_on_redirect%& verification
33226 option. For example:
33227 .code
33228 require verify = recipient/success_on_redirect/callout=10s
33229 .endd
33230 In this example, verification succeeds if a router generates a new address, and
33231 the callout does not occur, because no address was routed to a remote host.
33232
33233 When verification is being tested via the &%-bv%& option, the treatment of
33234 redirections is as just described, unless the &%-v%& or any debugging option is
33235 also specified. In that case, full verification is done for every generated
33236 address and a report is output for each of them.
33237
33238
33239
33240 .section "Client SMTP authorization (CSA)" "SECTverifyCSA"
33241 .cindex "CSA" "verifying"
33242 Client SMTP Authorization is a system that allows a site to advertise
33243 which machines are and are not permitted to send email. This is done by placing
33244 special SRV records in the DNS; these are looked up using the client's HELO
33245 domain. At the time of writing, CSA is still an Internet Draft. Client SMTP
33246 Authorization checks in Exim are performed by the ACL condition:
33247 .code
33248 verify = csa
33249 .endd
33250 This fails if the client is not authorized. If there is a DNS problem, or if no
33251 valid CSA SRV record is found, or if the client is authorized, the condition
33252 succeeds. These three cases can be distinguished using the expansion variable
33253 &$csa_status$&, which can take one of the values &"fail"&, &"defer"&,
33254 &"unknown"&, or &"ok"&. The condition does not itself defer because that would
33255 be likely to cause problems for legitimate email.
33256
33257 The error messages produced by the CSA code include slightly more
33258 detail. If &$csa_status$& is &"defer"&, this may be because of problems
33259 looking up the CSA SRV record, or problems looking up the CSA target
33260 address record. There are four reasons for &$csa_status$& being &"fail"&:
33261
33262 .ilist
33263 The client's host name is explicitly not authorized.
33264 .next
33265 The client's IP address does not match any of the CSA target IP addresses.
33266 .next
33267 The client's host name is authorized but it has no valid target IP addresses
33268 (for example, the target's addresses are IPv6 and the client is using IPv4).
33269 .next
33270 The client's host name has no CSA SRV record but a parent domain has asserted
33271 that all subdomains must be explicitly authorized.
33272 .endlist
33273
33274 The &%csa%& verification condition can take an argument which is the domain to
33275 use for the DNS query. The default is:
33276 .code
33277 verify = csa/$sender_helo_name
33278 .endd
33279 This implementation includes an extension to CSA. If the query domain
33280 is an address literal such as [192.0.2.95], or if it is a bare IP
33281 address, Exim searches for CSA SRV records in the reverse DNS as if
33282 the HELO domain was (for example) &'95.2.0.192.in-addr.arpa'&. Therefore it is
33283 meaningful to say:
33284 .code
33285 verify = csa/$sender_host_address
33286 .endd
33287 In fact, this is the check that Exim performs if the client does not say HELO.
33288 This extension can be turned off by setting the main configuration option
33289 &%dns_csa_use_reverse%& to be false.
33290
33291 If a CSA SRV record is not found for the domain itself, a search
33292 is performed through its parent domains for a record which might be
33293 making assertions about subdomains. The maximum depth of this search is limited
33294 using the main configuration option &%dns_csa_search_limit%&, which is 5 by
33295 default. Exim does not look for CSA SRV records in a top level domain, so the
33296 default settings handle HELO domains as long as seven
33297 (&'hostname.five.four.three.two.one.com'&). This encompasses the vast majority
33298 of legitimate HELO domains.
33299
33300 The &'dnsdb'& lookup also has support for CSA. Although &'dnsdb'& also supports
33301 direct SRV lookups, this is not sufficient because of the extra parent domain
33302 search behaviour of CSA, and (as with PTR lookups) &'dnsdb'& also turns IP
33303 addresses into lookups in the reverse DNS space. The result of a successful
33304 lookup such as:
33305 .code
33306 ${lookup dnsdb {csa=$sender_helo_name}}
33307 .endd
33308 has two space-separated fields: an authorization code and a target host name.
33309 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
33310 authorization required but absent, or &"?"& for unknown.
33311
33312
33313
33314
33315 .section "Bounce address tag validation" "SECTverifyPRVS"
33316 .cindex "BATV, verifying"
33317 Bounce address tag validation (BATV) is a scheme whereby the envelope senders
33318 of outgoing messages have a cryptographic, timestamped &"tag"& added to them.
33319 Genuine incoming bounce messages should therefore always be addressed to
33320 recipients that have a valid tag. This scheme is a way of detecting unwanted
33321 bounce messages caused by sender address forgeries (often called &"collateral
33322 spam"&), because the recipients of such messages do not include valid tags.
33323
33324 There are two expansion items to help with the implementation of the BATV
33325 &"prvs"& (private signature) scheme in an Exim configuration. This scheme signs
33326 the original envelope sender address by using a simple key to add a hash of the
33327 address and some time-based randomizing information. The &%prvs%& expansion
33328 item creates a signed address, and the &%prvscheck%& expansion item checks one.
33329 The syntax of these expansion items is described in section
33330 &<<SECTexpansionitems>>&.
33331 The validity period on signed addresses is seven days.
33332
33333 As an example, suppose the secret per-address keys are stored in an MySQL
33334 database. A query to look up the key for an address could be defined as a macro
33335 like this:
33336 .code
33337 PRVSCHECK_SQL = ${lookup mysql{SELECT secret FROM batv_prvs \
33338                 WHERE sender='${quote_mysql:$prvscheck_address}'\
33339                 }{$value}}
33340 .endd
33341 Suppose also that the senders who make use of BATV are defined by an address
33342 list called &%batv_senders%&. Then, in the ACL for RCPT commands, you could
33343 use this:
33344 .code
33345 # Bounces: drop unsigned addresses for BATV senders
33346 deny senders = :
33347      recipients = +batv_senders
33348      message = This address does not send an unsigned reverse path
33349
33350 # Bounces: In case of prvs-signed address, check signature.
33351 deny senders = :
33352      condition  = ${prvscheck {$local_part@$domain}\
33353                   {PRVSCHECK_SQL}{1}}
33354      !condition = $prvscheck_result
33355      message = Invalid reverse path signature.
33356 .endd
33357 The first statement rejects recipients for bounce messages that are addressed
33358 to plain BATV sender addresses, because it is known that BATV senders do not
33359 send out messages with plain sender addresses. The second statement rejects
33360 recipients that are prvs-signed, but with invalid signatures (either because
33361 the key is wrong, or the signature has timed out).
33362
33363 A non-prvs-signed address is not rejected by the second statement, because the
33364 &%prvscheck%& expansion yields an empty string if its first argument is not a
33365 prvs-signed address, thus causing the &%condition%& condition to be false. If
33366 the first argument is a syntactically valid prvs-signed address, the yield is
33367 the third string (in this case &"1"&), whether or not the cryptographic and
33368 timeout checks succeed. The &$prvscheck_result$& variable contains the result
33369 of the checks (empty for failure, &"1"& for success).
33370
33371 There is one more issue you must consider when implementing prvs-signing:
33372 you have to ensure that the routers accept prvs-signed addresses and
33373 deliver them correctly. The easiest way to handle this is to use a &(redirect)&
33374 router to remove the signature with a configuration along these lines:
33375 .code
33376 batv_redirect:
33377   driver = redirect
33378   data = ${prvscheck {$local_part@$domain}{PRVSCHECK_SQL}}
33379 .endd
33380 This works because, if the third argument of &%prvscheck%& is empty, the result
33381 of the expansion of a prvs-signed address is the decoded value of the original
33382 address. This router should probably be the first of your routers that handles
33383 local addresses.
33384
33385 To create BATV-signed addresses in the first place, a transport of this form
33386 can be used:
33387 .code
33388 external_smtp_batv:
33389   driver = smtp
33390   return_path = ${prvs {$return_path} \
33391                        {${lookup mysql{SELECT \
33392                        secret FROM batv_prvs WHERE \
33393                        sender='${quote_mysql:$sender_address}'} \
33394                        {$value}fail}}}
33395 .endd
33396 If no key can be found for the existing return path, no signing takes place.
33397
33398
33399
33400 .section "Using an ACL to control relaying" "SECTrelaycontrol"
33401 .cindex "&ACL;" "relay control"
33402 .cindex "relaying" "control by ACL"
33403 .cindex "policy control" "relay control"
33404 An MTA is said to &'relay'& a message if it receives it from some host and
33405 delivers it directly to another host as a result of a remote address contained
33406 within it. Redirecting a local address via an alias or forward file and then
33407 passing the message on to another host is not relaying,
33408 .cindex "&""percent hack""&"
33409 but a redirection as a result of the &"percent hack"& is.
33410
33411 Two kinds of relaying exist, which are termed &"incoming"& and &"outgoing"&.
33412 A host which is acting as a gateway or an MX backup is concerned with incoming
33413 relaying from arbitrary hosts to a specific set of domains. On the other hand,
33414 a host which is acting as a smart host for a number of clients is concerned
33415 with outgoing relaying from those clients to the Internet at large. Often the
33416 same host is fulfilling both functions,
33417 . ///
33418 . as illustrated in the diagram below,
33419 . ///
33420 but in principle these two kinds of relaying are entirely independent. What is
33421 not wanted is the transmission of mail from arbitrary remote hosts through your
33422 system to arbitrary domains.
33423
33424
33425 You can implement relay control by means of suitable statements in the ACL that
33426 runs for each RCPT command. For convenience, it is often easiest to use
33427 Exim's named list facility to define the domains and hosts involved. For
33428 example, suppose you want to do the following:
33429
33430 .ilist
33431 Deliver a number of domains to mailboxes on the local host (or process them
33432 locally in some other way). Let's say these are &'my.dom1.example'& and
33433 &'my.dom2.example'&.
33434 .next
33435 Relay mail for a number of other domains for which you are the secondary MX.
33436 These might be &'friend1.example'& and &'friend2.example'&.
33437 .next
33438 Relay mail from the hosts on your local LAN, to whatever domains are involved.
33439 Suppose your LAN is 192.168.45.0/24.
33440 .endlist
33441
33442
33443 In the main part of the configuration, you put the following definitions:
33444 .code
33445 domainlist local_domains    = my.dom1.example : my.dom2.example
33446 domainlist relay_to_domains = friend1.example : friend2.example
33447 hostlist   relay_from_hosts = 192.168.45.0/24
33448 .endd
33449 Now you can use these definitions in the ACL that is run for every RCPT
33450 command:
33451 .code
33452 acl_check_rcpt:
33453   accept domains = +local_domains : +relay_to_domains
33454   accept hosts   = +relay_from_hosts
33455 .endd
33456 The first statement accepts any RCPT command that contains an address in
33457 the local or relay domains. For any other domain, control passes to the second
33458 statement, which accepts the command only if it comes from one of the relay
33459 hosts. In practice, you will probably want to make your ACL more sophisticated
33460 than this, for example, by including sender and recipient verification. The
33461 default configuration includes a more comprehensive example, which is described
33462 in chapter &<<CHAPdefconfil>>&.
33463
33464
33465
33466 .section "Checking a relay configuration" "SECTcheralcon"
33467 .cindex "relaying" "checking control of"
33468 You can check the relay characteristics of your configuration in the same way
33469 that you can test any ACL behaviour for an incoming SMTP connection, by using
33470 the &%-bh%& option to run a fake SMTP session with which you interact.
33471 .ecindex IIDacl
33472
33473
33474
33475 . ////////////////////////////////////////////////////////////////////////////
33476 . ////////////////////////////////////////////////////////////////////////////
33477
33478 .chapter "Content scanning at ACL time" "CHAPexiscan"
33479 .scindex IIDcosca "content scanning" "at ACL time"
33480 The extension of Exim to include content scanning at ACL time, formerly known
33481 as &"exiscan"&, was originally implemented as a patch by Tom Kistner. The code
33482 was integrated into the main source for Exim release 4.50, and Tom continues to
33483 maintain it. Most of the wording of this chapter is taken from Tom's
33484 specification.
33485
33486 It is also possible to scan the content of messages at other times. The
33487 &[local_scan()]& function (see chapter &<<CHAPlocalscan>>&) allows for content
33488 scanning after all the ACLs have run. A transport filter can be used to scan
33489 messages at delivery time (see the &%transport_filter%& option, described in
33490 chapter &<<CHAPtransportgeneric>>&).
33491
33492 If you want to include the ACL-time content-scanning features when you compile
33493 Exim, you need to arrange for WITH_CONTENT_SCAN to be defined in your
33494 &_Local/Makefile_&. When you do that, the Exim binary is built with:
33495
33496 .ilist
33497 Two additional ACLs (&%acl_smtp_mime%& and &%acl_not_smtp_mime%&) that are run
33498 for all MIME parts for SMTP and non-SMTP messages, respectively.
33499 .next
33500 Additional ACL conditions and modifiers: &%decode%&, &%malware%&,
33501 &%mime_regex%&, &%regex%&, and &%spam%&. These can be used in the ACL that is
33502 run at the end of message reception (the &%acl_smtp_data%& ACL).
33503 .next
33504 An additional control feature (&"no_mbox_unspool"&) that saves spooled copies
33505 of messages, or parts of messages, for debugging purposes.
33506 .next
33507 Additional expansion variables that are set in the new ACL and by the new
33508 conditions.
33509 .next
33510 Two new main configuration options: &%av_scanner%& and &%spamd_address%&.
33511 .endlist
33512
33513 Content-scanning is continually evolving, and new features are still being
33514 added. While such features are still unstable and liable to incompatible
33515 changes, they are made available in Exim by setting options whose names begin
33516 EXPERIMENTAL_ in &_Local/Makefile_&. Such features are not documented in
33517 this manual. You can find out about them by reading the file called
33518 &_doc/experimental.txt_&.
33519
33520 All the content-scanning facilities work on a MBOX copy of the message that is
33521 temporarily created in a file called:
33522 .display
33523 <&'spool_directory'&>&`/scan/`&<&'message_id'&>/<&'message_id'&>&`.eml`&
33524 .endd
33525 The &_.eml_& extension is a friendly hint to virus scanners that they can
33526 expect an MBOX-like structure inside that file. The file is created when the
33527 first content scanning facility is called. Subsequent calls to content
33528 scanning conditions open the same file again. The directory is recursively
33529 removed when the &%acl_smtp_data%& ACL has finished running, unless
33530 .code
33531 control = no_mbox_unspool
33532 .endd
33533 has been encountered. When the MIME ACL decodes files, they are put into the
33534 same directory by default.
33535
33536
33537
33538 .section "Scanning for viruses" "SECTscanvirus"
33539 .cindex "virus scanning"
33540 .cindex "content scanning" "for viruses"
33541 .cindex "content scanning" "the &%malware%& condition"
33542 The &%malware%& ACL condition lets you connect virus scanner software to Exim.
33543 It supports a &"generic"& interface to scanners called via the shell, and
33544 specialized interfaces for &"daemon"& type virus scanners, which are resident
33545 in memory and thus are much faster.
33546
33547 Since message data needs to have arrived,
33548 the condition may be only called in ACL defined by
33549 &%acl_smtp_data%&,
33550 &%acl_smtp_data_prdr%&,
33551 &%acl_smtp_mime%& or
33552 &%acl_smtp_dkim%&
33553
33554 A timeout of 2 minutes is applied to a scanner call (by default);
33555 if it expires then a defer action is taken.
33556
33557 .oindex "&%av_scanner%&"
33558 You can set the &%av_scanner%& option in the main part of the configuration
33559 to specify which scanner to use, together with any additional options that
33560 are needed. The basic syntax is as follows:
33561 .display
33562 &`av_scanner = <`&&'scanner-type'&&`>:<`&&'option1'&&`>:<`&&'option2'&&`>:[...]`&
33563 .endd
33564 If you do not set &%av_scanner%&, it defaults to
33565 .code
33566 av_scanner = sophie:/var/run/sophie
33567 .endd
33568 If the value of &%av_scanner%& starts with a dollar character, it is expanded
33569 before use.
33570 The usual list-parsing of the content (see &<<SECTlistconstruct>>&) applies.
33571 The following scanner types are supported in this release,
33572 though individual ones can be included or not at build time:
33573
33574 .vlist
33575 .vitem &%avast%&
33576 .cindex "virus scanners" "avast"
33577 This is the scanner daemon of Avast. It has been tested with Avast Core
33578 Security (currently at version 2.2.0).
33579 You can get a trial version at &url(https://www.avast.com) or for Linux
33580 at &url(https://www.avast.com/linux-server-antivirus).
33581 This scanner type takes one option,
33582 which can be either a full path to a UNIX socket,
33583 or host and port specifiers separated by white space.
33584 The host may be a name or an IP address; the port is either a
33585 single number or a pair of numbers with a dash between.
33586 A list of options may follow. These options are interpreted on the
33587 Exim's side of the malware scanner, or are given on separate lines to
33588 the daemon as options before the main scan command.
33589
33590 .cindex &`pass_unscanned`& "avast"
33591 If &`pass_unscanned`&
33592 is set, any files the Avast scanner can't scan (e.g.
33593 decompression bombs, or invalid archives) are considered clean. Use with
33594 care.
33595
33596 For example:
33597 .code
33598 av_scanner = avast:/var/run/avast/scan.sock:FLAGS -fullfiles:SENSITIVITY -pup
33599 av_scanner = avast:/var/run/avast/scan.sock:pass_unscanned:FLAGS -fullfiles:SENSITIVITY -pup
33600 av_scanner = avast:192.168.2.22 5036
33601 .endd
33602 If you omit the argument, the default path
33603 &_/var/run/avast/scan.sock_&
33604 is used.
33605 If you use a remote host,
33606 you need to make Exim's spool directory available to it,
33607 as the scanner is passed a file path, not file contents.
33608 For information about available commands and their options you may use
33609 .code
33610 $ socat UNIX:/var/run/avast/scan.sock STDIO:
33611     FLAGS
33612     SENSITIVITY
33613     PACK
33614 .endd
33615
33616 If the scanner returns a temporary failure (e.g. license issues, or
33617 permission problems), the message is deferred and a paniclog entry is
33618 written.  The usual &`defer_ok`& option is available.
33619
33620 .vitem &%aveserver%&
33621 .cindex "virus scanners" "Kaspersky"
33622 This is the scanner daemon of Kaspersky Version 5. You can get a trial version
33623 at &url(https://www.kaspersky.com/). This scanner type takes one option,
33624 which is the path to the daemon's UNIX socket. The default is shown in this
33625 example:
33626 .code
33627 av_scanner = aveserver:/var/run/aveserver
33628 .endd
33629
33630
33631 .vitem &%clamd%&
33632 .cindex "virus scanners" "clamd"
33633 This daemon-type scanner is GPL and free. You can get it at
33634 &url(https://www.clamav.net/). Some older versions of clamd do not seem to
33635 unpack MIME containers, so it used to be recommended to unpack MIME attachments
33636 in the MIME ACL. This is no longer believed to be necessary.
33637
33638 The options are a list of server specifiers, which may be
33639 a UNIX socket specification,
33640 a TCP socket specification,
33641 or a (global) option.
33642
33643 A socket specification consists of a space-separated list.
33644 For a Unix socket the first element is a full path for the socket,
33645 for a TCP socket the first element is the IP address
33646 and the second a port number,
33647 Any further elements are per-server (non-global) options.
33648 These per-server options are supported:
33649 .code
33650 retry=<timespec>        Retry on connect fail
33651 .endd
33652
33653 The &`retry`& option specifies a time after which a single retry for
33654 a failed connect is made.  The default is to not retry.
33655
33656 If a Unix socket file is specified, only one server is supported.
33657
33658 Examples:
33659 .code
33660 av_scanner = clamd:/opt/clamd/socket
33661 av_scanner = clamd:192.0.2.3 1234
33662 av_scanner = clamd:192.0.2.3 1234:local
33663 av_scanner = clamd:192.0.2.3 1234 retry=10s
33664 av_scanner = clamd:192.0.2.3 1234 : 192.0.2.4 1234
33665 .endd
33666 If the value of av_scanner points to a UNIX socket file or contains the
33667 &`local`&
33668 option, then the ClamAV interface will pass a filename containing the data
33669 to be scanned, which should normally result in less I/O happening and be
33670 more efficient.  Normally in the TCP case, the data is streamed to ClamAV as
33671 Exim does not assume that there is a common filesystem with the remote host.
33672
33673 The final example shows that multiple TCP targets can be specified.  Exim will
33674 randomly use one for each incoming email (i.e. it load balances them).  Note
33675 that only TCP targets may be used if specifying a list of scanners; a UNIX
33676 socket cannot be mixed in with TCP targets.  If one of the servers becomes
33677 unavailable, Exim will try the remaining one(s) until it finds one that works.
33678 When a clamd server becomes unreachable, Exim will log a message.  Exim does
33679 not keep track of scanner state between multiple messages, and the scanner
33680 selection is random, so the message will get logged in the mainlog for each
33681 email that the down scanner gets chosen first (message wrapped to be readable):
33682 .code
33683 2013-10-09 14:30:39 1VTumd-0000Y8-BQ malware acl condition:
33684    clamd: connection to localhost, port 3310 failed
33685    (Connection refused)
33686 .endd
33687
33688 If the option is unset, the default is &_/tmp/clamd_&. Thanks to David Saez for
33689 contributing the code for this scanner.
33690
33691 .vitem &%cmdline%&
33692 .cindex "virus scanners" "command line interface"
33693 This is the keyword for the generic command line scanner interface. It can be
33694 used to attach virus scanners that are invoked from the shell. This scanner
33695 type takes 3 mandatory options:
33696
33697 .olist
33698 The full path and name of the scanner binary, with all command line options,
33699 and a placeholder (&`%s`&) for the directory to scan.
33700
33701 .next
33702 A regular expression to match against the STDOUT and STDERR output of the
33703 virus scanner. If the expression matches, a virus was found. You must make
33704 absolutely sure that this expression matches on &"virus found"&. This is called
33705 the &"trigger"& expression.
33706
33707 .next
33708 Another regular expression, containing exactly one pair of parentheses, to
33709 match the name of the virus found in the scanners output. This is called the
33710 &"name"& expression.
33711 .endlist olist
33712
33713 For example, Sophos Sweep reports a virus on a line like this:
33714 .code
33715 Virus 'W32/Magistr-B' found in file ./those.bat
33716 .endd
33717 For the trigger expression, we can match the phrase &"found in file"&. For the
33718 name expression, we want to extract the W32/Magistr-B string, so we can match
33719 for the single quotes left and right of it. Altogether, this makes the
33720 configuration setting:
33721 .code
33722 av_scanner = cmdline:\
33723              /path/to/sweep -ss -all -rec -archive %s:\
33724              found in file:'(.+)'
33725 .endd
33726 .vitem &%drweb%&
33727 .cindex "virus scanners" "DrWeb"
33728 The DrWeb daemon scanner (&url(https://www.sald.ru/)) interface
33729 takes one option,
33730 either a full path to a UNIX socket,
33731 or host and port specifiers separated by white space.
33732 The host may be a name or an IP address; the port is either a
33733 single number or a pair of numbers with a dash between.
33734 For example:
33735 .code
33736 av_scanner = drweb:/var/run/drwebd.sock
33737 av_scanner = drweb:192.168.2.20 31337
33738 .endd
33739 If you omit the argument, the default path &_/usr/local/drweb/run/drwebd.sock_&
33740 is used. Thanks to Alex Miller for contributing the code for this scanner.
33741
33742 .vitem &%f-protd%&
33743 .cindex "virus scanners" "f-protd"
33744 The f-protd scanner is accessed via HTTP over TCP.
33745 One argument is taken, being a space-separated hostname and port number
33746 (or port-range).
33747 For example:
33748 .code
33749 av_scanner = f-protd:localhost 10200-10204
33750 .endd
33751 If you omit the argument, the default values shown above are used.
33752
33753 .vitem &%f-prot6d%&
33754 .cindex "virus scanners" "f-prot6d"
33755 The f-prot6d scanner is accessed using the FPSCAND protocol over TCP.
33756 One argument is taken, being a space-separated hostname and port number.
33757 For example:
33758 .code
33759 av_scanner = f-prot6d:localhost 10200
33760 .endd
33761 If you omit the argument, the default values show above are used.
33762
33763 .vitem &%fsecure%&
33764 .cindex "virus scanners" "F-Secure"
33765 The F-Secure daemon scanner (&url(https://www.f-secure.com/)) takes one
33766 argument which is the path to a UNIX socket. For example:
33767 .code
33768 av_scanner = fsecure:/path/to/.fsav
33769 .endd
33770 If no argument is given, the default is &_/var/run/.fsav_&. Thanks to Johan
33771 Thelmen for contributing the code for this scanner.
33772
33773 .vitem &%kavdaemon%&
33774 .cindex "virus scanners" "Kaspersky"
33775 This is the scanner daemon of Kaspersky Version 4. This version of the
33776 Kaspersky scanner is outdated. Please upgrade (see &%aveserver%& above). This
33777 scanner type takes one option, which is the path to the daemon's UNIX socket.
33778 For example:
33779 .code
33780 av_scanner = kavdaemon:/opt/AVP/AvpCtl
33781 .endd
33782 The default path is &_/var/run/AvpCtl_&.
33783
33784 .vitem &%mksd%&
33785 .cindex "virus scanners" "mksd"
33786 This was a daemon type scanner that is aimed mainly at Polish users,
33787 though some documentation was available in English.
33788 The history can be shown at &url(https://en.wikipedia.org/wiki/Mks_vir)
33789 and this appears to be a candidate for removal from Exim, unless
33790 we are informed of other virus scanners which use the same protocol
33791 to integrate.
33792 The only option for this scanner type is
33793 the maximum number of processes used simultaneously to scan the attachments,
33794 provided that mksd has
33795 been run with at least the same number of child processes. For example:
33796 .code
33797 av_scanner = mksd:2
33798 .endd
33799 You can safely omit this option (the default value is 1).
33800
33801 .vitem &%sock%&
33802 .cindex "virus scanners" "simple socket-connected"
33803 This is a general-purpose way of talking to simple scanner daemons
33804 running on the local machine.
33805 There are four options:
33806 an address (which may be an IP address and port, or the path of a Unix socket),
33807 a commandline to send (may include a single %s which will be replaced with
33808 the path to the mail file to be scanned),
33809 an RE to trigger on from the returned data,
33810 and an RE to extract malware_name from the returned data.
33811 For example:
33812 .code
33813 av_scanner = sock:127.0.0.1 6001:%s:(SPAM|VIRUS):(.*)$
33814 .endd
33815 Note that surrounding whitespace is stripped from each option, meaning
33816 there is no way to specify a trailing newline.
33817 The socket specifier and both regular-expressions are required.
33818 Default for the commandline is &_%s\n_& (note this does have a trailing newline);
33819 specify an empty element to get this.
33820
33821 .vitem &%sophie%&
33822 .cindex "virus scanners" "Sophos and Sophie"
33823 Sophie is a daemon that uses Sophos' &%libsavi%& library to scan for viruses.
33824 You can get Sophie at &url(http://sophie.sourceforge.net/). The only option
33825 for this scanner type is the path to the UNIX socket that Sophie uses for
33826 client communication. For example:
33827 .code
33828 av_scanner = sophie:/tmp/sophie
33829 .endd
33830 The default path is &_/var/run/sophie_&, so if you are using this, you can omit
33831 the option.
33832 .endlist
33833
33834 When &%av_scanner%& is correctly set, you can use the &%malware%& condition in
33835 the DATA ACL. &*Note*&: You cannot use the &%malware%& condition in the MIME
33836 ACL.
33837
33838 The &%av_scanner%& option is expanded each time &%malware%& is called. This
33839 makes it possible to use different scanners. See further below for an example.
33840 The &%malware%& condition caches its results, so when you use it multiple times
33841 for the same message, the actual scanning process is only carried out once.
33842 However, using expandable items in &%av_scanner%& disables this caching, in
33843 which case each use of the &%malware%& condition causes a new scan of the
33844 message.
33845
33846 The &%malware%& condition takes a right-hand argument that is expanded before
33847 use and taken as a list, slash-separated by default.
33848 The first element can then be one of
33849
33850 .ilist
33851 &"true"&, &"*"&, or &"1"&, in which case the message is scanned for viruses.
33852 The condition succeeds if a virus was found, and fail otherwise. This is the
33853 recommended usage.
33854 .next
33855 &"false"& or &"0"& or an empty string, in which case no scanning is done and
33856 the condition fails immediately.
33857 .next
33858 A regular expression, in which case the message is scanned for viruses. The
33859 condition succeeds if a virus is found and its name matches the regular
33860 expression. This allows you to take special actions on certain types of virus.
33861 Note that &"/"& characters in the RE must be doubled due to the list-processing,
33862 unless the separator is changed (in the usual way &<<SECTlistsepchange>>&).
33863 .endlist
33864
33865 You can append a &`defer_ok`& element to the &%malware%& argument list to accept
33866 messages even if there is a problem with the virus scanner.
33867 Otherwise, such a problem causes the ACL to defer.
33868
33869 You can append a &`tmo=<val>`& element to the &%malware%& argument list to
33870 specify a non-default timeout.  The default is two minutes.
33871 For example:
33872 .code
33873 malware = * / defer_ok / tmo=10s
33874 .endd
33875 A timeout causes the ACL to defer.
33876
33877 .vindex "&$callout_address$&"
33878 When a connection is made to the scanner the expansion variable &$callout_address$&
33879 is set to record the actual address used.
33880
33881 .vindex "&$malware_name$&"
33882 When a virus is found, the condition sets up an expansion variable called
33883 &$malware_name$& that contains the name of the virus. You can use it in a
33884 &%message%& modifier that specifies the error returned to the sender, and/or in
33885 logging data.
33886
33887 Beware the interaction of Exim's &%message_size_limit%& with any size limits
33888 imposed by your anti-virus scanner.
33889
33890 Here is a very simple scanning example:
33891 .code
33892 deny malware = *
33893      message = This message contains malware ($malware_name)
33894 .endd
33895 The next example accepts messages when there is a problem with the scanner:
33896 .code
33897 deny malware = */defer_ok
33898      message = This message contains malware ($malware_name)
33899 .endd
33900 The next example shows how to use an ACL variable to scan with both sophie and
33901 aveserver. It assumes you have set:
33902 .code
33903 av_scanner = $acl_m0
33904 .endd
33905 in the main Exim configuration.
33906 .code
33907 deny set acl_m0 = sophie
33908      malware = *
33909      message = This message contains malware ($malware_name)
33910
33911 deny set acl_m0 = aveserver
33912      malware = *
33913      message = This message contains malware ($malware_name)
33914 .endd
33915
33916
33917 .section "Scanning with SpamAssassin and Rspamd" "SECTscanspamass"
33918 .cindex "content scanning" "for spam"
33919 .cindex "spam scanning"
33920 .cindex "SpamAssassin"
33921 .cindex "Rspamd"
33922 The &%spam%& ACL condition calls SpamAssassin's &%spamd%& daemon to get a spam
33923 score and a report for the message.
33924 Support is also provided for Rspamd.
33925
33926 For more information about installation and configuration of SpamAssassin or
33927 Rspamd refer to their respective websites at
33928 &url(https://spamassassin.apache.org/) and &url(https://www.rspamd.com/)
33929
33930 SpamAssassin can be installed with CPAN by running:
33931 .code
33932 perl -MCPAN -e 'install Mail::SpamAssassin'
33933 .endd
33934 SpamAssassin has its own set of configuration files. Please review its
33935 documentation to see how you can tweak it. The default installation should work
33936 nicely, however.
33937
33938 .oindex "&%spamd_address%&"
33939 By default, SpamAssassin listens on 127.0.0.1, TCP port 783 and if you
33940 intend to use an instance running on the local host you do not need to set
33941 &%spamd_address%&. If you intend to use another host or port for SpamAssassin,
33942 you must set the &%spamd_address%& option in the global part of the Exim
33943 configuration as follows (example):
33944 .code
33945 spamd_address = 192.168.99.45 783
33946 .endd
33947 The SpamAssassin protocol relies on a TCP half-close from the client.
33948 If your SpamAssassin client side is running a Linux system with an
33949 iptables firewall, consider setting
33950 &%net.netfilter.nf_conntrack_tcp_timeout_close_wait%& to at least the
33951 timeout, Exim uses when waiting for a response from the SpamAssassin
33952 server (currently defaulting to 120s).  With a lower value the Linux
33953 connection tracking may consider your half-closed connection as dead too
33954 soon.
33955
33956
33957 To use Rspamd (which by default listens on all local addresses
33958 on TCP port 11333)
33959 you should add &%variant=rspamd%& after the address/port pair, for example:
33960 .code
33961 spamd_address = 127.0.0.1 11333 variant=rspamd
33962 .endd
33963
33964 As of version 2.60, &%SpamAssassin%& also supports communication over UNIX
33965 sockets. If you want to us these, supply &%spamd_address%& with an absolute
33966 filename instead of an address/port pair:
33967 .code
33968 spamd_address = /var/run/spamd_socket
33969 .endd
33970 You can have multiple &%spamd%& servers to improve scalability. These can
33971 reside on other hardware reachable over the network. To specify multiple
33972 &%spamd%& servers, put multiple address/port pairs in the &%spamd_address%&
33973 option, separated with colons (the separator can be changed in the usual way &<<SECTlistsepchange>>&):
33974 .code
33975 spamd_address = 192.168.2.10 783 : \
33976                 192.168.2.11 783 : \
33977                 192.168.2.12 783
33978 .endd
33979 Up to 32 &%spamd%& servers are supported.
33980 When a server fails to respond to the connection attempt, all other
33981 servers are tried until one succeeds. If no server responds, the &%spam%&
33982 condition defers.
33983
33984 Unix and TCP socket specifications may be mixed in any order.
33985 Each element of the list is a list itself, space-separated by default
33986 and changeable in the usual way (&<<SECTlistsepchange>>&);
33987 take care to not double the separator.
33988
33989 For TCP socket specifications a host name or IP (v4 or v6, but
33990 subject to list-separator quoting rules) address can be used,
33991 and the port can be one or a dash-separated pair.
33992 In the latter case, the range is tried in strict order.
33993
33994 Elements after the first for Unix sockets, or second for TCP socket,
33995 are options.
33996 The supported options are:
33997 .code
33998 pri=<priority>      Selection priority
33999 weight=<value>      Selection bias
34000 time=<start>-<end>  Use only between these times of day
34001 retry=<timespec>    Retry on connect fail
34002 tmo=<timespec>      Connection time limit
34003 variant=rspamd      Use Rspamd rather than SpamAssassin protocol
34004 .endd
34005
34006 The &`pri`& option specifies a priority for the server within the list,
34007 higher values being tried first.
34008 The default priority is 1.
34009
34010 The &`weight`& option specifies a selection bias.
34011 Within a priority set
34012 servers are queried in a random fashion, weighted by this value.
34013 The default value for selection bias is 1.
34014
34015 Time specifications for the &`time`& option are <hour>.<minute>.<second>
34016 in the local time zone; each element being one or more digits.
34017 Either the seconds or both minutes and seconds, plus the leading &`.`&
34018 characters, may be omitted and will be taken as zero.
34019
34020 Timeout specifications for the &`retry`& and &`tmo`& options
34021 are the usual Exim time interval standard, e.g. &`20s`& or &`1m`&.
34022
34023 The &`tmo`& option specifies an overall timeout for communication.
34024 The default value is two minutes.
34025
34026 The &`retry`& option specifies a time after which a single retry for
34027 a failed connect is made.
34028 The default is to not retry.
34029
34030 The &%spamd_address%& variable is expanded before use if it starts with
34031 a dollar sign. In this case, the expansion may return a string that is
34032 used as the list so that multiple spamd servers can be the result of an
34033 expansion.
34034
34035 .vindex "&$callout_address$&"
34036 When a connection is made to the server the expansion variable &$callout_address$&
34037 is set to record the actual address used.
34038
34039 .section "Calling SpamAssassin from an Exim ACL" "SECID206"
34040 Here is a simple example of the use of the &%spam%& condition in a DATA ACL:
34041 .code
34042 deny spam = joe
34043      message = This message was classified as SPAM
34044 .endd
34045 The right-hand side of the &%spam%& condition specifies a name. This is
34046 relevant if you have set up multiple SpamAssassin profiles. If you do not want
34047 to scan using a specific profile, but rather use the SpamAssassin system-wide
34048 default profile, you can scan for an unknown name, or simply use &"nobody"&.
34049 Rspamd does not use this setting. However, you must put something on the
34050 right-hand side.
34051
34052 The name allows you to use per-domain or per-user antispam profiles in
34053 principle, but this is not straightforward in practice, because a message may
34054 have multiple recipients, not necessarily all in the same domain. Because the
34055 &%spam%& condition has to be called from a DATA-time ACL in order to be able to
34056 read the contents of the message, the variables &$local_part$& and &$domain$&
34057 are not set.
34058 Careful enforcement of single-recipient messages
34059 (e.g. by responding with defer in the recipient ACL for all recipients
34060 after the first),
34061 or the use of PRDR,
34062 .cindex "PRDR" "use for per-user SpamAssassin profiles"
34063 are needed to use this feature.
34064
34065 The right-hand side of the &%spam%& condition is expanded before being used, so
34066 you can put lookups or conditions there. When the right-hand side evaluates to
34067 &"0"& or &"false"&, no scanning is done and the condition fails immediately.
34068
34069
34070 Scanning with SpamAssassin uses a lot of resources. If you scan every message,
34071 large ones may cause significant performance degradation. As most spam messages
34072 are quite small, it is recommended that you do not scan the big ones. For
34073 example:
34074 .code
34075 deny condition = ${if < {$message_size}{10K}}
34076      spam = nobody
34077      message = This message was classified as SPAM
34078 .endd
34079
34080 The &%spam%& condition returns true if the threshold specified in the user's
34081 SpamAssassin profile has been matched or exceeded. If you want to use the
34082 &%spam%& condition for its side effects (see the variables below), you can make
34083 it always return &"true"& by appending &`:true`& to the username.
34084
34085 .cindex "spam scanning" "returned variables"
34086 When the &%spam%& condition is run, it sets up a number of expansion
34087 variables.
34088 Except for &$spam_report$&,
34089 these variables are saved with the received message so are
34090 available for use at delivery time.
34091
34092 .vlist
34093 .vitem &$spam_score$&
34094 The spam score of the message, for example, &"3.4"& or &"30.5"&. This is useful
34095 for inclusion in log or reject messages.
34096
34097 .vitem &$spam_score_int$&
34098 The spam score of the message, multiplied by ten, as an integer value. For
34099 example &"34"& or &"305"&. It may appear to disagree with &$spam_score$&
34100 because &$spam_score$& is rounded and &$spam_score_int$& is truncated.
34101 The integer value is useful for numeric comparisons in conditions.
34102
34103 .vitem &$spam_bar$&
34104 A string consisting of a number of &"+"& or &"-"& characters, representing the
34105 integer part of the spam score value. A spam score of 4.4 would have a
34106 &$spam_bar$& value of &"++++"&. This is useful for inclusion in warning
34107 headers, since MUAs can match on such strings. The maximum length of the
34108 spam bar is 50 characters.
34109
34110 .vitem &$spam_report$&
34111 A multiline text table, containing the full SpamAssassin report for the
34112 message. Useful for inclusion in headers or reject messages.
34113 This variable is only usable in a DATA-time ACL.
34114 Beware that SpamAssassin may return non-ASCII characters, especially
34115 when running in country-specific locales, which are not legal
34116 unencoded in headers.
34117
34118 .vitem &$spam_action$&
34119 For SpamAssassin either 'reject' or 'no action' depending on the
34120 spam score versus threshold.
34121 For Rspamd, the recommended action.
34122
34123 .endlist
34124
34125 The &%spam%& condition caches its results unless expansion in
34126 spamd_address was used. If you call it again with the same user name, it
34127 does not scan again, but rather returns the same values as before.
34128
34129 The &%spam%& condition returns DEFER if there is any error while running
34130 the message through SpamAssassin or if the expansion of spamd_address
34131 failed. If you want to treat DEFER as FAIL (to pass on to the next ACL
34132 statement block), append &`/defer_ok`& to the right-hand side of the
34133 spam condition, like this:
34134 .code
34135 deny spam    = joe/defer_ok
34136      message = This message was classified as SPAM
34137 .endd
34138 This causes messages to be accepted even if there is a problem with &%spamd%&.
34139
34140 Here is a longer, commented example of the use of the &%spam%&
34141 condition:
34142 .code
34143 # put headers in all messages (no matter if spam or not)
34144 warn  spam = nobody:true
34145       add_header = X-Spam-Score: $spam_score ($spam_bar)
34146       add_header = X-Spam-Report: $spam_report
34147
34148 # add second subject line with *SPAM* marker when message
34149 # is over threshold
34150 warn  spam = nobody
34151       add_header = Subject: *SPAM* $h_Subject:
34152
34153 # reject spam at high scores (> 12)
34154 deny  spam = nobody:true
34155       condition = ${if >{$spam_score_int}{120}{1}{0}}
34156       message = This message scored $spam_score spam points.
34157 .endd
34158
34159
34160
34161 .section "Scanning MIME parts" "SECTscanmimepart"
34162 .cindex "content scanning" "MIME parts"
34163 .cindex "MIME content scanning"
34164 .oindex "&%acl_smtp_mime%&"
34165 .oindex "&%acl_not_smtp_mime%&"
34166 The &%acl_smtp_mime%& global option specifies an ACL that is called once for
34167 each MIME part of an SMTP message, including multipart types, in the sequence
34168 of their position in the message. Similarly, the &%acl_not_smtp_mime%& option
34169 specifies an ACL that is used for the MIME parts of non-SMTP messages. These
34170 options may both refer to the same ACL if you want the same processing in both
34171 cases.
34172
34173 These ACLs are called (possibly many times) just before the &%acl_smtp_data%&
34174 ACL in the case of an SMTP message, or just before the &%acl_not_smtp%& ACL in
34175 the case of a non-SMTP message. However, a MIME ACL is called only if the
34176 message contains a &'Content-Type:'& header line. When a call to a MIME
34177 ACL does not yield &"accept"&, ACL processing is aborted and the appropriate
34178 result code is sent to the client. In the case of an SMTP message, the
34179 &%acl_smtp_data%& ACL is not called when this happens.
34180
34181 You cannot use the &%malware%& or &%spam%& conditions in a MIME ACL; these can
34182 only be used in the DATA or non-SMTP ACLs. However, you can use the &%regex%&
34183 condition to match against the raw MIME part. You can also use the
34184 &%mime_regex%& condition to match against the decoded MIME part (see section
34185 &<<SECTscanregex>>&).
34186
34187 At the start of a MIME ACL, a number of variables are set from the header
34188 information for the relevant MIME part. These are described below. The contents
34189 of the MIME part are not by default decoded into a disk file except for MIME
34190 parts whose content-type is &"message/rfc822"&. If you want to decode a MIME
34191 part into a disk file, you can use the &%decode%& condition. The general
34192 syntax is:
34193 .display
34194 &`decode = [/`&<&'path'&>&`/]`&<&'filename'&>
34195 .endd
34196 The right hand side is expanded before use. After expansion,
34197 the value can be:
34198
34199 .olist
34200 &"0"& or &"false"&, in which case no decoding is done.
34201 .next
34202 The string &"default"&. In that case, the file is put in the temporary
34203 &"default"& directory <&'spool_directory'&>&_/scan/_&<&'message_id'&>&_/_& with
34204 a sequential filename consisting of the message id and a sequence number. The
34205 full path and name is available in &$mime_decoded_filename$& after decoding.
34206 .next
34207 A full path name starting with a slash. If the full name is an existing
34208 directory, it is used as a replacement for the default directory. The filename
34209 is then sequentially assigned. If the path does not exist, it is used as
34210 the full path and filename.
34211 .next
34212 If the string does not start with a slash, it is used as the
34213 filename, and the default path is then used.
34214 .endlist
34215 The &%decode%& condition normally succeeds. It is only false for syntax
34216 errors or unusual circumstances such as memory shortages. You can easily decode
34217 a file with its original, proposed filename using
34218 .code
34219 decode = $mime_filename
34220 .endd
34221 However, you should keep in mind that &$mime_filename$& might contain
34222 anything. If you place files outside of the default path, they are not
34223 automatically unlinked.
34224
34225 For RFC822 attachments (these are messages attached to messages, with a
34226 content-type of &"message/rfc822"&), the ACL is called again in the same manner
34227 as for the primary message, only that the &$mime_is_rfc822$& expansion
34228 variable is set (see below). Attached messages are always decoded to disk
34229 before being checked, and the files are unlinked once the check is done.
34230
34231 The MIME ACL supports the &%regex%& and &%mime_regex%& conditions. These can be
34232 used to match regular expressions against raw and decoded MIME parts,
34233 respectively. They are described in section &<<SECTscanregex>>&.
34234
34235 .cindex "MIME content scanning" "returned variables"
34236 The following list describes all expansion variables that are
34237 available in the MIME ACL:
34238
34239 .vlist
34240 .vitem &$mime_anomaly_level$& &&&
34241        &$mime_anomaly_text$&
34242 .vindex &$mime_anomaly_level$&
34243 .vindex &$mime_anomaly_text$&
34244 If there are problems decoding, these variables contain information on
34245 the detected issue.
34246
34247 .vitem &$mime_boundary$&
34248 .vindex &$mime_boundary$&
34249 If the current part is a multipart (see &$mime_is_multipart$& below), it should
34250 have a boundary string, which is stored in this variable. If the current part
34251 has no boundary parameter in the &'Content-Type:'& header, this variable
34252 contains the empty string.
34253
34254 .vitem &$mime_charset$&
34255 .vindex &$mime_charset$&
34256 This variable contains the character set identifier, if one was found in the
34257 &'Content-Type:'& header. Examples for charset identifiers are:
34258 .code
34259 us-ascii
34260 gb2312 (Chinese)
34261 iso-8859-1
34262 .endd
34263 Please note that this value is not normalized, so you should do matches
34264 case-insensitively.
34265
34266 .vitem &$mime_content_description$&
34267 .vindex &$mime_content_description$&
34268 This variable contains the normalized content of the &'Content-Description:'&
34269 header. It can contain a human-readable description of the parts content. Some
34270 implementations repeat the filename for attachments here, but they are usually
34271 only used for display purposes.
34272
34273 .vitem &$mime_content_disposition$&
34274 .vindex &$mime_content_disposition$&
34275 This variable contains the normalized content of the &'Content-Disposition:'&
34276 header. You can expect strings like &"attachment"& or &"inline"& here.
34277
34278 .vitem &$mime_content_id$&
34279 .vindex &$mime_content_id$&
34280 This variable contains the normalized content of the &'Content-ID:'& header.
34281 This is a unique ID that can be used to reference a part from another part.
34282
34283 .vitem &$mime_content_size$&
34284 .vindex &$mime_content_size$&
34285 This variable is set only after the &%decode%& modifier (see above) has been
34286 successfully run. It contains the size of the decoded part in kilobytes. The
34287 size is always rounded up to full kilobytes, so only a completely empty part
34288 has a &$mime_content_size$& of zero.
34289
34290 .vitem &$mime_content_transfer_encoding$&
34291 .vindex &$mime_content_transfer_encoding$&
34292 This variable contains the normalized content of the
34293 &'Content-transfer-encoding:'& header. This is a symbolic name for an encoding
34294 type. Typical values are &"base64"& and &"quoted-printable"&.
34295
34296 .vitem &$mime_content_type$&
34297 .vindex &$mime_content_type$&
34298 If the MIME part has a &'Content-Type:'& header, this variable contains its
34299 value, lowercased, and without any options (like &"name"& or &"charset"&). Here
34300 are some examples of popular MIME types, as they may appear in this variable:
34301 .code
34302 text/plain
34303 text/html
34304 application/octet-stream
34305 image/jpeg
34306 audio/midi
34307 .endd
34308 If the MIME part has no &'Content-Type:'& header, this variable contains the
34309 empty string.
34310
34311 .vitem &$mime_decoded_filename$&
34312 .vindex &$mime_decoded_filename$&
34313 This variable is set only after the &%decode%& modifier (see above) has been
34314 successfully run. It contains the full path and filename of the file
34315 containing the decoded data.
34316 .endlist
34317
34318 .cindex "RFC 2047"
34319 .vlist
34320 .vitem &$mime_filename$&
34321 .vindex &$mime_filename$&
34322 This is perhaps the most important of the MIME variables. It contains a
34323 proposed filename for an attachment, if one was found in either the
34324 &'Content-Type:'& or &'Content-Disposition:'& headers. The filename will be
34325 RFC2047
34326 or RFC2231
34327 decoded, but no additional sanity checks are done.
34328  If no filename was
34329 found, this variable contains the empty string.
34330
34331 .vitem &$mime_is_coverletter$&
34332 .vindex &$mime_is_coverletter$&
34333 This variable attempts to differentiate the &"cover letter"& of an e-mail from
34334 attached data. It can be used to clamp down on flashy or unnecessarily encoded
34335 content in the cover letter, while not restricting attachments at all.
34336
34337 The variable contains 1 (true) for a MIME part believed to be part of the
34338 cover letter, and 0 (false) for an attachment. At present, the algorithm is as
34339 follows:
34340
34341 .olist
34342 The outermost MIME part of a message is always a cover letter.
34343
34344 .next
34345 If a multipart/alternative or multipart/related MIME part is a cover letter,
34346 so are all MIME subparts within that multipart.
34347
34348 .next
34349 If any other multipart is a cover letter, the first subpart is a cover letter,
34350 and the rest are attachments.
34351
34352 .next
34353 All parts contained within an attachment multipart are attachments.
34354 .endlist olist
34355
34356 As an example, the following will ban &"HTML mail"& (including that sent with
34357 alternative plain text), while allowing HTML files to be attached. HTML
34358 coverletter mail attached to non-HTML coverletter mail will also be allowed:
34359 .code
34360 deny !condition = $mime_is_rfc822
34361      condition = $mime_is_coverletter
34362      condition = ${if eq{$mime_content_type}{text/html}{1}{0}}
34363      message = HTML mail is not accepted here
34364 .endd
34365
34366 .vitem &$mime_is_multipart$&
34367 .vindex &$mime_is_multipart$&
34368 This variable has the value 1 (true) when the current part has the main type
34369 &"multipart"&, for example, &"multipart/alternative"& or &"multipart/mixed"&.
34370 Since multipart entities only serve as containers for other parts, you may not
34371 want to carry out specific actions on them.
34372
34373 .vitem &$mime_is_rfc822$&
34374 .vindex &$mime_is_rfc822$&
34375 This variable has the value 1 (true) if the current part is not a part of the
34376 checked message itself, but part of an attached message. Attached message
34377 decoding is fully recursive.
34378
34379 .vitem &$mime_part_count$&
34380 .vindex &$mime_part_count$&
34381 This variable is a counter that is raised for each processed MIME part. It
34382 starts at zero for the very first part (which is usually a multipart). The
34383 counter is per-message, so it is reset when processing RFC822 attachments (see
34384 &$mime_is_rfc822$&). The counter stays set after &%acl_smtp_mime%& is
34385 complete, so you can use it in the DATA ACL to determine the number of MIME
34386 parts of a message. For non-MIME messages, this variable contains the value -1.
34387 .endlist
34388
34389
34390
34391 .section "Scanning with regular expressions" "SECTscanregex"
34392 .cindex "content scanning" "with regular expressions"
34393 .cindex "regular expressions" "content scanning with"
34394 You can specify your own custom regular expression matches on the full body of
34395 the message, or on individual MIME parts.
34396
34397 The &%regex%& condition takes one or more regular expressions as arguments and
34398 matches them against the full message (when called in the DATA ACL) or a raw
34399 MIME part (when called in the MIME ACL). The &%regex%& condition matches
34400 linewise, with a maximum line length of 32K characters. That means you cannot
34401 have multiline matches with the &%regex%& condition.
34402
34403 The &%mime_regex%& condition can be called only in the MIME ACL. It matches up
34404 to 32K of decoded content (the whole content at once, not linewise). If the
34405 part has not been decoded with the &%decode%& modifier earlier in the ACL, it
34406 is decoded automatically when &%mime_regex%& is executed (using default path
34407 and filename values). If the decoded data is larger than  32K, only the first
34408 32K characters are checked.
34409
34410 The regular expressions are passed as a colon-separated list. To include a
34411 literal colon, you must double it. Since the whole right-hand side string is
34412 expanded before being used, you must also escape dollar signs and backslashes
34413 with more backslashes, or use the &`\N`& facility to disable expansion.
34414 Here is a simple example that contains two regular expressions:
34415 .code
34416 deny regex = [Mm]ortgage : URGENT BUSINESS PROPOSAL
34417      message = contains blacklisted regex ($regex_match_string)
34418 .endd
34419 The conditions returns true if any one of the regular expressions matches. The
34420 &$regex_match_string$& expansion variable is then set up and contains the
34421 matching regular expression.
34422 The expansion variables &$regex1$& &$regex2$& etc
34423 are set to any substrings captured by the regular expression.
34424
34425 &*Warning*&: With large messages, these conditions can be fairly
34426 CPU-intensive.
34427
34428 .ecindex IIDcosca
34429
34430
34431
34432
34433 . ////////////////////////////////////////////////////////////////////////////
34434 . ////////////////////////////////////////////////////////////////////////////
34435
34436 .chapter "Adding a local scan function to Exim" "CHAPlocalscan" &&&
34437          "Local scan function"
34438 .scindex IIDlosca "&[local_scan()]& function" "description of"
34439 .cindex "customizing" "input scan using C function"
34440 .cindex "policy control" "by local scan function"
34441 In these days of email worms, viruses, and ever-increasing spam, some sites
34442 want to apply a lot of checking to messages before accepting them.
34443
34444 The content scanning extension (chapter &<<CHAPexiscan>>&) has facilities for
34445 passing messages to external virus and spam scanning software. You can also do
34446 a certain amount in Exim itself through string expansions and the &%condition%&
34447 condition in the ACL that runs after the SMTP DATA command or the ACL for
34448 non-SMTP messages (see chapter &<<CHAPACL>>&), but this has its limitations.
34449
34450 To allow for further customization to a site's own requirements, there is the
34451 possibility of linking Exim with a private message scanning function, written
34452 in C. If you want to run code that is written in something other than C, you
34453 can of course use a little C stub to call it.
34454
34455 The local scan function is run once for every incoming message, at the point
34456 when Exim is just about to accept the message.
34457 It can therefore be used to control non-SMTP messages from local processes as
34458 well as messages arriving via SMTP.
34459
34460 Exim applies a timeout to calls of the local scan function, and there is an
34461 option called &%local_scan_timeout%& for setting it. The default is 5 minutes.
34462 Zero means &"no timeout"&.
34463 Exim also sets up signal handlers for SIGSEGV, SIGILL, SIGFPE, and SIGBUS
34464 before calling the local scan function, so that the most common types of crash
34465 are caught. If the timeout is exceeded or one of those signals is caught, the
34466 incoming message is rejected with a temporary error if it is an SMTP message.
34467 For a non-SMTP message, the message is dropped and Exim ends with a non-zero
34468 code. The incident is logged on the main and reject logs.
34469
34470
34471
34472 .section "Building Exim to use a local scan function" "SECID207"
34473 .cindex "&[local_scan()]& function" "building Exim to use"
34474 To make use of the local scan function feature, you must tell Exim where your
34475 function is before building Exim, by setting
34476 both HAVE_LOCAL_SCAN and
34477 LOCAL_SCAN_SOURCE in your
34478 &_Local/Makefile_&. A recommended place to put it is in the &_Local_&
34479 directory, so you might set
34480 .code
34481 HAVE_LOCAL_SCAN=yes
34482 LOCAL_SCAN_SOURCE=Local/local_scan.c
34483 .endd
34484 for example. The function must be called &[local_scan()]&;
34485 the source file(s) for it should first #define LOCAL_SCAN
34486 and then #include "local_scan.h".
34487 It is called by
34488 Exim after it has received a message, when the success return code is about to
34489 be sent. This is after all the ACLs have been run. The return code from your
34490 function controls whether the message is actually accepted or not. There is a
34491 commented template function (that just accepts the message) in the file
34492 _src/local_scan.c_.
34493
34494 If you want to make use of Exim's runtime configuration file to set options
34495 for your &[local_scan()]& function, you must also set
34496 .code
34497 LOCAL_SCAN_HAS_OPTIONS=yes
34498 .endd
34499 in &_Local/Makefile_& (see section &<<SECTconoptloc>>& below).
34500
34501
34502
34503
34504 .section "API for local_scan()" "SECTapiforloc"
34505 .cindex "&[local_scan()]& function" "API description"
34506 .cindex &%dlfunc%& "API description"
34507 You must include this line near the start of your code:
34508 .code
34509 #define LOCAL_SCAN
34510 #include "local_scan.h"
34511 .endd
34512 This header file defines a number of variables and other values, and the
34513 prototype for the function itself. Exim is coded to use unsigned char values
34514 almost exclusively, and one of the things this header defines is a shorthand
34515 for &`unsigned char`& called &`uschar`&.
34516 It also makes available the following macro definitions, to simplify casting character
34517 strings and pointers to character strings:
34518 .code
34519 #define CS   (char *)
34520 #define CCS  (const char *)
34521 #define CSS  (char **)
34522 #define US   (unsigned char *)
34523 #define CUS  (const unsigned char *)
34524 #define USS  (unsigned char **)
34525 .endd
34526 The function prototype for &[local_scan()]& is:
34527 .code
34528 extern int local_scan(int fd, uschar **return_text);
34529 .endd
34530 The arguments are as follows:
34531
34532 .ilist
34533 &%fd%& is a file descriptor for the file that contains the body of the message
34534 (the -D file). The file is open for reading and writing, but updating it is not
34535 recommended. &*Warning*&: You must &'not'& close this file descriptor.
34536
34537 The descriptor is positioned at character 19 of the file, which is the first
34538 character of the body itself, because the first 19 characters are the message
34539 id followed by &`-D`& and a newline. If you rewind the file, you should use the
34540 macro SPOOL_DATA_START_OFFSET to reset to the start of the data, just in
34541 case this changes in some future version.
34542 .next
34543 &%return_text%& is an address which you can use to return a pointer to a text
34544 string at the end of the function. The value it points to on entry is NULL.
34545 .endlist
34546
34547 The function must return an &%int%& value which is one of the following macros:
34548
34549 .vlist
34550 .vitem &`LOCAL_SCAN_ACCEPT`&
34551 .vindex "&$local_scan_data$&"
34552 The message is accepted. If you pass back a string of text, it is saved with
34553 the message, and made available in the variable &$local_scan_data$&. No
34554 newlines are permitted (if there are any, they are turned into spaces) and the
34555 maximum length of text is 1000 characters.
34556
34557 .vitem &`LOCAL_SCAN_ACCEPT_FREEZE`&
34558 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
34559 queued without immediate delivery, and is frozen.
34560
34561 .vitem &`LOCAL_SCAN_ACCEPT_QUEUE`&
34562 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
34563 queued without immediate delivery.
34564
34565 .vitem &`LOCAL_SCAN_REJECT`&
34566 The message is rejected; the returned text is used as an error message which is
34567 passed back to the sender and which is also logged. Newlines are permitted &--
34568 they cause a multiline response for SMTP rejections, but are converted to
34569 &`\n`& in log lines. If no message is given, &"Administrative prohibition"& is
34570 used.
34571
34572 .vitem &`LOCAL_SCAN_TEMPREJECT`&
34573 The message is temporarily rejected; the returned text is used as an error
34574 message as for LOCAL_SCAN_REJECT. If no message is given, &"Temporary local
34575 problem"& is used.
34576
34577 .vitem &`LOCAL_SCAN_REJECT_NOLOGHDR`&
34578 This behaves as LOCAL_SCAN_REJECT, except that the header of the rejected
34579 message is not written to the reject log. It has the effect of unsetting the
34580 &%rejected_header%& log selector for just this rejection. If
34581 &%rejected_header%& is already unset (see the discussion of the
34582 &%log_selection%& option in section &<<SECTlogselector>>&), this code is the
34583 same as LOCAL_SCAN_REJECT.
34584
34585 .vitem &`LOCAL_SCAN_TEMPREJECT_NOLOGHDR`&
34586 This code is a variation of LOCAL_SCAN_TEMPREJECT in the same way that
34587 LOCAL_SCAN_REJECT_NOLOGHDR is a variation of LOCAL_SCAN_REJECT.
34588 .endlist
34589
34590 If the message is not being received by interactive SMTP, rejections are
34591 reported by writing to &%stderr%& or by sending an email, as configured by the
34592 &%-oe%& command line options.
34593
34594
34595
34596 .section "Configuration options for local_scan()" "SECTconoptloc"
34597 .cindex "&[local_scan()]& function" "configuration options"
34598 It is possible to have option settings in the main configuration file
34599 that set values in static variables in the &[local_scan()]& module. If you
34600 want to do this, you must have the line
34601 .code
34602 LOCAL_SCAN_HAS_OPTIONS=yes
34603 .endd
34604 in your &_Local/Makefile_& when you build Exim. (This line is in
34605 &_OS/Makefile-Default_&, commented out). Then, in the &[local_scan()]& source
34606 file, you must define static variables to hold the option values, and a table
34607 to define them.
34608
34609 The table must be a vector called &%local_scan_options%&, of type
34610 &`optionlist`&. Each entry is a triplet, consisting of a name, an option type,
34611 and a pointer to the variable that holds the value. The entries must appear in
34612 alphabetical order. Following &%local_scan_options%& you must also define a
34613 variable called &%local_scan_options_count%& that contains the number of
34614 entries in the table. Here is a short example, showing two kinds of option:
34615 .code
34616 static int my_integer_option = 42;
34617 static uschar *my_string_option = US"a default string";
34618
34619 optionlist local_scan_options[] = {
34620   { "my_integer", opt_int,       &my_integer_option },
34621   { "my_string",  opt_stringptr, &my_string_option }
34622 };
34623
34624 int local_scan_options_count =
34625   sizeof(local_scan_options)/sizeof(optionlist);
34626 .endd
34627 The values of the variables can now be changed from Exim's runtime
34628 configuration file by including a local scan section as in this example:
34629 .code
34630 begin local_scan
34631 my_integer = 99
34632 my_string = some string of text...
34633 .endd
34634 The available types of option data are as follows:
34635
34636 .vlist
34637 .vitem &*opt_bool*&
34638 This specifies a boolean (true/false) option. The address should point to a
34639 variable of type &`BOOL`&, which will be set to TRUE or FALSE, which are macros
34640 that are defined as &"1"& and &"0"&, respectively. If you want to detect
34641 whether such a variable has been set at all, you can initialize it to
34642 TRUE_UNSET. (BOOL variables are integers underneath, so can hold more than two
34643 values.)
34644
34645 .vitem &*opt_fixed*&
34646 This specifies a fixed point number, such as is used for load averages.
34647 The address should point to a variable of type &`int`&. The value is stored
34648 multiplied by 1000, so, for example, 1.4142 is truncated and stored as 1414.
34649
34650 .vitem &*opt_int*&
34651 This specifies an integer; the address should point to a variable of type
34652 &`int`&. The value may be specified in any of the integer formats accepted by
34653 Exim.
34654
34655 .vitem &*opt_mkint*&
34656 This is the same as &%opt_int%&, except that when such a value is output in a
34657 &%-bP%& listing, if it is an exact number of kilobytes or megabytes, it is
34658 printed with the suffix K or M.
34659
34660 .vitem &*opt_octint*&
34661 This also specifies an integer, but the value is always interpreted as an
34662 octal integer, whether or not it starts with the digit zero, and it is
34663 always output in octal.
34664
34665 .vitem &*opt_stringptr*&
34666 This specifies a string value; the address must be a pointer to a
34667 variable that points to a string (for example, of type &`uschar *`&).
34668
34669 .vitem &*opt_time*&
34670 This specifies a time interval value. The address must point to a variable of
34671 type &`int`&. The value that is placed there is a number of seconds.
34672 .endlist
34673
34674 If the &%-bP%& command line option is followed by &`local_scan`&, Exim prints
34675 out the values of all the &[local_scan()]& options.
34676
34677
34678
34679 .section "Available Exim variables" "SECID208"
34680 .cindex "&[local_scan()]& function" "available Exim variables"
34681 The header &_local_scan.h_& gives you access to a number of C variables. These
34682 are the only ones that are guaranteed to be maintained from release to release.
34683 Note, however, that you can obtain the value of any Exim expansion variable,
34684 including &$recipients$&, by calling &'expand_string()'&. The exported
34685 C variables are as follows:
34686
34687 .vlist
34688 .vitem &*int&~body_linecount*&
34689 This variable contains the number of lines in the message's body.
34690 It is not valid if the &%spool_files_wireformat%& option is used.
34691
34692 .vitem &*int&~body_zerocount*&
34693 This variable contains the number of binary zero bytes in the message's body.
34694 It is not valid if the &%spool_files_wireformat%& option is used.
34695
34696 .vitem &*unsigned&~int&~debug_selector*&
34697 This variable is set to zero when no debugging is taking place. Otherwise, it
34698 is a bitmap of debugging selectors. Two bits are identified for use in
34699 &[local_scan()]&; they are defined as macros:
34700
34701 .ilist
34702 The &`D_v`& bit is set when &%-v%& was present on the command line. This is a
34703 testing option that is not privileged &-- any caller may set it. All the
34704 other selector bits can be set only by admin users.
34705
34706 .next
34707 The &`D_local_scan`& bit is provided for use by &[local_scan()]&; it is set
34708 by the &`+local_scan`& debug selector. It is not included in the default set
34709 of debugging bits.
34710 .endlist ilist
34711
34712 Thus, to write to the debugging output only when &`+local_scan`& has been
34713 selected, you should use code like this:
34714 .code
34715 if ((debug_selector & D_local_scan) != 0)
34716   debug_printf("xxx", ...);
34717 .endd
34718 .vitem &*uschar&~*expand_string_message*&
34719 After a failing call to &'expand_string()'& (returned value NULL), the
34720 variable &%expand_string_message%& contains the error message, zero-terminated.
34721
34722 .vitem &*header_line&~*header_list*&
34723 A pointer to a chain of header lines. The &%header_line%& structure is
34724 discussed below.
34725
34726 .vitem &*header_line&~*header_last*&
34727 A pointer to the last of the header lines.
34728
34729 .vitem &*uschar&~*headers_charset*&
34730 The value of the &%headers_charset%& configuration option.
34731
34732 .vitem &*BOOL&~host_checking*&
34733 This variable is TRUE during a host checking session that is initiated by the
34734 &%-bh%& command line option.
34735
34736 .vitem &*uschar&~*interface_address*&
34737 The IP address of the interface that received the message, as a string. This
34738 is NULL for locally submitted messages.
34739
34740 .vitem &*int&~interface_port*&
34741 The port on which this message was received. When testing with the &%-bh%&
34742 command line option, the value of this variable is -1 unless a port has been
34743 specified via the &%-oMi%& option.
34744
34745 .vitem &*uschar&~*message_id*&
34746 This variable contains Exim's message id for the incoming message (the value of
34747 &$message_exim_id$&) as a zero-terminated string.
34748
34749 .vitem &*uschar&~*received_protocol*&
34750 The name of the protocol by which the message was received.
34751
34752 .vitem &*int&~recipients_count*&
34753 The number of accepted recipients.
34754
34755 .vitem &*recipient_item&~*recipients_list*&
34756 .cindex "recipient" "adding in local scan"
34757 .cindex "recipient" "removing in local scan"
34758 The list of accepted recipients, held in a vector of length
34759 &%recipients_count%&. The &%recipient_item%& structure is discussed below. You
34760 can add additional recipients by calling &'receive_add_recipient()'& (see
34761 below). You can delete recipients by removing them from the vector and
34762 adjusting the value in &%recipients_count%&. In particular, by setting
34763 &%recipients_count%& to zero you remove all recipients. If you then return the
34764 value &`LOCAL_SCAN_ACCEPT`&, the message is accepted, but immediately
34765 blackholed. To replace the recipients, you can set &%recipients_count%& to zero
34766 and then call &'receive_add_recipient()'& as often as needed.
34767
34768 .vitem &*uschar&~*sender_address*&
34769 The envelope sender address. For bounce messages this is the empty string.
34770
34771 .vitem &*uschar&~*sender_host_address*&
34772 The IP address of the sending host, as a string. This is NULL for
34773 locally-submitted messages.
34774
34775 .vitem &*uschar&~*sender_host_authenticated*&
34776 The name of the authentication mechanism that was used, or NULL if the message
34777 was not received over an authenticated SMTP connection.
34778
34779 .vitem &*uschar&~*sender_host_name*&
34780 The name of the sending host, if known.
34781
34782 .vitem &*int&~sender_host_port*&
34783 The port on the sending host.
34784
34785 .vitem &*BOOL&~smtp_input*&
34786 This variable is TRUE for all SMTP input, including BSMTP.
34787
34788 .vitem &*BOOL&~smtp_batched_input*&
34789 This variable is TRUE for BSMTP input.
34790
34791 .vitem &*int&~store_pool*&
34792 The contents of this variable control which pool of memory is used for new
34793 requests. See section &<<SECTmemhanloc>>& for details.
34794 .endlist
34795
34796
34797 .section "Structure of header lines" "SECID209"
34798 The &%header_line%& structure contains the members listed below.
34799 You can add additional header lines by calling the &'header_add()'& function
34800 (see below). You can cause header lines to be ignored (deleted) by setting
34801 their type to *.
34802
34803
34804 .vlist
34805 .vitem &*struct&~header_line&~*next*&
34806 A pointer to the next header line, or NULL for the last line.
34807
34808 .vitem &*int&~type*&
34809 A code identifying certain headers that Exim recognizes. The codes are printing
34810 characters, and are documented in chapter &<<CHAPspool>>& of this manual.
34811 Notice in particular that any header line whose type is * is not transmitted
34812 with the message. This flagging is used for header lines that have been
34813 rewritten, or are to be removed (for example, &'Envelope-sender:'& header
34814 lines.) Effectively, * means &"deleted"&.
34815
34816 .vitem &*int&~slen*&
34817 The number of characters in the header line, including the terminating and any
34818 internal newlines.
34819
34820 .vitem &*uschar&~*text*&
34821 A pointer to the text of the header. It always ends with a newline, followed by
34822 a zero byte. Internal newlines are preserved.
34823 .endlist
34824
34825
34826
34827 .section "Structure of recipient items" "SECID210"
34828 The &%recipient_item%& structure contains these members:
34829
34830 .vlist
34831 .vitem &*uschar&~*address*&
34832 This is a pointer to the recipient address as it was received.
34833
34834 .vitem &*int&~pno*&
34835 This is used in later Exim processing when top level addresses are created by
34836 the &%one_time%& option. It is not relevant at the time &[local_scan()]& is run
34837 and must always contain -1 at this stage.
34838
34839 .vitem &*uschar&~*errors_to*&
34840 If this value is not NULL, bounce messages caused by failing to deliver to the
34841 recipient are sent to the address it contains. In other words, it overrides the
34842 envelope sender for this one recipient. (Compare the &%errors_to%& generic
34843 router option.) If a &[local_scan()]& function sets an &%errors_to%& field to
34844 an unqualified address, Exim qualifies it using the domain from
34845 &%qualify_recipient%&. When &[local_scan()]& is called, the &%errors_to%& field
34846 is NULL for all recipients.
34847 .endlist
34848
34849
34850
34851 .section "Available Exim functions" "SECID211"
34852 .cindex "&[local_scan()]& function" "available Exim functions"
34853 The header &_local_scan.h_& gives you access to a number of Exim functions.
34854 These are the only ones that are guaranteed to be maintained from release to
34855 release:
34856
34857 .vlist
34858 .vitem "&*pid_t&~child_open(uschar&~**argv,&~uschar&~**envp,&~int&~newumask,&&&
34859        &~int&~*infdptr,&~int&~*outfdptr, &~&~BOOL&~make_leader)*&"
34860
34861 This function creates a child process that runs the command specified by
34862 &%argv%&. The environment for the process is specified by &%envp%&, which can
34863 be NULL if no environment variables are to be passed. A new umask is supplied
34864 for the process in &%newumask%&.
34865
34866 Pipes to the standard input and output of the new process are set up
34867 and returned to the caller via the &%infdptr%& and &%outfdptr%& arguments. The
34868 standard error is cloned to the standard output. If there are any file
34869 descriptors &"in the way"& in the new process, they are closed. If the final
34870 argument is TRUE, the new process is made into a process group leader.
34871
34872 The function returns the pid of the new process, or -1 if things go wrong.
34873
34874 .vitem &*int&~child_close(pid_t&~pid,&~int&~timeout)*&
34875 This function waits for a child process to terminate, or for a timeout (in
34876 seconds) to expire. A timeout value of zero means wait as long as it takes. The
34877 return value is as follows:
34878
34879 .ilist
34880 >= 0
34881
34882 The process terminated by a normal exit and the value is the process
34883 ending status.
34884
34885 .next
34886 < 0 and > &--256
34887
34888 The process was terminated by a signal and the value is the negation of the
34889 signal number.
34890
34891 .next
34892 &--256
34893
34894 The process timed out.
34895 .next
34896 &--257
34897
34898 The was some other error in wait(); &%errno%& is still set.
34899 .endlist
34900
34901 .vitem &*pid_t&~child_open_exim(int&~*fd)*&
34902 This function provide you with a means of submitting a new message to
34903 Exim. (Of course, you can also call &_/usr/sbin/sendmail_& yourself if you
34904 want, but this packages it all up for you.) The function creates a pipe,
34905 forks a subprocess that is running
34906 .code
34907 exim -t -oem -oi -f <>
34908 .endd
34909 and returns to you (via the &`int *`& argument) a file descriptor for the pipe
34910 that is connected to the standard input. The yield of the function is the PID
34911 of the subprocess. You can then write a message to the file descriptor, with
34912 recipients in &'To:'&, &'Cc:'&, and/or &'Bcc:'& header lines.
34913
34914 When you have finished, call &'child_close()'& to wait for the process to
34915 finish and to collect its ending status. A timeout value of zero is usually
34916 fine in this circumstance. Unless you have made a mistake with the recipient
34917 addresses, you should get a return code of zero.
34918
34919
34920 .vitem &*pid_t&~child_open_exim2(int&~*fd,&~uschar&~*sender,&~uschar&~&&&
34921        *sender_authentication)*&
34922 This function is a more sophisticated version of &'child_open()'&. The command
34923 that it runs is:
34924 .display
34925 &`exim -t -oem -oi -f `&&'sender'&&` -oMas `&&'sender_authentication'&
34926 .endd
34927 The third argument may be NULL, in which case the &%-oMas%& option is omitted.
34928
34929
34930 .vitem &*void&~debug_printf(char&~*,&~...)*&
34931 This is Exim's debugging function, with arguments as for &'(printf()'&. The
34932 output is written to the standard error stream. If no debugging is selected,
34933 calls to &'debug_printf()'& have no effect. Normally, you should make calls
34934 conditional on the &`local_scan`& debug selector by coding like this:
34935 .code
34936 if ((debug_selector & D_local_scan) != 0)
34937   debug_printf("xxx", ...);
34938 .endd
34939
34940 .vitem &*uschar&~*expand_string(uschar&~*string)*&
34941 This is an interface to Exim's string expansion code. The return value is the
34942 expanded string, or NULL if there was an expansion failure.
34943 The C variable &%expand_string_message%& contains an error message after an
34944 expansion failure. If expansion does not change the string, the return value is
34945 the pointer to the input string. Otherwise, the return value points to a new
34946 block of memory that was obtained by a call to &'store_get()'&. See section
34947 &<<SECTmemhanloc>>& below for a discussion of memory handling.
34948
34949 .vitem &*void&~header_add(int&~type,&~char&~*format,&~...)*&
34950 This function allows you to an add additional header line at the end of the
34951 existing ones. The first argument is the type, and should normally be a space
34952 character. The second argument is a format string and any number of
34953 substitution arguments as for &[sprintf()]&. You may include internal newlines
34954 if you want, and you must ensure that the string ends with a newline.
34955
34956 .vitem "&*void&~header_add_at_position(BOOL&~after,&~uschar&~*name,&~&&&
34957         BOOL&~topnot,&~int&~type,&~char&~*format, &~&~...)*&"
34958 This function adds a new header line at a specified point in the header
34959 chain. The header itself is specified as for &'header_add()'&.
34960
34961 If &%name%& is NULL, the new header is added at the end of the chain if
34962 &%after%& is true, or at the start if &%after%& is false. If &%name%& is not
34963 NULL, the header lines are searched for the first non-deleted header that
34964 matches the name. If one is found, the new header is added before it if
34965 &%after%& is false. If &%after%& is true, the new header is added after the
34966 found header and any adjacent subsequent ones with the same name (even if
34967 marked &"deleted"&). If no matching non-deleted header is found, the &%topnot%&
34968 option controls where the header is added. If it is true, addition is at the
34969 top; otherwise at the bottom. Thus, to add a header after all the &'Received:'&
34970 headers, or at the top if there are no &'Received:'& headers, you could use
34971 .code
34972 header_add_at_position(TRUE, US"Received", TRUE,
34973   ' ', "X-xxx: ...");
34974 .endd
34975 Normally, there is always at least one non-deleted &'Received:'& header, but
34976 there may not be if &%received_header_text%& expands to an empty string.
34977
34978
34979 .vitem &*void&~header_remove(int&~occurrence,&~uschar&~*name)*&
34980 This function removes header lines. If &%occurrence%& is zero or negative, all
34981 occurrences of the header are removed. If occurrence is greater than zero, that
34982 particular instance of the header is removed. If no header(s) can be found that
34983 match the specification, the function does nothing.
34984
34985
34986 .vitem "&*BOOL&~header_testname(header_line&~*hdr,&~uschar&~*name,&~&&&
34987         int&~length,&~BOOL&~notdel)*&"
34988 This function tests whether the given header has the given name. It is not just
34989 a string comparison, because white space is permitted between the name and the
34990 colon. If the &%notdel%& argument is true, a false return is forced for all
34991 &"deleted"& headers; otherwise they are not treated specially. For example:
34992 .code
34993 if (header_testname(h, US"X-Spam", 6, TRUE)) ...
34994 .endd
34995 .vitem &*uschar&~*lss_b64encode(uschar&~*cleartext,&~int&~length)*&
34996 .cindex "base64 encoding" "functions for &[local_scan()]& use"
34997 This function base64-encodes a string, which is passed by address and length.
34998 The text may contain bytes of any value, including zero. The result is passed
34999 back in dynamic memory that is obtained by calling &'store_get()'&. It is
35000 zero-terminated.
35001
35002 .vitem &*int&~lss_b64decode(uschar&~*codetext,&~uschar&~**cleartext)*&
35003 This function decodes a base64-encoded string. Its arguments are a
35004 zero-terminated base64-encoded string and the address of a variable that is set
35005 to point to the result, which is in dynamic memory. The length of the decoded
35006 string is the yield of the function. If the input is invalid base64 data, the
35007 yield is -1. A zero byte is added to the end of the output string to make it
35008 easy to interpret as a C string (assuming it contains no zeros of its own). The
35009 added zero byte is not included in the returned count.
35010
35011 .vitem &*int&~lss_match_domain(uschar&~*domain,&~uschar&~*list)*&
35012 This function checks for a match in a domain list. Domains are always
35013 matched caselessly. The return value is one of the following:
35014 .display
35015 &`OK     `& match succeeded
35016 &`FAIL   `& match failed
35017 &`DEFER  `& match deferred
35018 .endd
35019 DEFER is usually caused by some kind of lookup defer, such as the
35020 inability to contact a database.
35021
35022 .vitem "&*int&~lss_match_local_part(uschar&~*localpart,&~uschar&~*list,&~&&&
35023         BOOL&~caseless)*&"
35024 This function checks for a match in a local part list. The third argument
35025 controls case-sensitivity. The return values are as for
35026 &'lss_match_domain()'&.
35027
35028 .vitem "&*int&~lss_match_address(uschar&~*address,&~uschar&~*list,&~&&&
35029         BOOL&~caseless)*&"
35030 This function checks for a match in an address list. The third argument
35031 controls the case-sensitivity of the local part match. The domain is always
35032 matched caselessly. The return values are as for &'lss_match_domain()'&.
35033
35034 .vitem "&*int&~lss_match_host(uschar&~*host_name,&~uschar&~*host_address,&~&&&
35035         uschar&~*list)*&"
35036 This function checks for a match in a host list. The most common usage is
35037 expected to be
35038 .code
35039 lss_match_host(sender_host_name, sender_host_address, ...)
35040 .endd
35041 .vindex "&$sender_host_address$&"
35042 An empty address field matches an empty item in the host list. If the host name
35043 is NULL, the name corresponding to &$sender_host_address$& is automatically
35044 looked up if a host name is required to match an item in the list. The return
35045 values are as for &'lss_match_domain()'&, but in addition, &'lss_match_host()'&
35046 returns ERROR in the case when it had to look up a host name, but the lookup
35047 failed.
35048
35049 .vitem "&*void&~log_write(unsigned&~int&~selector,&~int&~which,&~char&~&&&
35050         *format,&~...)*&"
35051 This function writes to Exim's log files. The first argument should be zero (it
35052 is concerned with &%log_selector%&). The second argument can be &`LOG_MAIN`& or
35053 &`LOG_REJECT`& or &`LOG_PANIC`& or the inclusive &"or"& of any combination of
35054 them. It specifies to which log or logs the message is written. The remaining
35055 arguments are a format and relevant insertion arguments. The string should not
35056 contain any newlines, not even at the end.
35057
35058
35059 .vitem &*void&~receive_add_recipient(uschar&~*address,&~int&~pno)*&
35060 This function adds an additional recipient to the message. The first argument
35061 is the recipient address. If it is unqualified (has no domain), it is qualified
35062 with the &%qualify_recipient%& domain. The second argument must always be -1.
35063
35064 This function does not allow you to specify a private &%errors_to%& address (as
35065 described with the structure of &%recipient_item%& above), because it pre-dates
35066 the addition of that field to the structure. However, it is easy to add such a
35067 value afterwards. For example:
35068 .code
35069  receive_add_recipient(US"monitor@mydom.example", -1);
35070  recipients_list[recipients_count-1].errors_to =
35071    US"postmaster@mydom.example";
35072 .endd
35073
35074 .vitem &*BOOL&~receive_remove_recipient(uschar&~*recipient)*&
35075 This is a convenience function to remove a named recipient from the list of
35076 recipients. It returns true if a recipient was removed, and false if no
35077 matching recipient could be found. The argument must be a complete email
35078 address.
35079 .endlist
35080
35081
35082 .cindex "RFC 2047"
35083 .vlist
35084 .vitem "&*uschar&~rfc2047_decode(uschar&~*string,&~BOOL&~lencheck,&&&
35085   &~uschar&~*target,&~int&~zeroval,&~int&~*lenptr, &~&~uschar&~**error)*&"
35086 This function decodes strings that are encoded according to RFC 2047. Typically
35087 these are the contents of header lines. First, each &"encoded word"& is decoded
35088 from the Q or B encoding into a byte-string. Then, if provided with the name of
35089 a charset encoding, and if the &[iconv()]& function is available, an attempt is
35090 made  to translate the result to the named character set. If this fails, the
35091 binary string is returned with an error message.
35092
35093 The first argument is the string to be decoded. If &%lencheck%& is TRUE, the
35094 maximum MIME word length is enforced. The third argument is the target
35095 encoding, or NULL if no translation is wanted.
35096
35097 .cindex "binary zero" "in RFC 2047 decoding"
35098 .cindex "RFC 2047" "binary zero in"
35099 If a binary zero is encountered in the decoded string, it is replaced by the
35100 contents of the &%zeroval%& argument. For use with Exim headers, the value must
35101 not be 0 because header lines are handled as zero-terminated strings.
35102
35103 The function returns the result of processing the string, zero-terminated; if
35104 &%lenptr%& is not NULL, the length of the result is set in the variable to
35105 which it points. When &%zeroval%& is 0, &%lenptr%& should not be NULL.
35106
35107 If an error is encountered, the function returns NULL and uses the &%error%&
35108 argument to return an error message. The variable pointed to by &%error%& is
35109 set to NULL if there is no error; it may be set non-NULL even when the function
35110 returns a non-NULL value if decoding was successful, but there was a problem
35111 with translation.
35112
35113
35114 .vitem &*int&~smtp_fflush(void)*&
35115 This function is used in conjunction with &'smtp_printf()'&, as described
35116 below.
35117
35118 .vitem &*void&~smtp_printf(char&~*,BOOL,&~...)*&
35119 The arguments of this function are almost like &[printf()]&; it writes to the SMTP
35120 output stream. You should use this function only when there is an SMTP output
35121 stream, that is, when the incoming message is being received via interactive
35122 SMTP. This is the case when &%smtp_input%& is TRUE and &%smtp_batched_input%&
35123 is FALSE. If you want to test for an incoming message from another host (as
35124 opposed to a local process that used the &%-bs%& command line option), you can
35125 test the value of &%sender_host_address%&, which is non-NULL when a remote host
35126 is involved.
35127
35128 If an SMTP TLS connection is established, &'smtp_printf()'& uses the TLS
35129 output function, so it can be used for all forms of SMTP connection.
35130
35131 The second argument is used to request that the data be buffered
35132 (when TRUE) or flushed (along with any previously buffered, when FALSE).
35133 This is advisory only, but likely to save on system-calls and packets
35134 sent when a sequence of calls to the function are made.
35135
35136 The argument was added in Exim version 4.90 - changing the API/ABI.
35137 Nobody noticed until 4.93 was imminent, at which point the
35138 ABI version number was incremented.
35139
35140 Strings that are written by &'smtp_printf()'& from within &[local_scan()]&
35141 must start with an appropriate response code: 550 if you are going to return
35142 LOCAL_SCAN_REJECT, 451 if you are going to return
35143 LOCAL_SCAN_TEMPREJECT, and 250 otherwise. Because you are writing the
35144 initial lines of a multi-line response, the code must be followed by a hyphen
35145 to indicate that the line is not the final response line. You must also ensure
35146 that the lines you write terminate with CRLF. For example:
35147 .code
35148 smtp_printf("550-this is some extra info\r\n");
35149 return LOCAL_SCAN_REJECT;
35150 .endd
35151 Note that you can also create multi-line responses by including newlines in
35152 the data returned via the &%return_text%& argument. The added value of using
35153 &'smtp_printf()'& is that, for instance, you could introduce delays between
35154 multiple output lines.
35155
35156 The &'smtp_printf()'& function does not return any error indication, because it
35157 does not
35158 guarantee a flush of
35159 pending output, and therefore does not test
35160 the state of the stream. (In the main code of Exim, flushing and error
35161 detection is done when Exim is ready for the next SMTP input command.) If
35162 you want to flush the output and check for an error (for example, the
35163 dropping of a TCP/IP connection), you can call &'smtp_fflush()'&, which has no
35164 arguments. It flushes the output stream, and returns a non-zero value if there
35165 is an error.
35166
35167 .vitem &*void&~*store_get(int,BOOL)*&
35168 This function accesses Exim's internal store (memory) manager. It gets a new
35169 chunk of memory whose size is given by the first argument.
35170 The second argument should be given as TRUE if the memory will be used for
35171 data possibly coming from an attacker (eg. the message content),
35172 FALSE if it is locally-sourced.
35173 Exim bombs out if it ever
35174 runs out of memory. See the next section for a discussion of memory handling.
35175
35176 .vitem &*void&~*store_get_perm(int,BOOL)*&
35177 This function is like &'store_get()'&, but it always gets memory from the
35178 permanent pool. See the next section for a discussion of memory handling.
35179
35180 .vitem &*uschar&~*string_copy(uschar&~*string)*&
35181 See below.
35182
35183 .vitem &*uschar&~*string_copyn(uschar&~*string,&~int&~length)*&
35184 See below.
35185
35186 .vitem &*uschar&~*string_sprintf(char&~*format,&~...)*&
35187 These three functions create strings using Exim's dynamic memory facilities.
35188 The first makes a copy of an entire string. The second copies up to a maximum
35189 number of characters, indicated by the second argument. The third uses a format
35190 and insertion arguments to create a new string. In each case, the result is a
35191 pointer to a new string in the current memory pool. See the next section for
35192 more discussion.
35193 .endlist
35194
35195
35196
35197 .section "More about Exim's memory handling" "SECTmemhanloc"
35198 .cindex "&[local_scan()]& function" "memory handling"
35199 No function is provided for freeing memory, because that is never needed.
35200 The dynamic memory that Exim uses when receiving a message is automatically
35201 recycled if another message is received by the same process (this applies only
35202 to incoming SMTP connections &-- other input methods can supply only one
35203 message at a time). After receiving the last message, a reception process
35204 terminates.
35205
35206 Because it is recycled, the normal dynamic memory cannot be used for holding
35207 data that must be preserved over a number of incoming messages on the same SMTP
35208 connection. However, Exim in fact uses two pools of dynamic memory; the second
35209 one is not recycled, and can be used for this purpose.
35210
35211 If you want to allocate memory that remains available for subsequent messages
35212 in the same SMTP connection, you should set
35213 .code
35214 store_pool = POOL_PERM
35215 .endd
35216 before calling the function that does the allocation. There is no need to
35217 restore the value if you do not need to; however, if you do want to revert to
35218 the normal pool, you can either restore the previous value of &%store_pool%& or
35219 set it explicitly to POOL_MAIN.
35220
35221 The pool setting applies to all functions that get dynamic memory, including
35222 &'expand_string()'&, &'store_get()'&, and the &'string_xxx()'& functions.
35223 There is also a convenience function called &'store_get_perm()'& that gets a
35224 block of memory from the permanent pool while preserving the value of
35225 &%store_pool%&.
35226 .ecindex IIDlosca
35227
35228
35229
35230
35231 . ////////////////////////////////////////////////////////////////////////////
35232 . ////////////////////////////////////////////////////////////////////////////
35233
35234 .chapter "System-wide message filtering" "CHAPsystemfilter"
35235 .scindex IIDsysfil1 "filter" "system filter"
35236 .scindex IIDsysfil2 "filtering all mail"
35237 .scindex IIDsysfil3 "system filter"
35238 The previous chapters (on ACLs and the local scan function) describe checks
35239 that can be applied to messages before they are accepted by a host. There is
35240 also a mechanism for checking messages once they have been received, but before
35241 they are delivered. This is called the &'system filter'&.
35242
35243 The system filter operates in a similar manner to users' filter files, but it
35244 is run just once per message (however many recipients the message has).
35245 It should not normally be used as a substitute for routing, because &%deliver%&
35246 commands in a system router provide new envelope recipient addresses.
35247 The system filter must be an Exim filter. It cannot be a Sieve filter.
35248
35249 The system filter is run at the start of a delivery attempt, before any routing
35250 is done. If a message fails to be completely delivered at the first attempt,
35251 the system filter is run again at the start of every retry.
35252 If you want your filter to do something only once per message, you can make use
35253 of the &%first_delivery%& condition in an &%if%& command in the filter to
35254 prevent it happening on retries.
35255
35256 .vindex "&$domain$&"
35257 .vindex "&$local_part$&"
35258 &*Warning*&: Because the system filter runs just once, variables that are
35259 specific to individual recipient addresses, such as &$local_part$& and
35260 &$domain$&, are not set, and the &"personal"& condition is not meaningful. If
35261 you want to run a centrally-specified filter for each recipient address
35262 independently, you can do so by setting up a suitable &(redirect)& router, as
35263 described in section &<<SECTperaddfil>>& below.
35264
35265
35266 .section "Specifying a system filter" "SECID212"
35267 .cindex "uid (user id)" "system filter"
35268 .cindex "gid (group id)" "system filter"
35269 The name of the file that contains the system filter must be specified by
35270 setting &%system_filter%&. If you want the filter to run under a uid and gid
35271 other than root, you must also set &%system_filter_user%& and
35272 &%system_filter_group%& as appropriate. For example:
35273 .code
35274 system_filter = /etc/mail/exim.filter
35275 system_filter_user = exim
35276 .endd
35277 If a system filter generates any deliveries directly to files or pipes (via the
35278 &%save%& or &%pipe%& commands), transports to handle these deliveries must be
35279 specified by setting &%system_filter_file_transport%& and
35280 &%system_filter_pipe_transport%&, respectively. Similarly,
35281 &%system_filter_reply_transport%& must be set to handle any messages generated
35282 by the &%reply%& command.
35283
35284
35285 .section "Testing a system filter" "SECID213"
35286 You can run simple tests of a system filter in the same way as for a user
35287 filter, but you should use &%-bF%& rather than &%-bf%&, so that features that
35288 are permitted only in system filters are recognized.
35289
35290 If you want to test the combined effect of a system filter and a user filter,
35291 you can use both &%-bF%& and &%-bf%& on the same command line.
35292
35293
35294
35295 .section "Contents of a system filter" "SECID214"
35296 The language used to specify system filters is the same as for users' filter
35297 files. It is described in the separate end-user document &'Exim's interface to
35298 mail filtering'&. However, there are some additional features that are
35299 available only in system filters; these are described in subsequent sections.
35300 If they are encountered in a user's filter file or when testing with &%-bf%&,
35301 they cause errors.
35302
35303 .cindex "frozen messages" "manual thaw; testing in filter"
35304 There are two special conditions which, though available in users' filter
35305 files, are designed for use in system filters. The condition &%first_delivery%&
35306 is true only for the first attempt at delivering a message, and
35307 &%manually_thawed%& is true only if the message has been frozen, and
35308 subsequently thawed by an admin user. An explicit forced delivery counts as a
35309 manual thaw, but thawing as a result of the &%auto_thaw%& setting does not.
35310
35311 &*Warning*&: If a system filter uses the &%first_delivery%& condition to
35312 specify an &"unseen"& (non-significant) delivery, and that delivery does not
35313 succeed, it will not be tried again.
35314 If you want Exim to retry an unseen delivery until it succeeds, you should
35315 arrange to set it up every time the filter runs.
35316
35317 When a system filter finishes running, the values of the variables &$n0$& &--
35318 &$n9$& are copied into &$sn0$& &-- &$sn9$& and are thereby made available to
35319 users' filter files. Thus a system filter can, for example, set up &"scores"&
35320 to which users' filter files can refer.
35321
35322
35323
35324 .section "Additional variable for system filters" "SECID215"
35325 .vindex "&$recipients$&"
35326 The expansion variable &$recipients$&, containing a list of all the recipients
35327 of the message (separated by commas and white space), is available in system
35328 filters. It is not available in users' filters for privacy reasons.
35329
35330
35331
35332 .section "Defer, freeze, and fail commands for system filters" "SECID216"
35333 .cindex "freezing messages"
35334 .cindex "message" "freezing"
35335 .cindex "message" "forced failure"
35336 .cindex "&%fail%&" "in system filter"
35337 .cindex "&%freeze%& in system filter"
35338 .cindex "&%defer%& in system filter"
35339 There are three extra commands (&%defer%&, &%freeze%& and &%fail%&) which are
35340 always available in system filters, but are not normally enabled in users'
35341 filters. (See the &%allow_defer%&, &%allow_freeze%& and &%allow_fail%& options
35342 for the &(redirect)& router.) These commands can optionally be followed by the
35343 word &%text%& and a string containing an error message, for example:
35344 .code
35345 fail text "this message looks like spam to me"
35346 .endd
35347 The keyword &%text%& is optional if the next character is a double quote.
35348
35349 The &%defer%& command defers delivery of the original recipients of the
35350 message. The &%fail%& command causes all the original recipients to be failed,
35351 and a bounce message to be created. The &%freeze%& command suspends all
35352 delivery attempts for the original recipients. In all cases, any new deliveries
35353 that are specified by the filter are attempted as normal after the filter has
35354 run.
35355
35356 The &%freeze%& command is ignored if the message has been manually unfrozen and
35357 not manually frozen since. This means that automatic freezing by a system
35358 filter can be used as a way of checking out suspicious messages. If a message
35359 is found to be all right, manually unfreezing it allows it to be delivered.
35360
35361 .cindex "log" "&%fail%& command log line"
35362 .cindex "&%fail%&" "log line; reducing"
35363 The text given with a fail command is used as part of the bounce message as
35364 well as being written to the log. If the message is quite long, this can fill
35365 up a lot of log space when such failures are common. To reduce the size of the
35366 log message, Exim interprets the text in a special way if it starts with the
35367 two characters &`<<`& and contains &`>>`& later. The text between these two
35368 strings is written to the log, and the rest of the text is used in the bounce
35369 message. For example:
35370 .code
35371 fail "<<filter test 1>>Your message is rejected \
35372      because it contains attachments that we are \
35373      not prepared to receive."
35374 .endd
35375
35376 .cindex "loop" "caused by &%fail%&"
35377 Take great care with the &%fail%& command when basing the decision to fail on
35378 the contents of the message, because the bounce message will of course include
35379 the contents of the original message and will therefore trigger the &%fail%&
35380 command again (causing a mail loop) unless steps are taken to prevent this.
35381 Testing the &%error_message%& condition is one way to prevent this. You could
35382 use, for example
35383 .code
35384 if $message_body contains "this is spam" and not error_message
35385 then fail text "spam is not wanted here" endif
35386 .endd
35387 though of course that might let through unwanted bounce messages. The
35388 alternative is clever checking of the body and/or headers to detect bounces
35389 generated by the filter.
35390
35391 The interpretation of a system filter file ceases after a
35392 &%defer%&,
35393 &%freeze%&, or &%fail%& command is obeyed. However, any deliveries that were
35394 set up earlier in the filter file are honoured, so you can use a sequence such
35395 as
35396 .code
35397 mail ...
35398 freeze
35399 .endd
35400 to send a specified message when the system filter is freezing (or deferring or
35401 failing) a message. The normal deliveries for the message do not, of course,
35402 take place.
35403
35404
35405
35406 .section "Adding and removing headers in a system filter" "SECTaddremheasys"
35407 .cindex "header lines" "adding; in system filter"
35408 .cindex "header lines" "removing; in system filter"
35409 .cindex "filter" "header lines; adding/removing"
35410 Two filter commands that are available only in system filters are:
35411 .code
35412 headers add <string>
35413 headers remove <string>
35414 .endd
35415 The argument for the &%headers add%& is a string that is expanded and then
35416 added to the end of the message's headers. It is the responsibility of the
35417 filter maintainer to make sure it conforms to RFC 2822 syntax. Leading white
35418 space is ignored, and if the string is otherwise empty, or if the expansion is
35419 forced to fail, the command has no effect.
35420
35421 You can use &"\n"& within the string, followed by white space, to specify
35422 continued header lines. More than one header may be added in one command by
35423 including &"\n"& within the string without any following white space. For
35424 example:
35425 .code
35426 headers add "X-header-1: ....\n  \
35427              continuation of X-header-1 ...\n\
35428              X-header-2: ...."
35429 .endd
35430 Note that the header line continuation white space after the first newline must
35431 be placed before the backslash that continues the input string, because white
35432 space after input continuations is ignored.
35433
35434 The argument for &%headers remove%& is a colon-separated list of header names.
35435 This command applies only to those headers that are stored with the message;
35436 those that are added at delivery time (such as &'Envelope-To:'& and
35437 &'Return-Path:'&) cannot be removed by this means. If there is more than one
35438 header with the same name, they are all removed.
35439
35440 The &%headers%& command in a system filter makes an immediate change to the set
35441 of header lines that was received with the message (with possible additions
35442 from ACL processing). Subsequent commands in the system filter operate on the
35443 modified set, which also forms the basis for subsequent message delivery.
35444 Unless further modified during routing or transporting, this set of headers is
35445 used for all recipients of the message.
35446
35447 During routing and transporting, the variables that refer to the contents of
35448 header lines refer only to those lines that are in this set. Thus, header lines
35449 that are added by a system filter are visible to users' filter files and to all
35450 routers and transports. This contrasts with the manipulation of header lines by
35451 routers and transports, which is not immediate, but which instead is saved up
35452 until the message is actually being written (see section
35453 &<<SECTheadersaddrem>>&).
35454
35455 If the message is not delivered at the first attempt, header lines that were
35456 added by the system filter are stored with the message, and so are still
35457 present at the next delivery attempt. Header lines that were removed are still
35458 present, but marked &"deleted"& so that they are not transported with the
35459 message. For this reason, it is usual to make the &%headers%& command
35460 conditional on &%first_delivery%& so that the set of header lines is not
35461 modified more than once.
35462
35463 Because header modification in a system filter acts immediately, you have to
35464 use an indirect approach if you want to modify the contents of a header line.
35465 For example:
35466 .code
35467 headers add "Old-Subject: $h_subject:"
35468 headers remove "Subject"
35469 headers add "Subject: new subject (was: $h_old-subject:)"
35470 headers remove "Old-Subject"
35471 .endd
35472
35473
35474
35475 .section "Setting an errors address in a system filter" "SECID217"
35476 .cindex "envelope from"
35477 .cindex "envelope sender"
35478 In a system filter, if a &%deliver%& command is followed by
35479 .code
35480 errors_to <some address>
35481 .endd
35482 in order to change the envelope sender (and hence the error reporting) for that
35483 delivery, any address may be specified. (In a user filter, only the current
35484 user's address can be set.) For example, if some mail is being monitored, you
35485 might use
35486 .code
35487 unseen deliver monitor@spying.example errors_to root@local.example
35488 .endd
35489 to take a copy which would not be sent back to the normal error reporting
35490 address if its delivery failed.
35491
35492
35493
35494 .section "Per-address filtering" "SECTperaddfil"
35495 .vindex "&$domain_data$&"
35496 .vindex "&$local_part_data$&"
35497 In contrast to the system filter, which is run just once per message for each
35498 delivery attempt, it is also possible to set up a system-wide filtering
35499 operation that runs once for each recipient address. In this case, variables
35500 such as &$local_part_data$& and &$domain_data$& can be used,
35501 and indeed, the choice of filter file could be made dependent on them.
35502 This is an example of a router which implements such a filter:
35503 .code
35504 central_filter:
35505   check_local_user
35506   driver = redirect
35507   domains = +local_domains
35508   file = /central/filters/$local_part_data
35509   no_verify
35510   allow_filter
35511   allow_freeze
35512 .endd
35513 The filter is run in a separate process under its own uid. Therefore, either
35514 &%check_local_user%& must be set (as above), in which case the filter is run as
35515 the local user, or the &%user%& option must be used to specify which user to
35516 use. If both are set, &%user%& overrides.
35517
35518 Care should be taken to ensure that none of the commands in the filter file
35519 specify a significant delivery if the message is to go on to be delivered to
35520 its intended recipient. The router will not then claim to have dealt with the
35521 address, so it will be passed on to subsequent routers to be delivered in the
35522 normal way.
35523 .ecindex IIDsysfil1
35524 .ecindex IIDsysfil2
35525 .ecindex IIDsysfil3
35526
35527
35528
35529
35530
35531
35532 . ////////////////////////////////////////////////////////////////////////////
35533 . ////////////////////////////////////////////////////////////////////////////
35534
35535 .chapter "Message processing" "CHAPmsgproc"
35536 .scindex IIDmesproc "message" "general processing"
35537 Exim performs various transformations on the sender and recipient addresses of
35538 all messages that it handles, and also on the messages' header lines. Some of
35539 these are optional and configurable, while others always take place. All of
35540 this processing, except rewriting as a result of routing, and the addition or
35541 removal of header lines while delivering, happens when a message is received,
35542 before it is placed on Exim's queue.
35543
35544 Some of the automatic processing takes place by default only for
35545 &"locally-originated"& messages. This adjective is used to describe messages
35546 that are not received over TCP/IP, but instead are passed to an Exim process on
35547 its standard input. This includes the interactive &"local SMTP"& case that is
35548 set up by the &%-bs%& command line option.
35549
35550 &*Note*&: Messages received over TCP/IP on the loopback interface (127.0.0.1
35551 or ::1) are not considered to be locally-originated. Exim does not treat the
35552 loopback interface specially in any way.
35553
35554 If you want the loopback interface to be treated specially, you must ensure
35555 that there are appropriate entries in your ACLs.
35556
35557
35558
35559
35560 .section "Submission mode for non-local messages" "SECTsubmodnon"
35561 .cindex "message" "submission"
35562 .cindex "submission mode"
35563 Processing that happens automatically for locally-originated messages (unless
35564 &%suppress_local_fixups%& is set) can also be requested for messages that are
35565 received over TCP/IP. The term &"submission mode"& is used to describe this
35566 state. Submission mode is set by the modifier
35567 .code
35568 control = submission
35569 .endd
35570 in a MAIL, RCPT, or pre-data ACL for an incoming message (see sections
35571 &<<SECTACLmodi>>& and &<<SECTcontrols>>&). This makes Exim treat the message as
35572 a local submission, and is normally used when the source of the message is
35573 known to be an MUA running on a client host (as opposed to an MTA). For
35574 example, to set submission mode for messages originating on the IPv4 loopback
35575 interface, you could include the following in the MAIL ACL:
35576 .code
35577 warn  hosts = 127.0.0.1
35578       control = submission
35579 .endd
35580 .cindex "&%sender_retain%& submission option"
35581 There are some options that can be used when setting submission mode. A slash
35582 is used to separate options. For example:
35583 .code
35584 control = submission/sender_retain
35585 .endd
35586 Specifying &%sender_retain%& has the effect of setting &%local_sender_retain%&
35587 true and &%local_from_check%& false for the current incoming message. The first
35588 of these allows an existing &'Sender:'& header in the message to remain, and
35589 the second suppresses the check to ensure that &'From:'& matches the
35590 authenticated sender. With this setting, Exim still fixes up messages by adding
35591 &'Date:'& and &'Message-ID:'& header lines if they are missing, but makes no
35592 attempt to check sender authenticity in header lines.
35593
35594 When &%sender_retain%& is not set, a submission mode setting may specify a
35595 domain to be used when generating a &'From:'& or &'Sender:'& header line. For
35596 example:
35597 .code
35598 control = submission/domain=some.domain
35599 .endd
35600 The domain may be empty. How this value is used is described in sections
35601 &<<SECTthefrohea>>& and &<<SECTthesenhea>>&. There is also a &%name%& option
35602 that allows you to specify the user's full name for inclusion in a created
35603 &'Sender:'& or &'From:'& header line. For example:
35604 .code
35605 accept authenticated = *
35606        control = submission/domain=wonderland.example/\
35607                             name=${lookup {$authenticated_id} \
35608                                    lsearch {/etc/exim/namelist}}
35609 .endd
35610 Because the name may contain any characters, including slashes, the &%name%&
35611 option must be given last. The remainder of the string is used as the name. For
35612 the example above, if &_/etc/exim/namelist_& contains:
35613 .code
35614 bigegg:  Humpty Dumpty
35615 .endd
35616 then when the sender has authenticated as &'bigegg'&, the generated &'Sender:'&
35617 line would be:
35618 .code
35619 Sender: Humpty Dumpty <bigegg@wonderland.example>
35620 .endd
35621 .cindex "return path" "in submission mode"
35622 By default, submission mode forces the return path to the same address as is
35623 used to create the &'Sender:'& header. However, if &%sender_retain%& is
35624 specified, the return path is also left unchanged.
35625
35626 &*Note*&: The changes caused by submission mode take effect after the predata
35627 ACL. This means that any sender checks performed before the fix-ups use the
35628 untrusted sender address specified by the user, not the trusted sender address
35629 specified by submission mode. Although this might be slightly unexpected, it
35630 does mean that you can configure ACL checks to spot that a user is trying to
35631 spoof another's address.
35632
35633 .section "Line endings" "SECTlineendings"
35634 .cindex "line endings"
35635 .cindex "carriage return"
35636 .cindex "linefeed"
35637 RFC 2821 specifies that CRLF (two characters: carriage-return, followed by
35638 linefeed) is the line ending for messages transmitted over the Internet using
35639 SMTP over TCP/IP. However, within individual operating systems, different
35640 conventions are used. For example, Unix-like systems use just LF, but others
35641 use CRLF or just CR.
35642
35643 Exim was designed for Unix-like systems, and internally, it stores messages
35644 using the system's convention of a single LF as a line terminator. When
35645 receiving a message, all line endings are translated to this standard format.
35646 Originally, it was thought that programs that passed messages directly to an
35647 MTA within an operating system would use that system's convention. Experience
35648 has shown that this is not the case; for example, there are Unix applications
35649 that use CRLF in this circumstance. For this reason, and for compatibility with
35650 other MTAs, the way Exim handles line endings for all messages is now as
35651 follows:
35652
35653 .ilist
35654 LF not preceded by CR is treated as a line ending.
35655 .next
35656 CR is treated as a line ending; if it is immediately followed by LF, the LF
35657 is ignored.
35658 .next
35659 The sequence &"CR, dot, CR"& does not terminate an incoming SMTP message,
35660 nor a local message in the state where a line containing only a dot is a
35661 terminator.
35662 .next
35663 If a bare CR is encountered within a header line, an extra space is added after
35664 the line terminator so as not to end the header line. The reasoning behind this
35665 is that bare CRs in header lines are most likely either to be mistakes, or
35666 people trying to play silly games.
35667 .next
35668 If the first header line received in a message ends with CRLF, a subsequent
35669 bare LF in a header line is treated in the same way as a bare CR in a header
35670 line.
35671 .endlist
35672
35673
35674
35675
35676
35677 .section "Unqualified addresses" "SECID218"
35678 .cindex "unqualified addresses"
35679 .cindex "address" "qualification"
35680 By default, Exim expects every envelope address it receives from an external
35681 host to be fully qualified. Unqualified addresses cause negative responses to
35682 SMTP commands. However, because SMTP is used as a means of transporting
35683 messages from MUAs running on personal workstations, there is sometimes a
35684 requirement to accept unqualified addresses from specific hosts or IP networks.
35685
35686 Exim has two options that separately control which hosts may send unqualified
35687 sender or recipient addresses in SMTP commands, namely
35688 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&. In both
35689 cases, if an unqualified address is accepted, it is qualified by adding the
35690 value of &%qualify_domain%& or &%qualify_recipient%&, as appropriate.
35691
35692 .oindex "&%qualify_domain%&"
35693 .oindex "&%qualify_recipient%&"
35694 Unqualified addresses in header lines are automatically qualified for messages
35695 that are locally originated, unless the &%-bnq%& option is given on the command
35696 line. For messages received over SMTP, unqualified addresses in header lines
35697 are qualified only if unqualified addresses are permitted in SMTP commands. In
35698 other words, such qualification is also controlled by
35699 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&,
35700
35701
35702
35703
35704 .section "The UUCP From line" "SECID219"
35705 .cindex "&""From""& line"
35706 .cindex "UUCP" "&""From""& line"
35707 .cindex "sender" "address"
35708 .oindex "&%uucp_from_pattern%&"
35709 .oindex "&%uucp_from_sender%&"
35710 .cindex "envelope from"
35711 .cindex "envelope sender"
35712 .cindex "Sendmail compatibility" "&""From""& line"
35713 Messages that have come from UUCP (and some other applications) often begin
35714 with a line containing the envelope sender and a timestamp, following the word
35715 &"From"&. Examples of two common formats are:
35716 .code
35717 From a.oakley@berlin.mus Fri Jan  5 12:35 GMT 1996
35718 From f.butler@berlin.mus Fri, 7 Jan 97 14:00:00 GMT
35719 .endd
35720 This line precedes the RFC 2822 header lines. For compatibility with Sendmail,
35721 Exim recognizes such lines at the start of messages that are submitted to it
35722 via the command line (that is, on the standard input). It does not recognize
35723 such lines in incoming SMTP messages, unless the sending host matches
35724 &%ignore_fromline_hosts%& or the &%-bs%& option was used for a local message
35725 and &%ignore_fromline_local%& is set. The recognition is controlled by a
35726 regular expression that is defined by the &%uucp_from_pattern%& option, whose
35727 default value matches the two common cases shown above and puts the address
35728 that follows &"From"& into &$1$&.
35729
35730 .cindex "numerical variables (&$1$& &$2$& etc)" "in &""From ""& line handling"
35731 When the caller of Exim for a non-SMTP message that contains a &"From"& line is
35732 a trusted user, the message's sender address is constructed by expanding the
35733 contents of &%uucp_sender_address%&, whose default value is &"$1"&. This is
35734 then parsed as an RFC 2822 address. If there is no domain, the local part is
35735 qualified with &%qualify_domain%& unless it is the empty string. However, if
35736 the command line &%-f%& option is used, it overrides the &"From"& line.
35737
35738 If the caller of Exim is not trusted, the &"From"& line is recognized, but the
35739 sender address is not changed. This is also the case for incoming SMTP messages
35740 that are permitted to contain &"From"& lines.
35741
35742 Only one &"From"& line is recognized. If there is more than one, the second is
35743 treated as a data line that starts the body of the message, as it is not valid
35744 as a header line. This also happens if a &"From"& line is present in an
35745 incoming SMTP message from a source that is not permitted to send them.
35746
35747
35748
35749 .section "Resent- header lines" "SECID220"
35750 .cindex "&%Resent-%& header lines"
35751 .cindex "header lines" "Resent-"
35752 RFC 2822 makes provision for sets of header lines starting with the string
35753 &`Resent-`& to be added to a message when it is resent by the original
35754 recipient to somebody else. These headers are &'Resent-Date:'&,
35755 &'Resent-From:'&, &'Resent-Sender:'&, &'Resent-To:'&, &'Resent-Cc:'&,
35756 &'Resent-Bcc:'& and &'Resent-Message-ID:'&. The RFC says:
35757
35758 .blockquote
35759 &'Resent fields are strictly informational. They MUST NOT be used in the normal
35760 processing of replies or other such automatic actions on messages.'&
35761 .endblockquote
35762
35763 This leaves things a bit vague as far as other processing actions such as
35764 address rewriting are concerned. Exim treats &%Resent-%& header lines as
35765 follows:
35766
35767 .ilist
35768 A &'Resent-From:'& line that just contains the login id of the submitting user
35769 is automatically rewritten in the same way as &'From:'& (see below).
35770 .next
35771 If there's a rewriting rule for a particular header line, it is also applied to
35772 &%Resent-%& header lines of the same type. For example, a rule that rewrites
35773 &'From:'& also rewrites &'Resent-From:'&.
35774 .next
35775 For local messages, if &'Sender:'& is removed on input, &'Resent-Sender:'& is
35776 also removed.
35777 .next
35778 For a locally-submitted message,
35779 if there are any &%Resent-%& header lines but no &'Resent-Date:'&,
35780 &'Resent-From:'&, or &'Resent-Message-Id:'&, they are added as necessary. It is
35781 the contents of &'Resent-Message-Id:'& (rather than &'Message-Id:'&) which are
35782 included in log lines in this case.
35783 .next
35784 The logic for adding &'Sender:'& is duplicated for &'Resent-Sender:'& when any
35785 &%Resent-%& header lines are present.
35786 .endlist
35787
35788
35789
35790
35791 .section "The Auto-Submitted: header line" "SECID221"
35792 Whenever Exim generates an autoreply, a bounce, or a delay warning message, it
35793 includes the header line:
35794 .code
35795 Auto-Submitted: auto-replied
35796 .endd
35797
35798 .section "The Bcc: header line" "SECID222"
35799 .cindex "&'Bcc:'& header line"
35800 If Exim is called with the &%-t%& option, to take recipient addresses from a
35801 message's header, it removes any &'Bcc:'& header line that may exist (after
35802 extracting its addresses). If &%-t%& is not present on the command line, any
35803 existing &'Bcc:'& is not removed.
35804
35805
35806 .section "The Date: header line" "SECID223"
35807 .cindex "&'Date:'& header line"
35808 .cindex "header lines" "Date:"
35809 If a locally-generated or submission-mode message has no &'Date:'& header line,
35810 Exim adds one, using the current date and time, unless the
35811 &%suppress_local_fixups%& control has been specified.
35812
35813 .section "The Delivery-date: header line" "SECID224"
35814 .cindex "&'Delivery-date:'& header line"
35815 .oindex "&%delivery_date_remove%&"
35816 &'Delivery-date:'& header lines are not part of the standard RFC 2822 header
35817 set. Exim can be configured to add them to the final delivery of messages. (See
35818 the generic &%delivery_date_add%& transport option.) They should not be present
35819 in messages in transit. If the &%delivery_date_remove%& configuration option is
35820 set (the default), Exim removes &'Delivery-date:'& header lines from incoming
35821 messages.
35822
35823
35824 .section "The Envelope-to: header line" "SECID225"
35825 .cindex "&'Envelope-to:'& header line"
35826 .cindex "header lines" "Envelope-to:"
35827 .oindex "&%envelope_to_remove%&"
35828 &'Envelope-to:'& header lines are not part of the standard RFC 2822 header set.
35829 Exim can be configured to add them to the final delivery of messages. (See the
35830 generic &%envelope_to_add%& transport option.) They should not be present in
35831 messages in transit. If the &%envelope_to_remove%& configuration option is set
35832 (the default), Exim removes &'Envelope-to:'& header lines from incoming
35833 messages.
35834
35835
35836 .section "The From: header line" "SECTthefrohea"
35837 .cindex "&'From:'& header line"
35838 .cindex "header lines" "From:"
35839 .cindex "Sendmail compatibility" "&""From""& line"
35840 .cindex "message" "submission"
35841 .cindex "submission mode"
35842 If a submission-mode message does not contain a &'From:'& header line, Exim
35843 adds one if either of the following conditions is true:
35844
35845 .ilist
35846 The envelope sender address is not empty (that is, this is not a bounce
35847 message). The added header line copies the envelope sender address.
35848 .next
35849 .vindex "&$authenticated_id$&"
35850 The SMTP session is authenticated and &$authenticated_id$& is not empty.
35851 .olist
35852 .vindex "&$qualify_domain$&"
35853 If no domain is specified by the submission control, the local part is
35854 &$authenticated_id$& and the domain is &$qualify_domain$&.
35855 .next
35856 If a non-empty domain is specified by the submission control, the local
35857 part is &$authenticated_id$&, and the domain is the specified domain.
35858 .next
35859 If an empty domain is specified by the submission control,
35860 &$authenticated_id$& is assumed to be the complete address.
35861 .endlist
35862 .endlist
35863
35864 A non-empty envelope sender takes precedence.
35865
35866 If a locally-generated incoming message does not contain a &'From:'& header
35867 line, and the &%suppress_local_fixups%& control is not set, Exim adds one
35868 containing the sender's address. The calling user's login name and full name
35869 are used to construct the address, as described in section &<<SECTconstr>>&.
35870 They are obtained from the password data by calling &[getpwuid()]& (but see the
35871 &%unknown_login%& configuration option). The address is qualified with
35872 &%qualify_domain%&.
35873
35874 For compatibility with Sendmail, if an incoming, non-SMTP message has a
35875 &'From:'& header line containing just the unqualified login name of the calling
35876 user, this is replaced by an address containing the user's login name and full
35877 name as described in section &<<SECTconstr>>&.
35878
35879
35880 .section "The Message-ID: header line" "SECID226"
35881 .cindex "&'Message-ID:'& header line"
35882 .cindex "header lines" "Message-ID:"
35883 .cindex "message" "submission"
35884 .oindex "&%message_id_header_text%&"
35885 If a locally-generated or submission-mode incoming message does not contain a
35886 &'Message-ID:'& or &'Resent-Message-ID:'& header line, and the
35887 &%suppress_local_fixups%& control is not set, Exim adds a suitable header line
35888 to the message. If there are any &'Resent-:'& headers in the message, it
35889 creates &'Resent-Message-ID:'&. The id is constructed from Exim's internal
35890 message id, preceded by the letter E to ensure it starts with a letter, and
35891 followed by @ and the primary host name. Additional information can be included
35892 in this header line by setting the &%message_id_header_text%& and/or
35893 &%message_id_header_domain%& options.
35894
35895
35896 .section "The Received: header line" "SECID227"
35897 .cindex "&'Received:'& header line"
35898 .cindex "header lines" "Received:"
35899 A &'Received:'& header line is added at the start of every message. The
35900 contents are defined by the &%received_header_text%& configuration option, and
35901 Exim automatically adds a semicolon and a timestamp to the configured string.
35902
35903 The &'Received:'& header is generated as soon as the message's header lines
35904 have been received. At this stage, the timestamp in the &'Received:'& header
35905 line is the time that the message started to be received. This is the value
35906 that is seen by the DATA ACL and by the &[local_scan()]& function.
35907
35908 Once a message is accepted, the timestamp in the &'Received:'& header line is
35909 changed to the time of acceptance, which is (apart from a small delay while the
35910 -H spool file is written) the earliest time at which delivery could start.
35911
35912
35913 .section "The References: header line" "SECID228"
35914 .cindex "&'References:'& header line"
35915 .cindex "header lines" "References:"
35916 Messages created by the &(autoreply)& transport include a &'References:'&
35917 header line. This is constructed according to the rules that are described in
35918 section 3.64 of RFC 2822 (which states that replies should contain such a
35919 header line), and section 3.14 of RFC 3834 (which states that automatic
35920 responses are not different in this respect). However, because some mail
35921 processing software does not cope well with very long header lines, no more
35922 than 12 message IDs are copied from the &'References:'& header line in the
35923 incoming message. If there are more than 12, the first one and then the final
35924 11 are copied, before adding the message ID of the incoming message.
35925
35926
35927
35928 .section "The Return-path: header line" "SECID229"
35929 .cindex "&'Return-path:'& header line"
35930 .cindex "header lines" "Return-path:"
35931 .oindex "&%return_path_remove%&"
35932 &'Return-path:'& header lines are defined as something an MTA may insert when
35933 it does the final delivery of messages. (See the generic &%return_path_add%&
35934 transport option.) Therefore, they should not be present in messages in
35935 transit. If the &%return_path_remove%& configuration option is set (the
35936 default), Exim removes &'Return-path:'& header lines from incoming messages.
35937
35938
35939
35940 .section "The Sender: header line" "SECTthesenhea"
35941 .cindex "&'Sender:'& header line"
35942 .cindex "message" "submission"
35943 .cindex "header lines" "Sender:"
35944 For a locally-originated message from an untrusted user, Exim may remove an
35945 existing &'Sender:'& header line, and it may add a new one. You can modify
35946 these actions by setting the &%local_sender_retain%& option true, the
35947 &%local_from_check%& option false, or by using the &%suppress_local_fixups%&
35948 control setting.
35949
35950 When a local message is received from an untrusted user and
35951 &%local_from_check%& is true (the default), and the &%suppress_local_fixups%&
35952 control has not been set, a check is made to see if the address given in the
35953 &'From:'& header line is the correct (local) sender of the message. The address
35954 that is expected has the login name as the local part and the value of
35955 &%qualify_domain%& as the domain. Prefixes and suffixes for the local part can
35956 be permitted by setting &%local_from_prefix%& and &%local_from_suffix%&
35957 appropriately. If &'From:'& does not contain the correct sender, a &'Sender:'&
35958 line is added to the message.
35959
35960 If you set &%local_from_check%& false, this checking does not occur. However,
35961 the removal of an existing &'Sender:'& line still happens, unless you also set
35962 &%local_sender_retain%& to be true. It is not possible to set both of these
35963 options true at the same time.
35964
35965 .cindex "submission mode"
35966 By default, no processing of &'Sender:'& header lines is done for messages
35967 received over TCP/IP or for messages submitted by trusted users. However, when
35968 a message is received over TCP/IP in submission mode, and &%sender_retain%& is
35969 not specified on the submission control, the following processing takes place:
35970
35971 .vindex "&$authenticated_id$&"
35972 First, any existing &'Sender:'& lines are removed. Then, if the SMTP session is
35973 authenticated, and &$authenticated_id$& is not empty, a sender address is
35974 created as follows:
35975
35976 .ilist
35977 .vindex "&$qualify_domain$&"
35978 If no domain is specified by the submission control, the local part is
35979 &$authenticated_id$& and the domain is &$qualify_domain$&.
35980 .next
35981 If a non-empty domain is specified by the submission control, the local part
35982 is &$authenticated_id$&, and the domain is the specified domain.
35983 .next
35984 If an empty domain is specified by the submission control,
35985 &$authenticated_id$& is assumed to be the complete address.
35986 .endlist
35987
35988 This address is compared with the address in the &'From:'& header line. If they
35989 are different, a &'Sender:'& header line containing the created address is
35990 added. Prefixes and suffixes for the local part in &'From:'& can be permitted
35991 by setting &%local_from_prefix%& and &%local_from_suffix%& appropriately.
35992
35993 .cindex "return path" "created from &'Sender:'&"
35994 &*Note*&: Whenever a &'Sender:'& header line is created, the return path for
35995 the message (the envelope sender address) is changed to be the same address,
35996 except in the case of submission mode when &%sender_retain%& is specified.
35997
35998
35999
36000 .section "Adding and removing header lines in routers and transports" &&&
36001          "SECTheadersaddrem"
36002 .cindex "header lines" "adding; in router or transport"
36003 .cindex "header lines" "removing; in router or transport"
36004 When a message is delivered, the addition and removal of header lines can be
36005 specified in a system filter, or on any of the routers and transports that
36006 process the message. Section &<<SECTaddremheasys>>& contains details about
36007 modifying headers in a system filter. Header lines can also be added in an ACL
36008 as a message is received (see section &<<SECTaddheadacl>>&).
36009
36010 In contrast to what happens in a system filter, header modifications that are
36011 specified on routers and transports apply only to the particular recipient
36012 addresses that are being processed by those routers and transports. These
36013 changes do not actually take place until a copy of the message is being
36014 transported. Therefore, they do not affect the basic set of header lines, and
36015 they do not affect the values of the variables that refer to header lines.
36016
36017 &*Note*&: In particular, this means that any expansions in the configuration of
36018 the transport cannot refer to the modified header lines, because such
36019 expansions all occur before the message is actually transported.
36020
36021 For both routers and transports, the argument of a &%headers_add%&
36022 option must be in the form of one or more RFC 2822 header lines, separated by
36023 newlines (coded as &"\n"&). For example:
36024 .code
36025 headers_add = X-added-header: added by $primary_hostname\n\
36026               X-added-second: another added header line
36027 .endd
36028 Exim does not check the syntax of these added header lines.
36029
36030 Multiple &%headers_add%& options for a single router or transport can be
36031 specified; the values will append to a single list of header lines.
36032 Each header-line is separately expanded.
36033
36034 The argument of a &%headers_remove%& option must consist of a colon-separated
36035 list of header names. This is confusing, because header names themselves are
36036 often terminated by colons. In this case, the colons are the list separators,
36037 not part of the names. For example:
36038 .code
36039 headers_remove = return-receipt-to:acknowledge-to
36040 .endd
36041
36042 Multiple &%headers_remove%& options for a single router or transport can be
36043 specified; the arguments will append to a single header-names list.
36044 Each item is separately expanded.
36045 Note that colons in complex expansions which are used to
36046 form all or part of a &%headers_remove%& list
36047 will act as list separators.
36048
36049 When &%headers_add%& or &%headers_remove%& is specified on a router,
36050 items are expanded at routing time,
36051 and then associated with all addresses that are
36052 accepted by that router, and also with any new addresses that it generates. If
36053 an address passes through several routers as a result of aliasing or
36054 forwarding, the changes are cumulative.
36055
36056 .oindex "&%unseen%&"
36057 However, this does not apply to multiple routers that result from the use of
36058 the &%unseen%& option. Any header modifications that were specified by the
36059 &"unseen"& router or its predecessors apply only to the &"unseen"& delivery.
36060
36061 Addresses that end up with different &%headers_add%& or &%headers_remove%&
36062 settings cannot be delivered together in a batch, so a transport is always
36063 dealing with a set of addresses that have the same header-processing
36064 requirements.
36065
36066 The transport starts by writing the original set of header lines that arrived
36067 with the message, possibly modified by the system filter. As it writes out
36068 these lines, it consults the list of header names that were attached to the
36069 recipient address(es) by &%headers_remove%& options in routers, and it also
36070 consults the transport's own &%headers_remove%& option. Header lines whose
36071 names are on either of these lists are not written out. If there are multiple
36072 instances of any listed header, they are all skipped.
36073
36074 After the remaining original header lines have been written, new header
36075 lines that were specified by routers' &%headers_add%& options are written, in
36076 the order in which they were attached to the address. These are followed by any
36077 header lines specified by the transport's &%headers_add%& option.
36078
36079 This way of handling header line modifications in routers and transports has
36080 the following consequences:
36081
36082 .ilist
36083 The original set of header lines, possibly modified by the system filter,
36084 remains &"visible"&, in the sense that the &$header_$&&'xxx'& variables refer
36085 to it, at all times.
36086 .next
36087 Header lines that are added by a router's
36088 &%headers_add%& option are not accessible by means of the &$header_$&&'xxx'&
36089 expansion syntax in subsequent routers or the transport.
36090 .next
36091 Conversely, header lines that are specified for removal by &%headers_remove%&
36092 in a router remain visible to subsequent routers and the transport.
36093 .next
36094 Headers added to an address by &%headers_add%& in a router cannot be removed by
36095 a later router or by a transport.
36096 .next
36097 An added header can refer to the contents of an original header that is to be
36098 removed, even it has the same name as the added header. For example:
36099 .code
36100 headers_remove = subject
36101 headers_add = Subject: new subject (was: $h_subject:)
36102 .endd
36103 .endlist
36104
36105 &*Warning*&: The &%headers_add%& and &%headers_remove%& options cannot be used
36106 for a &(redirect)& router that has the &%one_time%& option set.
36107
36108
36109
36110
36111
36112 .section "Constructed addresses" "SECTconstr"
36113 .cindex "address" "constructed"
36114 .cindex "constructed address"
36115 When Exim constructs a sender address for a locally-generated message, it uses
36116 the form
36117 .display
36118 <&'user name'&>&~&~<&'login'&&`@`&&'qualify_domain'&>
36119 .endd
36120 For example:
36121 .code
36122 Zaphod Beeblebrox <zaphod@end.univ.example>
36123 .endd
36124 The user name is obtained from the &%-F%& command line option if set, or
36125 otherwise by looking up the calling user by &[getpwuid()]& and extracting the
36126 &"gecos"& field from the password entry. If the &"gecos"& field contains an
36127 ampersand character, this is replaced by the login name with the first letter
36128 upper cased, as is conventional in a number of operating systems. See the
36129 &%gecos_name%& option for a way to tailor the handling of the &"gecos"& field.
36130 The &%unknown_username%& option can be used to specify user names in cases when
36131 there is no password file entry.
36132
36133 .cindex "RFC 2047"
36134 In all cases, the user name is made to conform to RFC 2822 by quoting all or
36135 parts of it if necessary. In addition, if it contains any non-printing
36136 characters, it is encoded as described in RFC 2047, which defines a way of
36137 including non-ASCII characters in header lines. The value of the
36138 &%headers_charset%& option specifies the name of the encoding that is used (the
36139 characters are assumed to be in this encoding). The setting of
36140 &%print_topbitchars%& controls whether characters with the top bit set (that
36141 is, with codes greater than 127) count as printing characters or not.
36142
36143
36144
36145 .section "Case of local parts" "SECID230"
36146 .cindex "case of local parts"
36147 .cindex "local part" "case of"
36148 RFC 2822 states that the case of letters in the local parts of addresses cannot
36149 be assumed to be non-significant. Exim preserves the case of local parts of
36150 addresses, but by default it uses a lower-cased form when it is routing,
36151 because on most Unix systems, usernames are in lower case and case-insensitive
36152 routing is required. However, any particular router can be made to use the
36153 original case for local parts by setting the &%caseful_local_part%& generic
36154 router option.
36155
36156 .cindex "mixed-case login names"
36157 If you must have mixed-case user names on your system, the best way to proceed,
36158 assuming you want case-independent handling of incoming email, is to set up
36159 your first router to convert incoming local parts in your domains to the
36160 correct case by means of a file lookup. For example:
36161 .code
36162 correct_case:
36163   driver = redirect
36164   domains = +local_domains
36165   data = ${lookup{$local_part}cdb\
36166               {/etc/usercased.cdb}{$value}fail}\
36167               @$domain
36168 .endd
36169 For this router, the local part is forced to lower case by the default action
36170 (&%caseful_local_part%& is not set). The lower-cased local part is used to look
36171 up a new local part in the correct case. If you then set &%caseful_local_part%&
36172 on any subsequent routers which process your domains, they will operate on
36173 local parts with the correct case in a case-sensitive manner.
36174
36175
36176
36177 .section "Dots in local parts" "SECID231"
36178 .cindex "dot" "in local part"
36179 .cindex "local part" "dots in"
36180 RFC 2822 forbids empty components in local parts. That is, an unquoted local
36181 part may not begin or end with a dot, nor have two consecutive dots in the
36182 middle. However, it seems that many MTAs do not enforce this, so Exim permits
36183 empty components for compatibility.
36184
36185
36186
36187 .section "Rewriting addresses" "SECID232"
36188 .cindex "rewriting" "addresses"
36189 Rewriting of sender and recipient addresses, and addresses in headers, can
36190 happen automatically, or as the result of configuration options, as described
36191 in chapter &<<CHAPrewrite>>&. The headers that may be affected by this are
36192 &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-To:'&, &'Sender:'&, and &'To:'&.
36193
36194 Automatic rewriting includes qualification, as mentioned above. The other case
36195 in which it can happen is when an incomplete non-local domain is given. The
36196 routing process may cause this to be expanded into the full domain name. For
36197 example, a header such as
36198 .code
36199 To: hare@teaparty
36200 .endd
36201 might get rewritten as
36202 .code
36203 To: hare@teaparty.wonderland.fict.example
36204 .endd
36205 Rewriting as a result of routing is the one kind of message processing that
36206 does not happen at input time, as it cannot be done until the address has
36207 been routed.
36208
36209 Strictly, one should not do &'any'& deliveries of a message until all its
36210 addresses have been routed, in case any of the headers get changed as a
36211 result of routing. However, doing this in practice would hold up many
36212 deliveries for unreasonable amounts of time, just because one address could not
36213 immediately be routed. Exim therefore does not delay other deliveries when
36214 routing of one or more addresses is deferred.
36215 .ecindex IIDmesproc
36216
36217
36218
36219 . ////////////////////////////////////////////////////////////////////////////
36220 . ////////////////////////////////////////////////////////////////////////////
36221
36222 .chapter "SMTP processing" "CHAPSMTP"
36223 .scindex IIDsmtpproc1 "SMTP" "processing details"
36224 .scindex IIDsmtpproc2 "LMTP" "processing details"
36225 Exim supports a number of different ways of using the SMTP protocol, and its
36226 LMTP variant, which is an interactive protocol for transferring messages into a
36227 closed mail store application. This chapter contains details of how SMTP is
36228 processed. For incoming mail, the following are available:
36229
36230 .ilist
36231 SMTP over TCP/IP (Exim daemon or &'inetd'&);
36232 .next
36233 SMTP over the standard input and output (the &%-bs%& option);
36234 .next
36235 Batched SMTP on the standard input (the &%-bS%& option).
36236 .endlist
36237
36238 For mail delivery, the following are available:
36239
36240 .ilist
36241 SMTP over TCP/IP (the &(smtp)& transport);
36242 .next
36243 LMTP over TCP/IP (the &(smtp)& transport with the &%protocol%& option set to
36244 &"lmtp"&);
36245 .next
36246 LMTP over a pipe to a process running in the local host (the &(lmtp)&
36247 transport);
36248 .next
36249 Batched SMTP to a file or pipe (the &(appendfile)& and &(pipe)& transports with
36250 the &%use_bsmtp%& option set).
36251 .endlist
36252
36253 &'Batched SMTP'& is the name for a process in which batches of messages are
36254 stored in or read from files (or pipes), in a format in which SMTP commands are
36255 used to contain the envelope information.
36256
36257
36258
36259 .section "Outgoing SMTP and LMTP over TCP/IP" "SECToutSMTPTCP"
36260 .cindex "SMTP" "outgoing over TCP/IP"
36261 .cindex "outgoing SMTP over TCP/IP"
36262 .cindex "LMTP" "over TCP/IP"
36263 .cindex "outgoing LMTP over TCP/IP"
36264 .cindex "EHLO"
36265 .cindex "HELO"
36266 .cindex "SIZE" "option on MAIL command"
36267 Outgoing SMTP and LMTP over TCP/IP is implemented by the &(smtp)& transport.
36268 The &%protocol%& option selects which protocol is to be used, but the actual
36269 processing is the same in both cases.
36270
36271 .cindex "ESMTP extensions" SIZE
36272 If, in response to its EHLO command, Exim is told that the SIZE
36273 extension is supported, it adds SIZE=<&'n'&> to each subsequent MAIL
36274 command. The value of <&'n'&> is the message size plus the value of the
36275 &%size_addition%& option (default 1024) to allow for additions to the message
36276 such as per-transport header lines, or changes made in a
36277 .cindex "transport" "filter"
36278 .cindex "filter" "transport filter"
36279 transport filter. If &%size_addition%& is set negative, the use of SIZE is
36280 suppressed.
36281
36282 If the remote server advertises support for PIPELINING, Exim uses the
36283 pipelining extension to SMTP (RFC 2197) to reduce the number of TCP/IP packets
36284 required for the transaction.
36285
36286 If the remote server advertises support for the STARTTLS command, and Exim
36287 was built to support TLS encryption, it tries to start a TLS session unless the
36288 server matches &%hosts_avoid_tls%&. See chapter &<<CHAPTLS>>& for more details.
36289 Either a match in that or &%hosts_verify_avoid_tls%& apply when the transport
36290 is called for verification.
36291
36292 If the remote server advertises support for the AUTH command, Exim scans
36293 the authenticators configuration for any suitable client settings, as described
36294 in chapter &<<CHAPSMTPAUTH>>&.
36295
36296 .cindex "carriage return"
36297 .cindex "linefeed"
36298 Responses from the remote host are supposed to be terminated by CR followed by
36299 LF. However, there are known to be hosts that do not send CR characters, so in
36300 order to be able to interwork with such hosts, Exim treats LF on its own as a
36301 line terminator.
36302
36303 If a message contains a number of different addresses, all those with the same
36304 characteristics (for example, the same envelope sender) that resolve to the
36305 same set of hosts, in the same order, are sent in a single SMTP transaction,
36306 even if they are for different domains, unless there are more than the setting
36307 of the &%max_rcpt%&s option in the &(smtp)& transport allows, in which case
36308 they are split into groups containing no more than &%max_rcpt%&s addresses
36309 each. If &%remote_max_parallel%& is greater than one, such groups may be sent
36310 in parallel sessions. The order of hosts with identical MX values is not
36311 significant when checking whether addresses can be batched in this way.
36312
36313 When the &(smtp)& transport suffers a temporary failure that is not
36314 message-related, Exim updates its transport-specific database, which contains
36315 records indexed by host name that remember which messages are waiting for each
36316 particular host. It also updates the retry database with new retry times.
36317
36318 .cindex "hints database" "retry keys"
36319 Exim's retry hints are based on host name plus IP address, so if one address of
36320 a multi-homed host is broken, it will soon be skipped most of the time.
36321 See the next section for more detail about error handling.
36322
36323 .cindex "SMTP" "passed connection"
36324 .cindex "SMTP" "batching over TCP/IP"
36325 When a message is successfully delivered over a TCP/IP SMTP connection, Exim
36326 looks in the hints database for the transport to see if there are any queued
36327 messages waiting for the host to which it is connected. If it finds one, it
36328 creates a new Exim process using the &%-MC%& option (which can only be used by
36329 a process running as root or the Exim user) and passes the TCP/IP socket to it
36330 so that it can deliver another message using the same socket. The new process
36331 does only those deliveries that are routed to the connected host, and may in
36332 turn pass the socket on to a third process, and so on.
36333
36334 The &%connection_max_messages%& option of the &(smtp)& transport can be used to
36335 limit the number of messages sent down a single TCP/IP connection.
36336
36337 .cindex "asterisk" "after IP address"
36338 The second and subsequent messages delivered down an existing connection are
36339 identified in the main log by the addition of an asterisk after the closing
36340 square bracket of the IP address.
36341
36342
36343
36344
36345 .section "Errors in outgoing SMTP" "SECToutSMTPerr"
36346 .cindex "error" "in outgoing SMTP"
36347 .cindex "SMTP" "errors in outgoing"
36348 .cindex "host" "error"
36349 Three different kinds of error are recognized for outgoing SMTP: host errors,
36350 message errors, and recipient errors.
36351
36352 .vlist
36353 .vitem "&*Host errors*&"
36354 A host error is not associated with a particular message or with a
36355 particular recipient of a message. The host errors are:
36356
36357 .ilist
36358 Connection refused or timed out,
36359 .next
36360 Any error response code on connection,
36361 .next
36362 Any error response code to EHLO or HELO,
36363 .next
36364 Loss of connection at any time, except after &"."&,
36365 .next
36366 I/O errors at any time,
36367 .next
36368 Timeouts during the session, other than in response to MAIL, RCPT or
36369 the &"."& at the end of the data.
36370 .endlist ilist
36371
36372 For a host error, a permanent error response on connection, or in response to
36373 EHLO, causes all addresses routed to the host to be failed. Any other host
36374 error causes all addresses to be deferred, and retry data to be created for the
36375 host. It is not tried again, for any message, until its retry time arrives. If
36376 the current set of addresses are not all delivered in this run (to some
36377 alternative host), the message is added to the list of those waiting for this
36378 host, so if it is still undelivered when a subsequent successful delivery is
36379 made to the host, it will be sent down the same SMTP connection.
36380
36381 .vitem "&*Message errors*&"
36382 .cindex "message" "error"
36383 A message error is associated with a particular message when sent to a
36384 particular host, but not with a particular recipient of the message. The
36385 message errors are:
36386
36387 .ilist
36388 Any error response code to MAIL, DATA, or the &"."& that terminates
36389 the data,
36390 .next
36391 Timeout after MAIL,
36392 .next
36393 Timeout or loss of connection after the &"."& that terminates the data. A
36394 timeout after the DATA command itself is treated as a host error, as is loss of
36395 connection at any other time.
36396 .endlist ilist
36397
36398 For a message error, a permanent error response (5&'xx'&) causes all addresses
36399 to be failed, and a delivery error report to be returned to the sender. A
36400 temporary error response (4&'xx'&), or one of the timeouts, causes all
36401 addresses to be deferred. Retry data is not created for the host, but instead,
36402 a retry record for the combination of host plus message id is created. The
36403 message is not added to the list of those waiting for this host. This ensures
36404 that the failing message will not be sent to this host again until the retry
36405 time arrives. However, other messages that are routed to the host are not
36406 affected, so if it is some property of the message that is causing the error,
36407 it will not stop the delivery of other mail.
36408
36409 If the remote host specified support for the SIZE parameter in its response
36410 to EHLO, Exim adds SIZE=&'nnn'& to the MAIL command, so an
36411 over-large message will cause a message error because the error arrives as a
36412 response to MAIL.
36413
36414 .vitem "&*Recipient errors*&"
36415 .cindex "recipient" "error"
36416 A recipient error is associated with a particular recipient of a message. The
36417 recipient errors are:
36418
36419 .ilist
36420 Any error response to RCPT,
36421 .next
36422 Timeout after RCPT.
36423 .endlist
36424
36425 For a recipient error, a permanent error response (5&'xx'&) causes the
36426 recipient address to be failed, and a bounce message to be returned to the
36427 sender. A temporary error response (4&'xx'&) or a timeout causes the failing
36428 address to be deferred, and routing retry data to be created for it. This is
36429 used to delay processing of the address in subsequent queue runs, until its
36430 routing retry time arrives. This applies to all messages, but because it
36431 operates only in queue runs, one attempt will be made to deliver a new message
36432 to the failing address before the delay starts to operate. This ensures that,
36433 if the failure is really related to the message rather than the recipient
36434 (&"message too big for this recipient"& is a possible example), other messages
36435 have a chance of getting delivered. If a delivery to the address does succeed,
36436 the retry information gets cleared, so all stuck messages get tried again, and
36437 the retry clock is reset.
36438
36439 The message is not added to the list of those waiting for this host. Use of the
36440 host for other messages is unaffected, and except in the case of a timeout,
36441 other recipients are processed independently, and may be successfully delivered
36442 in the current SMTP session. After a timeout it is of course impossible to
36443 proceed with the session, so all addresses get deferred. However, those other
36444 than the one that failed do not suffer any subsequent retry delays. Therefore,
36445 if one recipient is causing trouble, the others have a chance of getting
36446 through when a subsequent delivery attempt occurs before the failing
36447 recipient's retry time.
36448 .endlist
36449
36450 In all cases, if there are other hosts (or IP addresses) available for the
36451 current set of addresses (for example, from multiple MX records), they are
36452 tried in this run for any undelivered addresses, subject of course to their
36453 own retry data. In other words, recipient error retry data does not take effect
36454 until the next delivery attempt.
36455
36456 Some hosts have been observed to give temporary error responses to every
36457 MAIL command at certain times (&"insufficient space"& has been seen). It
36458 would be nice if such circumstances could be recognized, and defer data for the
36459 host itself created, but this is not possible within the current Exim design.
36460 What actually happens is that retry data for every (host, message) combination
36461 is created.
36462
36463 The reason that timeouts after MAIL and RCPT are treated specially is that
36464 these can sometimes arise as a result of the remote host's verification
36465 procedures. Exim makes this assumption, and treats them as if a temporary error
36466 response had been received. A timeout after &"."& is treated specially because
36467 it is known that some broken implementations fail to recognize the end of the
36468 message if the last character of the last line is a binary zero. Thus, it is
36469 helpful to treat this case as a message error.
36470
36471 Timeouts at other times are treated as host errors, assuming a problem with the
36472 host, or the connection to it. If a timeout after MAIL, RCPT,
36473 or &"."& is really a connection problem, the assumption is that at the next try
36474 the timeout is likely to occur at some other point in the dialogue, causing it
36475 then to be treated as a host error.
36476
36477 There is experimental evidence that some MTAs drop the connection after the
36478 terminating &"."& if they do not like the contents of the message for some
36479 reason, in contravention of the RFC, which indicates that a 5&'xx'& response
36480 should be given. That is why Exim treats this case as a message rather than a
36481 host error, in order not to delay other messages to the same host.
36482
36483
36484
36485
36486 .section "Incoming SMTP messages over TCP/IP" "SECID233"
36487 .cindex "SMTP" "incoming over TCP/IP"
36488 .cindex "incoming SMTP over TCP/IP"
36489 .cindex "inetd"
36490 .cindex "daemon"
36491 Incoming SMTP messages can be accepted in one of two ways: by running a
36492 listening daemon, or by using &'inetd'&. In the latter case, the entry in
36493 &_/etc/inetd.conf_& should be like this:
36494 .code
36495 smtp stream tcp nowait exim /opt/exim/bin/exim in.exim -bs
36496 .endd
36497 Exim distinguishes between this case and the case of a locally running user
36498 agent using the &%-bs%& option by checking whether or not the standard input is
36499 a socket. When it is, either the port must be privileged (less than 1024), or
36500 the caller must be root or the Exim user. If any other user passes a socket
36501 with an unprivileged port number, Exim prints a message on the standard error
36502 stream and exits with an error code.
36503
36504 By default, Exim does not make a log entry when a remote host connects or
36505 disconnects (either via the daemon or &'inetd'&), unless the disconnection is
36506 unexpected. It can be made to write such log entries by setting the
36507 &%smtp_connection%& log selector.
36508
36509 .cindex "carriage return"
36510 .cindex "linefeed"
36511 Commands from the remote host are supposed to be terminated by CR followed by
36512 LF. However, there are known to be hosts that do not send CR characters. In
36513 order to be able to interwork with such hosts, Exim treats LF on its own as a
36514 line terminator.
36515 Furthermore, because common code is used for receiving messages from all
36516 sources, a CR on its own is also interpreted as a line terminator. However, the
36517 sequence &"CR, dot, CR"& does not terminate incoming SMTP data.
36518
36519 .cindex "EHLO" "invalid data"
36520 .cindex "HELO" "invalid data"
36521 One area that sometimes gives rise to problems concerns the EHLO or
36522 HELO commands. Some clients send syntactically invalid versions of these
36523 commands, which Exim rejects by default. (This is nothing to do with verifying
36524 the data that is sent, so &%helo_verify_hosts%& is not relevant.) You can tell
36525 Exim not to apply a syntax check by setting &%helo_accept_junk_hosts%& to
36526 match the broken hosts that send invalid commands.
36527
36528 .cindex "SIZE option on MAIL command"
36529 .cindex "MAIL" "SIZE option"
36530 The amount of disk space available is checked whenever SIZE is received on
36531 a MAIL command, independently of whether &%message_size_limit%& or
36532 &%check_spool_space%& is configured, unless &%smtp_check_spool_space%& is set
36533 false. A temporary error is given if there is not enough space. If
36534 &%check_spool_space%& is set, the check is for that amount of space plus the
36535 value given with SIZE, that is, it checks that the addition of the incoming
36536 message will not reduce the space below the threshold.
36537
36538 When a message is successfully received, Exim includes the local message id in
36539 its response to the final &"."& that terminates the data. If the remote host
36540 logs this text it can help with tracing what has happened to a message.
36541
36542 The Exim daemon can limit the number of simultaneous incoming connections it is
36543 prepared to handle (see the &%smtp_accept_max%& option). It can also limit the
36544 number of simultaneous incoming connections from a single remote host (see the
36545 &%smtp_accept_max_per_host%& option). Additional connection attempts are
36546 rejected using the SMTP temporary error code 421.
36547
36548 The Exim daemon does not rely on the SIGCHLD signal to detect when a
36549 subprocess has finished, as this can get lost at busy times. Instead, it looks
36550 for completed subprocesses every time it wakes up. Provided there are other
36551 things happening (new incoming calls, starts of queue runs), completed
36552 processes will be noticed and tidied away. On very quiet systems you may
36553 sometimes see a &"defunct"& Exim process hanging about. This is not a problem;
36554 it will be noticed when the daemon next wakes up.
36555
36556 When running as a daemon, Exim can reserve some SMTP slots for specific hosts,
36557 and can also be set up to reject SMTP calls from non-reserved hosts at times of
36558 high system load &-- for details see the &%smtp_accept_reserve%&,
36559 &%smtp_load_reserve%&, and &%smtp_reserve_hosts%& options. The load check
36560 applies in both the daemon and &'inetd'& cases.
36561
36562 Exim normally starts a delivery process for each message received, though this
36563 can be varied by means of the &%-odq%& command line option and the
36564 &%queue_only%&, &%queue_only_file%&, and &%queue_only_load%& options. The
36565 number of simultaneously running delivery processes started in this way from
36566 SMTP input can be limited by the &%smtp_accept_queue%& and
36567 &%smtp_accept_queue_per_connection%& options. When either limit is reached,
36568 subsequently received messages are just put on the input queue without starting
36569 a delivery process.
36570
36571 The controls that involve counts of incoming SMTP calls (&%smtp_accept_max%&,
36572 &%smtp_accept_queue%&, &%smtp_accept_reserve%&) are not available when Exim is
36573 started up from the &'inetd'& daemon, because in that case each connection is
36574 handled by an entirely independent Exim process. Control by load average is,
36575 however, available with &'inetd'&.
36576
36577 Exim can be configured to verify addresses in incoming SMTP commands as they
36578 are received. See chapter &<<CHAPACL>>& for details. It can also be configured
36579 to rewrite addresses at this time &-- before any syntax checking is done. See
36580 section &<<SECTrewriteS>>&.
36581
36582 Exim can also be configured to limit the rate at which a client host submits
36583 MAIL and RCPT commands in a single SMTP session. See the
36584 &%smtp_ratelimit_hosts%& option.
36585
36586
36587
36588 .section "Unrecognized SMTP commands" "SECID234"
36589 .cindex "SMTP" "unrecognized commands"
36590 If Exim receives more than &%smtp_max_unknown_commands%& unrecognized SMTP
36591 commands during a single SMTP connection, it drops the connection after sending
36592 the error response to the last command. The default value for
36593 &%smtp_max_unknown_commands%& is 3. This is a defence against some kinds of
36594 abuse that subvert web servers into making connections to SMTP ports; in these
36595 circumstances, a number of non-SMTP lines are sent first.
36596
36597
36598 .section "Syntax and protocol errors in SMTP commands" "SECID235"
36599 .cindex "SMTP" "syntax errors"
36600 .cindex "SMTP" "protocol errors"
36601 A syntax error is detected if an SMTP command is recognized, but there is
36602 something syntactically wrong with its data, for example, a malformed email
36603 address in a RCPT command. Protocol errors include invalid command
36604 sequencing such as RCPT before MAIL. If Exim receives more than
36605 &%smtp_max_synprot_errors%& such commands during a single SMTP connection, it
36606 drops the connection after sending the error response to the last command. The
36607 default value for &%smtp_max_synprot_errors%& is 3. This is a defence against
36608 broken clients that loop sending bad commands (yes, it has been seen).
36609
36610
36611
36612 .section "Use of non-mail SMTP commands" "SECID236"
36613 .cindex "SMTP" "non-mail commands"
36614 The &"non-mail"& SMTP commands are those other than MAIL, RCPT, and
36615 DATA. Exim counts such commands, and drops the connection if there are too
36616 many of them in a single SMTP session. This action catches some
36617 denial-of-service attempts and things like repeated failing AUTHs, or a mad
36618 client looping sending EHLO. The global option &%smtp_accept_max_nonmail%&
36619 defines what &"too many"& means. Its default value is 10.
36620
36621 When a new message is expected, one occurrence of RSET is not counted. This
36622 allows a client to send one RSET between messages (this is not necessary,
36623 but some clients do it). Exim also allows one uncounted occurrence of HELO
36624 or EHLO, and one occurrence of STARTTLS between messages. After
36625 starting up a TLS session, another EHLO is expected, and so it too is not
36626 counted.
36627
36628 The first occurrence of AUTH in a connection, or immediately following
36629 STARTTLS is also not counted. Otherwise, all commands other than MAIL,
36630 RCPT, DATA, and QUIT are counted.
36631
36632 You can control which hosts are subject to the limit set by
36633 &%smtp_accept_max_nonmail%& by setting
36634 &%smtp_accept_max_nonmail_hosts%&. The default value is &`*`&, which makes
36635 the limit apply to all hosts. This option means that you can exclude any
36636 specific badly-behaved hosts that you have to live with.
36637
36638
36639
36640
36641 .section "The VRFY and EXPN commands" "SECID237"
36642 When Exim receives a VRFY or EXPN command on a TCP/IP connection, it
36643 runs the ACL specified by &%acl_smtp_vrfy%& or &%acl_smtp_expn%& (as
36644 appropriate) in order to decide whether the command should be accepted or not.
36645
36646 .cindex "VRFY" "processing"
36647 When no ACL is defined for VRFY, or if it rejects without
36648 setting an explicit response code, the command is accepted
36649 (with a 252 SMTP response code)
36650 in order to support awkward clients that do a VRFY before every RCPT.
36651 When VRFY is accepted, it runs exactly the same code as when Exim is
36652 called with the &%-bv%& option, and returns 250/451/550
36653 SMTP response codes.
36654
36655 .cindex "EXPN" "processing"
36656 If no ACL for EXPN is defined, the command is rejected.
36657 When EXPN is accepted, a single-level expansion of the address is done.
36658 EXPN is treated as an &"address test"& (similar to the &%-bt%& option) rather
36659 than a verification (the &%-bv%& option). If an unqualified local part is given
36660 as the argument to EXPN, it is qualified with &%qualify_domain%&. Rejections
36661 of VRFY and EXPN commands are logged on the main and reject logs, and
36662 VRFY verification failures are logged on the main log for consistency with
36663 RCPT failures.
36664
36665
36666
36667 .section "The ETRN command" "SECTETRN"
36668 .cindex "ETRN" "processing"
36669 .cindex "ESMTP extensions" ETRN
36670 RFC 1985 describes an ESMTP command called ETRN that is designed to
36671 overcome the security problems of the TURN command (which has fallen into
36672 disuse). When Exim receives an ETRN command on a TCP/IP connection, it runs
36673 the ACL specified by &%acl_smtp_etrn%& in order to decide whether the command
36674 should be accepted or not. If no ACL is defined, the command is rejected.
36675
36676 The ETRN command is concerned with &"releasing"& messages that are awaiting
36677 delivery to certain hosts. As Exim does not organize its message queue by host,
36678 the only form of ETRN that is supported by default is the one where the
36679 text starts with the &"#"& prefix, in which case the remainder of the text is
36680 specific to the SMTP server. A valid ETRN command causes a run of Exim with
36681 the &%-R%& option to happen, with the remainder of the ETRN text as its
36682 argument. For example,
36683 .code
36684 ETRN #brigadoon
36685 .endd
36686 runs the command
36687 .code
36688 exim -R brigadoon
36689 .endd
36690 which causes a delivery attempt on all messages with undelivered addresses
36691 containing the text &"brigadoon"&. When &%smtp_etrn_serialize%& is set (the
36692 default), Exim prevents the simultaneous execution of more than one queue run
36693 for the same argument string as a result of an ETRN command. This stops
36694 a misbehaving client from starting more than one queue runner at once.
36695
36696 .cindex "hints database" "ETRN serialization"
36697 Exim implements the serialization by means of a hints database in which a
36698 record is written whenever a process is started by ETRN, and deleted when
36699 the process completes. However, Exim does not keep the SMTP session waiting for
36700 the ETRN process to complete. Once ETRN is accepted, the client is sent
36701 a &"success"& return code. Obviously there is scope for hints records to get
36702 left lying around if there is a system or program crash. To guard against this,
36703 Exim ignores any records that are more than six hours old.
36704
36705 .oindex "&%smtp_etrn_command%&"
36706 For more control over what ETRN does, the &%smtp_etrn_command%& option can
36707 used. This specifies a command that is run whenever ETRN is received,
36708 whatever the form of its argument. For
36709 example:
36710 .code
36711 smtp_etrn_command = /etc/etrn_command $domain \
36712                     $sender_host_address
36713 .endd
36714 .vindex "&$domain$&"
36715 The string is split up into arguments which are independently expanded. The
36716 expansion variable &$domain$& is set to the argument of the ETRN command,
36717 and no syntax checking is done on the contents of this argument. Exim does not
36718 wait for the command to complete, so its status code is not checked. Exim runs
36719 under its own uid and gid when receiving incoming SMTP, so it is not possible
36720 for it to change them before running the command.
36721
36722
36723
36724 .section "Incoming local SMTP" "SECID238"
36725 .cindex "SMTP" "local incoming"
36726 Some user agents use SMTP to pass messages to their local MTA using the
36727 standard input and output, as opposed to passing the envelope on the command
36728 line and writing the message to the standard input. This is supported by the
36729 &%-bs%& option. This form of SMTP is handled in the same way as incoming
36730 messages over TCP/IP (including the use of ACLs), except that the envelope
36731 sender given in a MAIL command is ignored unless the caller is trusted. In
36732 an ACL you can detect this form of SMTP input by testing for an empty host
36733 identification. It is common to have this as the first line in the ACL that
36734 runs for RCPT commands:
36735 .code
36736 accept hosts = :
36737 .endd
36738 This accepts SMTP messages from local processes without doing any other tests.
36739
36740
36741
36742 .section "Outgoing batched SMTP" "SECTbatchSMTP"
36743 .cindex "SMTP" "batched outgoing"
36744 .cindex "batched SMTP output"
36745 Both the &(appendfile)& and &(pipe)& transports can be used for handling
36746 batched SMTP. Each has an option called &%use_bsmtp%& which causes messages to
36747 be output in BSMTP format. No SMTP responses are possible for this form of
36748 delivery. All it is doing is using SMTP commands as a way of transmitting the
36749 envelope along with the message.
36750
36751 The message is written to the file or pipe preceded by the SMTP commands
36752 MAIL and RCPT, and followed by a line containing a single dot. Lines in
36753 the message that start with a dot have an extra dot added. The SMTP command
36754 HELO is not normally used. If it is required, the &%message_prefix%& option
36755 can be used to specify it.
36756
36757 Because &(appendfile)& and &(pipe)& are both local transports, they accept only
36758 one recipient address at a time by default. However, you can arrange for them
36759 to handle several addresses at once by setting the &%batch_max%& option. When
36760 this is done for BSMTP, messages may contain multiple RCPT commands. See
36761 chapter &<<CHAPbatching>>& for more details.
36762
36763 .vindex "&$host$&"
36764 When one or more addresses are routed to a BSMTP transport by a router that
36765 sets up a host list, the name of the first host on the list is available to the
36766 transport in the variable &$host$&. Here is an example of such a transport and
36767 router:
36768 .code
36769 begin routers
36770 route_append:
36771   driver = manualroute
36772   transport = smtp_appendfile
36773   route_list = domain.example  batch.host.example
36774
36775 begin transports
36776 smtp_appendfile:
36777   driver = appendfile
36778   directory = /var/bsmtp/$host
36779   batch_max = 1000
36780   use_bsmtp
36781   user = exim
36782 .endd
36783 This causes messages addressed to &'domain.example'& to be written in BSMTP
36784 format to &_/var/bsmtp/batch.host.example_&, with only a single copy of each
36785 message (unless there are more than 1000 recipients).
36786
36787
36788
36789 .section "Incoming batched SMTP" "SECTincomingbatchedSMTP"
36790 .cindex "SMTP" "batched incoming"
36791 .cindex "batched SMTP input"
36792 The &%-bS%& command line option causes Exim to accept one or more messages by
36793 reading SMTP on the standard input, but to generate no responses. If the caller
36794 is trusted, the senders in the MAIL commands are believed; otherwise the
36795 sender is always the caller of Exim. Unqualified senders and receivers are not
36796 rejected (there seems little point) but instead just get qualified. HELO
36797 and EHLO act as RSET; VRFY, EXPN, ETRN and  HELP, act
36798 as NOOP; QUIT quits.
36799
36800 Minimal policy checking is done for BSMTP input. Only the non-SMTP
36801 ACL is run in the same way as for non-SMTP local input.
36802
36803 If an error is detected while reading a message, including a missing &"."& at
36804 the end, Exim gives up immediately. It writes details of the error to the
36805 standard output in a stylized way that the calling program should be able to
36806 make some use of automatically, for example:
36807 .code
36808 554 Unexpected end of file
36809 Transaction started in line 10
36810 Error detected in line 14
36811 .endd
36812 It writes a more verbose version, for human consumption, to the standard error
36813 file, for example:
36814 .code
36815 An error was detected while processing a file of BSMTP input.
36816 The error message was:
36817
36818 501 '>' missing at end of address
36819
36820 The SMTP transaction started in line 10.
36821 The error was detected in line 12.
36822 The SMTP command at fault was:
36823
36824 rcpt to:<malformed@in.com.plete
36825
36826 1 previous message was successfully processed.
36827 The rest of the batch was abandoned.
36828 .endd
36829 The return code from Exim is zero only if there were no errors. It is 1 if some
36830 messages were accepted before an error was detected, and 2 if no messages were
36831 accepted.
36832 .ecindex IIDsmtpproc1
36833 .ecindex IIDsmtpproc2
36834
36835
36836
36837 . ////////////////////////////////////////////////////////////////////////////
36838 . ////////////////////////////////////////////////////////////////////////////
36839
36840 .chapter "Customizing bounce and warning messages" "CHAPemsgcust" &&&
36841          "Customizing messages"
36842 When a message fails to be delivered, or remains in the queue for more than a
36843 configured amount of time, Exim sends a message to the original sender, or
36844 to an alternative configured address. The text of these messages is built into
36845 the code of Exim, but it is possible to change it, either by adding a single
36846 string, or by replacing each of the paragraphs by text supplied in a file.
36847
36848 The &'From:'& and &'To:'& header lines are automatically generated; you can
36849 cause a &'Reply-To:'& line to be added by setting the &%errors_reply_to%&
36850 option. Exim also adds the line
36851 .code
36852 Auto-Submitted: auto-generated
36853 .endd
36854 to all warning and bounce messages,
36855
36856
36857 .section "Customizing bounce messages" "SECID239"
36858 .cindex "customizing" "bounce message"
36859 .cindex "bounce message" "customizing"
36860 If &%bounce_message_text%& is set, its contents are included in the default
36861 message immediately after &"This message was created automatically by mail
36862 delivery software."& The string is not expanded. It is not used if
36863 &%bounce_message_file%& is set.
36864
36865 When &%bounce_message_file%& is set, it must point to a template file for
36866 constructing error messages. The file consists of a series of text items,
36867 separated by lines consisting of exactly four asterisks. If the file cannot be
36868 opened, default text is used and a message is written to the main and panic
36869 logs. If any text item in the file is empty, default text is used for that
36870 item.
36871
36872 .vindex "&$bounce_recipient$&"
36873 .vindex "&$bounce_return_size_limit$&"
36874 Each item of text that is read from the file is expanded, and there are two
36875 expansion variables which can be of use here: &$bounce_recipient$& is set to
36876 the recipient of an error message while it is being created, and
36877 &$bounce_return_size_limit$& contains the value of the &%return_size_limit%&
36878 option, rounded to a whole number.
36879
36880 The items must appear in the file in the following order:
36881
36882 .ilist
36883 The first item is included in the headers, and should include at least a
36884 &'Subject:'& header. Exim does not check the syntax of these headers.
36885 .next
36886 The second item forms the start of the error message. After it, Exim lists the
36887 failing addresses with their error messages.
36888 .next
36889 The third item is used to introduce any text from pipe transports that is to be
36890 returned to the sender. It is omitted if there is no such text.
36891 .next
36892 The fourth, fifth and sixth items will be ignored and may be empty.
36893 The fields exist for back-compatibility
36894 .endlist
36895
36896 The default state (&%bounce_message_file%& unset) is equivalent to the
36897 following file, in which the sixth item is empty. The &'Subject:'& and some
36898 other lines have been split in order to fit them on the page:
36899 .code
36900 Subject: Mail delivery failed
36901   ${if eq{$sender_address}{$bounce_recipient}
36902   {: returning message to sender}}
36903 ****
36904 This message was created automatically by mail delivery software.
36905
36906 A message ${if eq{$sender_address}{$bounce_recipient}
36907   {that you sent }{sent by
36908
36909 <$sender_address>
36910
36911 }}could not be delivered to all of its recipients.
36912 This is a permanent error. The following address(es) failed:
36913 ****
36914 The following text was generated during the delivery attempt(s):
36915 ****
36916 ------ This is a copy of the message, including all the headers.
36917   ------
36918 ****
36919 ------ The body of the message is $message_size characters long;
36920   only the first
36921 ------ $bounce_return_size_limit or so are included here.
36922 ****
36923 .endd
36924 .section "Customizing warning messages" "SECTcustwarn"
36925 .cindex "customizing" "warning message"
36926 .cindex "warning of delay" "customizing the message"
36927 The option &%warn_message_file%& can be pointed at a template file for use when
36928 warnings about message delays are created. In this case there are only three
36929 text sections:
36930
36931 .ilist
36932 The first item is included in the headers, and should include at least a
36933 &'Subject:'& header. Exim does not check the syntax of these headers.
36934 .next
36935 The second item forms the start of the warning message. After it, Exim lists
36936 the delayed addresses.
36937 .next
36938 The third item then ends the message.
36939 .endlist
36940
36941 The default state is equivalent to the following file, except that some lines
36942 have been split here, in order to fit them on the page:
36943 .code
36944 Subject: Warning: message $message_exim_id delayed
36945   $warn_message_delay
36946 ****
36947 This message was created automatically by mail delivery software.
36948
36949 A message ${if eq{$sender_address}{$warn_message_recipients}
36950 {that you sent }{sent by
36951
36952 <$sender_address>
36953
36954 }}has not been delivered to all of its recipients after
36955 more than $warn_message_delay in the queue on $primary_hostname.
36956
36957 The message identifier is:     $message_exim_id
36958 The subject of the message is: $h_subject
36959 The date of the message is:    $h_date
36960
36961 The following address(es) have not yet been delivered:
36962 ****
36963 No action is required on your part. Delivery attempts will
36964 continue for some time, and this warning may be repeated at
36965 intervals if the message remains undelivered. Eventually the
36966 mail delivery software will give up, and when that happens,
36967 the message will be returned to you.
36968 .endd
36969 .vindex "&$warn_message_delay$&"
36970 .vindex "&$warn_message_recipients$&"
36971 However, in the default state the subject and date lines are omitted if no
36972 appropriate headers exist. During the expansion of this file,
36973 &$warn_message_delay$& is set to the delay time in one of the forms &"<&'n'&>
36974 minutes"& or &"<&'n'&> hours"&, and &$warn_message_recipients$& contains a list
36975 of recipients for the warning message. There may be more than one if there are
36976 multiple addresses with different &%errors_to%& settings on the routers that
36977 handled them.
36978
36979
36980
36981
36982 . ////////////////////////////////////////////////////////////////////////////
36983 . ////////////////////////////////////////////////////////////////////////////
36984
36985 .chapter "Some common configuration settings" "CHAPcomconreq"
36986 This chapter discusses some configuration settings that seem to be fairly
36987 common. More examples and discussion can be found in the Exim book.
36988
36989
36990
36991 .section "Sending mail to a smart host" "SECID240"
36992 .cindex "smart host" "example router"
36993 If you want to send all mail for non-local domains to a &"smart host"&, you
36994 should replace the default &(dnslookup)& router with a router which does the
36995 routing explicitly:
36996 .code
36997 send_to_smart_host:
36998   driver = manualroute
36999   route_list = !+local_domains smart.host.name
37000   transport = remote_smtp
37001 .endd
37002 You can use the smart host's IP address instead of the name if you wish.
37003 If you are using Exim only to submit messages to a smart host, and not for
37004 receiving incoming messages, you can arrange for it to do the submission
37005 synchronously by setting the &%mua_wrapper%& option (see chapter
37006 &<<CHAPnonqueueing>>&).
37007
37008
37009
37010
37011 .section "Using Exim to handle mailing lists" "SECTmailinglists"
37012 .cindex "mailing lists"
37013 Exim can be used to run simple mailing lists, but for large and/or complicated
37014 requirements, the use of additional specialized mailing list software such as
37015 Majordomo or Mailman is recommended.
37016
37017 The &(redirect)& router can be used to handle mailing lists where each list
37018 is maintained in a separate file, which can therefore be managed by an
37019 independent manager. The &%domains%& router option can be used to run these
37020 lists in a separate domain from normal mail. For example:
37021 .code
37022 lists:
37023   driver = redirect
37024   domains = lists.example
37025   file = ${lookup {$local_part} dsearch,ret=full {/usr/lists}}
37026   forbid_pipe
37027   forbid_file
37028   errors_to = ${quote_local_part:$local_part-request}@lists.example
37029   no_more
37030 .endd
37031 This router is skipped for domains other than &'lists.example'&. For addresses
37032 in that domain, it looks for a file that matches the local part. If there is no
37033 such file, the router declines, but because &%no_more%& is set, no subsequent
37034 routers are tried, and so the whole delivery fails.
37035
37036 The &%forbid_pipe%& and &%forbid_file%& options prevent a local part from being
37037 expanded into a filename or a pipe delivery, which is usually inappropriate in
37038 a mailing list.
37039
37040 .oindex "&%errors_to%&"
37041 The &%errors_to%& option specifies that any delivery errors caused by addresses
37042 taken from a mailing list are to be sent to the given address rather than the
37043 original sender of the message. However, before acting on this, Exim verifies
37044 the error address, and ignores it if verification fails.
37045
37046 For example, using the configuration above, mail sent to
37047 &'dicts@lists.example'& is passed on to those addresses contained in
37048 &_/usr/lists/dicts_&, with error reports directed to
37049 &'dicts-request@lists.example'&, provided that this address can be verified.
37050 There could be a file called &_/usr/lists/dicts-request_& containing
37051 the address(es) of this particular list's manager(s), but other approaches,
37052 such as setting up an earlier router (possibly using the &%local_part_prefix%&
37053 or &%local_part_suffix%& options) to handle addresses of the form
37054 &%owner-%&&'xxx'& or &%xxx-%&&'request'&, are also possible.
37055
37056
37057
37058 .section "Syntax errors in mailing lists" "SECID241"
37059 .cindex "mailing lists" "syntax errors in"
37060 If an entry in redirection data contains a syntax error, Exim normally defers
37061 delivery of the original address. That means that a syntax error in a mailing
37062 list holds up all deliveries to the list. This may not be appropriate when a
37063 list is being maintained automatically from data supplied by users, and the
37064 addresses are not rigorously checked.
37065
37066 If the &%skip_syntax_errors%& option is set, the &(redirect)& router just skips
37067 entries that fail to parse, noting the incident in the log. If in addition
37068 &%syntax_errors_to%& is set to a verifiable address, a message is sent to it
37069 whenever a broken address is skipped. It is usually appropriate to set
37070 &%syntax_errors_to%& to the same address as &%errors_to%&.
37071
37072
37073
37074 .section "Re-expansion of mailing lists" "SECID242"
37075 .cindex "mailing lists" "re-expansion of"
37076 Exim remembers every individual address to which a message has been delivered,
37077 in order to avoid duplication, but it normally stores only the original
37078 recipient addresses with a message. If all the deliveries to a mailing list
37079 cannot be done at the first attempt, the mailing list is re-expanded when the
37080 delivery is next tried. This means that alterations to the list are taken into
37081 account at each delivery attempt, so addresses that have been added to
37082 the list since the message arrived will therefore receive a copy of the
37083 message, even though it pre-dates their subscription.
37084
37085 If this behaviour is felt to be undesirable, the &%one_time%& option can be set
37086 on the &(redirect)& router. If this is done, any addresses generated by the
37087 router that fail to deliver at the first attempt are added to the message as
37088 &"top level"& addresses, and the parent address that generated them is marked
37089 &"delivered"&. Thus, expansion of the mailing list does not happen again at the
37090 subsequent delivery attempts. The disadvantage of this is that if any of the
37091 failing addresses are incorrect, correcting them in the file has no effect on
37092 pre-existing messages.
37093
37094 The original top-level address is remembered with each of the generated
37095 addresses, and is output in any log messages. However, any intermediate parent
37096 addresses are not recorded. This makes a difference to the log only if the
37097 &%all_parents%& selector is set, but for mailing lists there is normally only
37098 one level of expansion anyway.
37099
37100
37101
37102 .section "Closed mailing lists" "SECID243"
37103 .cindex "mailing lists" "closed"
37104 The examples so far have assumed open mailing lists, to which anybody may
37105 send mail. It is also possible to set up closed lists, where mail is accepted
37106 from specified senders only. This is done by making use of the generic
37107 &%senders%& option to restrict the router that handles the list.
37108
37109 The following example uses the same file as a list of recipients and as a list
37110 of permitted senders. It requires three routers:
37111 .code
37112 lists_request:
37113   driver = redirect
37114   domains = lists.example
37115   local_part_suffix = -request
37116   local_parts = ${lookup {$local_part} dsearch,filter=file {/usr/lists}}
37117   file = /usr/lists/${local_part_data}-request
37118   no_more
37119
37120 lists_post:
37121   driver = redirect
37122   domains = lists.example
37123   senders = ${if exists {/usr/lists/$local_part}\
37124              {lsearch;/usr/lists/$local_part}{*}}
37125   file = ${lookup {$local_part} dsearch,ret=full {/usr/lists}}
37126   forbid_pipe
37127   forbid_file
37128   errors_to = ${quote_local_part:$local_part-request}@lists.example
37129   no_more
37130
37131 lists_closed:
37132   driver = redirect
37133   domains = lists.example
37134   allow_fail
37135   data = :fail: $local_part@lists.example is a closed mailing list
37136 .endd
37137 All three routers have the same &%domains%& setting, so for any other domains,
37138 they are all skipped. The first router runs only if the local part ends in
37139 &%-request%&. It handles messages to the list manager(s) by means of an open
37140 mailing list.
37141
37142 The second router runs only if the &%senders%& precondition is satisfied. It
37143 checks for the existence of a list that corresponds to the local part, and then
37144 checks that the sender is on the list by means of a linear search. It is
37145 necessary to check for the existence of the file before trying to search it,
37146 because otherwise Exim thinks there is a configuration error. If the file does
37147 not exist, the expansion of &%senders%& is *, which matches all senders. This
37148 means that the router runs, but because there is no list, declines, and
37149 &%no_more%& ensures that no further routers are run. The address fails with an
37150 &"unrouteable address"& error.
37151
37152 The third router runs only if the second router is skipped, which happens when
37153 a mailing list exists, but the sender is not on it. This router forcibly fails
37154 the address, giving a suitable error message.
37155
37156
37157
37158
37159 .section "Variable Envelope Return Paths (VERP)" "SECTverp"
37160 .cindex "VERP"
37161 .cindex "Variable Envelope Return Paths"
37162 .cindex "envelope from"
37163 .cindex "envelope sender"
37164 Variable Envelope Return Paths &-- see &url(https://cr.yp.to/proto/verp.txt) &--
37165 are a way of helping mailing list administrators discover which subscription
37166 address is the cause of a particular delivery failure. The idea is to encode
37167 the original recipient address in the outgoing envelope sender address, so that
37168 if the message is forwarded by another host and then subsequently bounces, the
37169 original recipient can be extracted from the recipient address of the bounce.
37170
37171 .oindex &%errors_to%&
37172 .oindex &%return_path%&
37173 Envelope sender addresses can be modified by Exim using two different
37174 facilities: the &%errors_to%& option on a router (as shown in previous mailing
37175 list examples), or the &%return_path%& option on a transport. The second of
37176 these is effective only if the message is successfully delivered to another
37177 host; it is not used for errors detected on the local host (see the description
37178 of &%return_path%& in chapter &<<CHAPtransportgeneric>>&). Here is an example
37179 of the use of &%return_path%& to implement VERP on an &(smtp)& transport:
37180 .code
37181 verp_smtp:
37182   driver = smtp
37183   max_rcpt = 1
37184   return_path = \
37185     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
37186       {${quote_local_part:$1-request+$local_part=$domain}@your.dom.example}fail}
37187 .endd
37188 This has the effect of rewriting the return path (envelope sender) on outgoing
37189 SMTP messages, if the local part of the original return path ends in
37190 &"-request"&, and the domain is &'your.dom.example'&. The rewriting inserts the
37191 local part and domain of the recipient into the return path. Suppose, for
37192 example, that a message whose return path has been set to
37193 &'somelist-request@your.dom.example'& is sent to
37194 &'subscriber@other.dom.example'&. In the transport, the return path is
37195 rewritten as
37196 .code
37197 somelist-request+subscriber=other.dom.example@your.dom.example
37198 .endd
37199 .vindex "&$local_part$&"
37200 For this to work, you must tell Exim to send multiple copies of messages that
37201 have more than one recipient, so that each copy has just one recipient. This is
37202 achieved by setting &%max_rcpt%& to 1. Without this, a single copy of a message
37203 might be sent to several different recipients in the same domain, in which case
37204 &$local_part$& is not available in the transport, because it is not unique.
37205
37206 Unless your host is doing nothing but mailing list deliveries, you should
37207 probably use a separate transport for the VERP deliveries, so as not to use
37208 extra resources in making one-per-recipient copies for other deliveries. This
37209 can easily be done by expanding the &%transport%& option in the router:
37210 .code
37211 dnslookup:
37212   driver = dnslookup
37213   domains = ! +local_domains
37214   transport = \
37215     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
37216       {verp_smtp}{remote_smtp}}
37217   no_more
37218 .endd
37219 If you want to change the return path using &%errors_to%& in a router instead
37220 of using &%return_path%& in the transport, you need to set &%errors_to%& on all
37221 routers that handle mailing list addresses. This will ensure that all delivery
37222 errors, including those detected on the local host, are sent to the VERP
37223 address.
37224
37225 On a host that does no local deliveries and has no manual routing, only the
37226 &(dnslookup)& router needs to be changed. A special transport is not needed for
37227 SMTP deliveries. Every mailing list recipient has its own return path value,
37228 and so Exim must hand them to the transport one at a time. Here is an example
37229 of a &(dnslookup)& router that implements VERP:
37230 .code
37231 verp_dnslookup:
37232   driver = dnslookup
37233   domains = ! +local_domains
37234   transport = remote_smtp
37235   errors_to = \
37236     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}}
37237      {${quote_local_part:$1-request+$local_part=$domain}@your.dom.example}fail}
37238   no_more
37239 .endd
37240 Before you start sending out messages with VERPed return paths, you must also
37241 configure Exim to accept the bounce messages that come back to those paths.
37242 Typically this is done by setting a &%local_part_suffix%& option for a
37243 router, and using this to route the messages to wherever you want to handle
37244 them.
37245
37246 The overhead incurred in using VERP depends very much on the size of the
37247 message, the number of recipient addresses that resolve to the same remote
37248 host, and the speed of the connection over which the message is being sent. If
37249 a lot of addresses resolve to the same host and the connection is slow, sending
37250 a separate copy of the message for each address may take substantially longer
37251 than sending a single copy with many recipients (for which VERP cannot be
37252 used).
37253
37254
37255
37256
37257
37258
37259 .section "Virtual domains" "SECTvirtualdomains"
37260 .cindex "virtual domains"
37261 .cindex "domain" "virtual"
37262 The phrase &'virtual domain'& is unfortunately used with two rather different
37263 meanings:
37264
37265 .ilist
37266 A domain for which there are no real mailboxes; all valid local parts are
37267 aliases for other email addresses. Common examples are organizational
37268 top-level domains and &"vanity"& domains.
37269 .next
37270 One of a number of independent domains that are all handled by the same host,
37271 with mailboxes on that host, but where the mailbox owners do not necessarily
37272 have login accounts on that host.
37273 .endlist
37274
37275 The first usage is probably more common, and does seem more &"virtual"& than
37276 the second. This kind of domain can be handled in Exim with a straightforward
37277 aliasing router. One approach is to create a separate alias file for each
37278 virtual domain. Exim can test for the existence of the alias file to determine
37279 whether the domain exists. The &(dsearch)& lookup type is useful here, leading
37280 to a router of this form:
37281 .code
37282 virtual:
37283   driver = redirect
37284   domains = dsearch;/etc/mail/virtual
37285   data = ${lookup{$local_part}lsearch{/etc/mail/virtual/$domain_data}}
37286   no_more
37287 .endd
37288 The &%domains%& option specifies that the router is to be skipped, unless there
37289 is a file in the &_/etc/mail/virtual_& directory whose name is the same as the
37290 domain that is being processed.
37291 The &(dsearch)& lookup used results in an untainted version of &$domain$&
37292 being placed into the &$domain_data$& variable.
37293
37294 When the router runs, it looks up the local
37295 part in the file to find a new address (or list of addresses). The &%no_more%&
37296 setting ensures that if the lookup fails (leading to &%data%& being an empty
37297 string), Exim gives up on the address without trying any subsequent routers.
37298
37299 This one router can handle all the virtual domains because the alias filenames
37300 follow a fixed pattern. Permissions can be arranged so that appropriate people
37301 can edit the different alias files. A successful aliasing operation results in
37302 a new envelope recipient address, which is then routed from scratch.
37303
37304 The other kind of &"virtual"& domain can also be handled in a straightforward
37305 way. One approach is to create a file for each domain containing a list of
37306 valid local parts, and use it in a router like this:
37307 .code
37308 my_domains:
37309   driver = accept
37310   domains = dsearch;/etc/mail/domains
37311   local_parts = lsearch;/etc/mail/domains/$domain
37312   transport = my_mailboxes
37313 .endd
37314 The address is accepted if there is a file for the domain, and the local part
37315 can be found in the file. The &%domains%& option is used to check for the
37316 file's existence because &%domains%& is tested before the &%local_parts%&
37317 option (see section &<<SECTrouprecon>>&). You cannot use &%require_files%&,
37318 because that option is tested after &%local_parts%&. The transport is as
37319 follows:
37320 .code
37321 my_mailboxes:
37322   driver = appendfile
37323   file = /var/mail/$domain_data/$local_part_data
37324   user = mail
37325 .endd
37326 This uses a directory of mailboxes for each domain. The &%user%& setting is
37327 required, to specify which uid is to be used for writing to the mailboxes.
37328
37329 The configuration shown here is just one example of how you might support this
37330 requirement. There are many other ways this kind of configuration can be set
37331 up, for example, by using a database instead of separate files to hold all the
37332 information about the domains.
37333
37334
37335
37336 .section "Multiple user mailboxes" "SECTmulbox"
37337 .cindex "multiple mailboxes"
37338 .cindex "mailbox" "multiple"
37339 .cindex "local part" "prefix"
37340 .cindex "local part" "suffix"
37341 Heavy email users often want to operate with multiple mailboxes, into which
37342 incoming mail is automatically sorted. A popular way of handling this is to
37343 allow users to use multiple sender addresses, so that replies can easily be
37344 identified. Users are permitted to add prefixes or suffixes to their local
37345 parts for this purpose. The wildcard facility of the generic router options
37346 &%local_part_prefix%& and &%local_part_suffix%& can be used for this. For
37347 example, consider this router:
37348 .code
37349 userforward:
37350   driver = redirect
37351   check_local_user
37352   file = $home/.forward
37353   local_part_suffix = -*
37354   local_part_suffix_optional
37355   allow_filter
37356 .endd
37357 .vindex "&$local_part_suffix$&"
37358 It runs a user's &_.forward_& file for all local parts of the form
37359 &'username-*'&. Within the filter file the user can distinguish different
37360 cases by testing the variable &$local_part_suffix$&. For example:
37361 .code
37362 if $local_part_suffix contains -special then
37363 save /home/$local_part_data/Mail/special
37364 endif
37365 .endd
37366 If the filter file does not exist, or does not deal with such addresses, they
37367 fall through to subsequent routers, and, assuming no subsequent use of the
37368 &%local_part_suffix%& option is made, they presumably fail. Thus, users have
37369 control over which suffixes are valid.
37370
37371 Alternatively, a suffix can be used to trigger the use of a different
37372 &_.forward_& file &-- which is the way a similar facility is implemented in
37373 another MTA:
37374 .code
37375 userforward:
37376   driver = redirect
37377   check_local_user
37378   local_part_suffix = -*
37379   local_part_suffix_optional
37380   file = ${lookup {.forward$local_part_suffix} dsearch,ret=full {$home} {$value}fail}
37381   allow_filter
37382 .endd
37383 If there is no suffix, &_.forward_& is used; if the suffix is &'-special'&, for
37384 example, &_.forward-special_& is used. Once again, if the appropriate file
37385 does not exist, or does not deal with the address, it is passed on to
37386 subsequent routers, which could, if required, look for an unqualified
37387 &_.forward_& file to use as a default.
37388
37389
37390
37391 .section "Simplified vacation processing" "SECID244"
37392 .cindex "vacation processing"
37393 The traditional way of running the &'vacation'& program is for a user to set up
37394 a pipe command in a &_.forward_& file
37395 (see section &<<SECTspecitredli>>& for syntax details).
37396 This is prone to error by inexperienced users. There are two features of Exim
37397 that can be used to make this process simpler for users:
37398
37399 .ilist
37400 A local part prefix such as &"vacation-"& can be specified on a router which
37401 can cause the message to be delivered directly to the &'vacation'& program, or
37402 alternatively can use Exim's &(autoreply)& transport. The contents of a user's
37403 &_.forward_& file are then much simpler. For example:
37404 .code
37405 spqr, vacation-spqr
37406 .endd
37407 .next
37408 The &%require_files%& generic router option can be used to trigger a
37409 vacation delivery by checking for the existence of a certain file in the
37410 user's home directory. The &%unseen%& generic option should also be used, to
37411 ensure that the original delivery also proceeds. In this case, all the user has
37412 to do is to create a file called, say, &_.vacation_&, containing a vacation
37413 message.
37414 .endlist
37415
37416 Another advantage of both these methods is that they both work even when the
37417 use of arbitrary pipes by users is locked out.
37418
37419
37420
37421 .section "Taking copies of mail" "SECID245"
37422 .cindex "message" "copying every"
37423 Some installations have policies that require archive copies of all messages to
37424 be made. A single copy of each message can easily be taken by an appropriate
37425 command in a system filter, which could, for example, use a different file for
37426 each day's messages.
37427
37428 There is also a shadow transport mechanism that can be used to take copies of
37429 messages that are successfully delivered by local transports, one copy per
37430 delivery. This could be used, &'inter alia'&, to implement automatic
37431 notification of delivery by sites that insist on doing such things.
37432
37433
37434
37435 .section "Intermittently connected hosts" "SECID246"
37436 .cindex "intermittently connected hosts"
37437 It has become quite common (because it is cheaper) for hosts to connect to the
37438 Internet periodically rather than remain connected all the time. The normal
37439 arrangement is that mail for such hosts accumulates on a system that is
37440 permanently connected.
37441
37442 Exim was designed for use on permanently connected hosts, and so it is not
37443 particularly well-suited to use in an intermittently connected environment.
37444 Nevertheless there are some features that can be used.
37445
37446
37447 .section "Exim on the upstream server host" "SECID247"
37448 It is tempting to arrange for incoming mail for the intermittently connected
37449 host to remain in Exim's queue until the client connects. However, this
37450 approach does not scale very well. Two different kinds of waiting message are
37451 being mixed up in the same queue &-- those that cannot be delivered because of
37452 some temporary problem, and those that are waiting for their destination host
37453 to connect. This makes it hard to manage the queue, as well as wasting
37454 resources, because each queue runner scans the entire queue.
37455
37456 A better approach is to separate off those messages that are waiting for an
37457 intermittently connected host. This can be done by delivering these messages
37458 into local files in batch SMTP, &"mailstore"&, or other envelope-preserving
37459 format, from where they are transmitted by other software when their
37460 destination connects. This makes it easy to collect all the mail for one host
37461 in a single directory, and to apply local timeout rules on a per-message basis
37462 if required.
37463
37464 On a very small scale, leaving the mail on Exim's queue can be made to work. If
37465 you are doing this, you should configure Exim with a long retry period for the
37466 intermittent host. For example:
37467 .code
37468 cheshire.wonderland.fict.example    *   F,5d,24h
37469 .endd
37470 This stops a lot of failed delivery attempts from occurring, but Exim remembers
37471 which messages it has queued up for that host. Once the intermittent host comes
37472 online, forcing delivery of one message (either by using the &%-M%& or &%-R%&
37473 options, or by using the ETRN SMTP command (see section &<<SECTETRN>>&)
37474 causes all the queued up messages to be delivered, often down a single SMTP
37475 connection. While the host remains connected, any new messages get delivered
37476 immediately.
37477
37478 If the connecting hosts do not have fixed IP addresses, that is, if a host is
37479 issued with a different IP address each time it connects, Exim's retry
37480 mechanisms on the holding host get confused, because the IP address is normally
37481 used as part of the key string for holding retry information. This can be
37482 avoided by unsetting &%retry_include_ip_address%& on the &(smtp)& transport.
37483 Since this has disadvantages for permanently connected hosts, it is best to
37484 arrange a separate transport for the intermittently connected ones.
37485
37486
37487
37488 .section "Exim on the intermittently connected client host" "SECID248"
37489 The value of &%smtp_accept_queue_per_connection%& should probably be
37490 increased, or even set to zero (that is, disabled) on the intermittently
37491 connected host, so that all incoming messages down a single connection get
37492 delivered immediately.
37493
37494 .cindex "SMTP" "passed connection"
37495 .cindex "SMTP" "multiple deliveries"
37496 .cindex "multiple SMTP deliveries"
37497 .cindex "first pass routing"
37498 Mail waiting to be sent from an intermittently connected host will probably
37499 not have been routed, because without a connection DNS lookups are not
37500 possible. This means that if a normal queue run is done at connection time,
37501 each message is likely to be sent in a separate SMTP session. This can be
37502 avoided by starting the queue run with a command line option beginning with
37503 &%-qq%& instead of &%-q%&. In this case, the queue is scanned twice. In the
37504 first pass, routing is done but no deliveries take place. The second pass is a
37505 normal queue run; since all the messages have been previously routed, those
37506 destined for the same host are likely to get sent as multiple deliveries in a
37507 single SMTP connection.
37508
37509
37510
37511 . ////////////////////////////////////////////////////////////////////////////
37512 . ////////////////////////////////////////////////////////////////////////////
37513
37514 .chapter "Using Exim as a non-queueing client" "CHAPnonqueueing" &&&
37515          "Exim as a non-queueing client"
37516 .cindex "client, non-queueing"
37517 .cindex "smart host" "suppressing queueing"
37518 On a personal computer, it is a common requirement for all
37519 email to be sent to a &"smart host"&. There are plenty of MUAs that can be
37520 configured to operate that way, for all the popular operating systems.
37521 However, there are some MUAs for Unix-like systems that cannot be so
37522 configured: they submit messages using the command line interface of
37523 &_/usr/sbin/sendmail_&. Furthermore, utility programs such as &'cron'& submit
37524 messages this way.
37525
37526 If the personal computer runs continuously, there is no problem, because it can
37527 run a conventional MTA that handles delivery to the smart host, and deal with
37528 any delays via its queueing mechanism. However, if the computer does not run
37529 continuously or runs different operating systems at different times, queueing
37530 email is not desirable.
37531
37532 There is therefore a requirement for something that can provide the
37533 &_/usr/sbin/sendmail_& interface but deliver messages to a smart host without
37534 any queueing or retrying facilities. Furthermore, the delivery to the smart
37535 host should be synchronous, so that if it fails, the sending MUA is immediately
37536 informed. In other words, we want something that extends an MUA that submits
37537 to a local MTA via the command line so that it behaves like one that submits
37538 to a remote smart host using TCP/SMTP.
37539
37540 There are a number of applications (for example, there is one called &'ssmtp'&)
37541 that do this job. However, people have found them to be lacking in various
37542 ways. For instance, you might want to allow aliasing and forwarding to be done
37543 before sending a message to the smart host.
37544
37545 Exim already had the necessary infrastructure for doing this job. Just a few
37546 tweaks were needed to make it behave as required, though it is somewhat of an
37547 overkill to use a fully-featured MTA for this purpose.
37548
37549 .oindex "&%mua_wrapper%&"
37550 There is a Boolean global option called &%mua_wrapper%&, defaulting false.
37551 Setting &%mua_wrapper%& true causes Exim to run in a special mode where it
37552 assumes that it is being used to &"wrap"& a command-line MUA in the manner
37553 just described. As well as setting &%mua_wrapper%&, you also need to provide a
37554 compatible router and transport configuration. Typically there will be just one
37555 router and one transport, sending everything to a smart host.
37556
37557 When run in MUA wrapping mode, the behaviour of Exim changes in the
37558 following ways:
37559
37560 .ilist
37561 A daemon cannot be run, nor will Exim accept incoming messages from &'inetd'&.
37562 In other words, the only way to submit messages is via the command line.
37563 .next
37564 Each message is synchronously delivered as soon as it is received (&%-odi%& is
37565 assumed). All queueing options (&%queue_only%&, &%queue_smtp_domains%&,
37566 &%control%& in an ACL, etc.) are quietly ignored. The Exim reception process
37567 does not finish until the delivery attempt is complete. If the delivery is
37568 successful, a zero return code is given.
37569 .next
37570 Address redirection is permitted, but the final routing for all addresses must
37571 be to the same remote transport, and to the same list of hosts. Furthermore,
37572 the return address (envelope sender) must be the same for all recipients, as
37573 must any added or deleted header lines. In other words, it must be possible to
37574 deliver the message in a single SMTP transaction, however many recipients there
37575 are.
37576 .next
37577 If these conditions are not met, or if routing any address results in a
37578 failure or defer status, or if Exim is unable to deliver all the recipients
37579 successfully to one of the smart hosts, delivery of the entire message fails.
37580 .next
37581 Because no queueing is allowed, all failures are treated as permanent; there
37582 is no distinction between 4&'xx'& and 5&'xx'& SMTP response codes from the
37583 smart host. Furthermore, because only a single yes/no response can be given to
37584 the caller, it is not possible to deliver to some recipients and not others. If
37585 there is an error (temporary or permanent) for any recipient, all are failed.
37586 .next
37587 If more than one smart host is listed, Exim will try another host after a
37588 connection failure or a timeout, in the normal way. However, if this kind of
37589 failure happens for all the hosts, the delivery fails.
37590 .next
37591 When delivery fails, an error message is written to the standard error stream
37592 (as well as to Exim's log), and Exim exits to the caller with a return code
37593 value 1. The message is expunged from Exim's spool files. No bounce messages
37594 are ever generated.
37595 .next
37596 No retry data is maintained, and any retry rules are ignored.
37597 .next
37598 A number of Exim options are overridden: &%deliver_drop_privilege%& is forced
37599 true, &%max_rcpt%& in the &(smtp)& transport is forced to &"unlimited"&,
37600 &%remote_max_parallel%& is forced to one, and fallback hosts are ignored.
37601 .endlist
37602
37603 The overall effect is that Exim makes a single synchronous attempt to deliver
37604 the message, failing if there is any kind of problem. Because no local
37605 deliveries are done and no daemon can be run, Exim does not need root
37606 privilege. It should be possible to run it setuid to &'exim'& instead of setuid
37607 to &'root'&. See section &<<SECTrunexiwitpri>>& for a general discussion about
37608 the advantages and disadvantages of running without root privilege.
37609
37610
37611
37612
37613 . ////////////////////////////////////////////////////////////////////////////
37614 . ////////////////////////////////////////////////////////////////////////////
37615
37616 .chapter "Log files" "CHAPlog"
37617 .scindex IIDloggen "log" "general description"
37618 .cindex "log" "types of"
37619 Exim writes three different logs, referred to as the main log, the reject log,
37620 and the panic log:
37621
37622 .ilist
37623 .cindex "main log"
37624 The main log records the arrival of each message and each delivery in a single
37625 line in each case. The format is as compact as possible, in an attempt to keep
37626 down the size of log files. Two-character flag sequences make it easy to pick
37627 out these lines. A number of other events are recorded in the main log. Some of
37628 them are optional, in which case the &%log_selector%& option controls whether
37629 they are included or not. A Perl script called &'eximstats'&, which does simple
37630 analysis of main log files, is provided in the Exim distribution (see section
37631 &<<SECTmailstat>>&).
37632 .next
37633 .cindex "reject log"
37634 The reject log records information from messages that are rejected as a result
37635 of a configuration option (that is, for policy reasons).
37636 The first line of each rejection is a copy of the line that is also written to
37637 the main log. Then, if the message's header has been read at the time the log
37638 is written, its contents are written to this log. Only the original header
37639 lines are available; header lines added by ACLs are not logged. You can use the
37640 reject log to check that your policy controls are working correctly; on a busy
37641 host this may be easier than scanning the main log for rejection messages. You
37642 can suppress the writing of the reject log by setting &%write_rejectlog%&
37643 false.
37644 .next
37645 .cindex "panic log"
37646 .cindex "system log"
37647 When certain serious errors occur, Exim writes entries to its panic log. If the
37648 error is sufficiently disastrous, Exim bombs out afterwards. Panic log entries
37649 are usually written to the main log as well, but can get lost amid the mass of
37650 other entries. The panic log should be empty under normal circumstances. It is
37651 therefore a good idea to check it (or to have a &'cron'& script check it)
37652 regularly, in order to become aware of any problems. When Exim cannot open its
37653 panic log, it tries as a last resort to write to the system log (syslog). This
37654 is opened with LOG_PID+LOG_CONS and the facility code of LOG_MAIL. The
37655 message itself is written at priority LOG_CRIT.
37656 .endlist
37657
37658 Every log line starts with a timestamp, in the format shown in the following
37659 example. Note that many of the examples shown in this chapter are line-wrapped.
37660 In the log file, this would be all on one line:
37661 .code
37662 2001-09-16 16:09:47 SMTP connection from [127.0.0.1] closed
37663   by QUIT
37664 .endd
37665 By default, the timestamps are in the local timezone. There are two
37666 ways of changing this:
37667
37668 .ilist
37669 You can set the &%timezone%& option to a different time zone; in particular, if
37670 you set
37671 .code
37672 timezone = UTC
37673 .endd
37674 the timestamps will be in UTC (aka GMT).
37675 .next
37676 If you set &%log_timezone%& true, the time zone is added to the timestamp, for
37677 example:
37678 .code
37679 2003-04-25 11:17:07 +0100 Start queue run: pid=12762
37680 .endd
37681 .endlist
37682
37683 .cindex "log" "process ids in"
37684 .cindex "pid (process id)" "in log lines"
37685 Exim does not include its process id in log lines by default, but you can
37686 request that it does so by specifying the &`pid`& log selector (see section
37687 &<<SECTlogselector>>&). When this is set, the process id is output, in square
37688 brackets, immediately after the time and date.
37689
37690
37691
37692
37693 .section "Where the logs are written" "SECTwhelogwri"
37694 .cindex "log" "destination"
37695 .cindex "log" "to file"
37696 .cindex "log" "to syslog"
37697 .cindex "syslog"
37698 The logs may be written to local files, or to syslog, or both. However, it
37699 should be noted that many syslog implementations use UDP as a transport, and
37700 are therefore unreliable in the sense that messages are not guaranteed to
37701 arrive at the loghost, nor is the ordering of messages necessarily maintained.
37702 It has also been reported that on large log files (tens of megabytes) you may
37703 need to tweak syslog to prevent it syncing the file with each write &-- on
37704 Linux this has been seen to make syslog take 90% plus of CPU time.
37705
37706 The destination for Exim's logs is configured by setting LOG_FILE_PATH in
37707 &_Local/Makefile_& or by setting &%log_file_path%& in the runtime
37708 configuration. This latter string is expanded, so it can contain, for example,
37709 references to the host name:
37710 .code
37711 log_file_path = /var/log/$primary_hostname/exim_%slog
37712 .endd
37713 It is generally advisable, however, to set the string in &_Local/Makefile_&
37714 rather than at runtime, because then the setting is available right from the
37715 start of Exim's execution. Otherwise, if there's something it wants to log
37716 before it has read the configuration file (for example, an error in the
37717 configuration file) it will not use the path you want, and may not be able to
37718 log at all.
37719
37720 The value of LOG_FILE_PATH or &%log_file_path%& is a colon-separated
37721 list, currently limited to at most two items. This is one option where the
37722 facility for changing a list separator may not be used. The list must always be
37723 colon-separated. If an item in the list is &"syslog"& then syslog is used;
37724 otherwise the item must either be an absolute path, containing &`%s`& at the
37725 point where &"main"&, &"reject"&, or &"panic"& is to be inserted, or be empty,
37726 implying the use of a default path.
37727
37728 When Exim encounters an empty item in the list, it searches the list defined by
37729 LOG_FILE_PATH, and uses the first item it finds that is neither empty nor
37730 &"syslog"&. This means that an empty item in &%log_file_path%& can be used to
37731 mean &"use the path specified at build time"&. It no such item exists, log
37732 files are written in the &_log_& subdirectory of the spool directory. This is
37733 equivalent to the setting:
37734 .code
37735 log_file_path = $spool_directory/log/%slog
37736 .endd
37737 If you do not specify anything at build time or runtime,
37738 or if you unset the option at runtime (i.e. &`log_file_path = `&),
37739 that is where the logs are written.
37740
37741 A log file path may also contain &`%D`& or &`%M`& if datestamped log filenames
37742 are in use &-- see section &<<SECTdatlogfil>>& below.
37743
37744 Here are some examples of possible settings:
37745 .display
37746 &`LOG_FILE_PATH=syslog                    `& syslog only
37747 &`LOG_FILE_PATH=:syslog                   `& syslog and default path
37748 &`LOG_FILE_PATH=syslog : /usr/log/exim_%s `& syslog and specified path
37749 &`LOG_FILE_PATH=/usr/log/exim_%s          `& specified path only
37750 .endd
37751 If there are more than two paths in the list, the first is used and a panic
37752 error is logged.
37753
37754
37755
37756 .section "Logging to local files that are periodically &""cycled""&" "SECID285"
37757 .cindex "log" "cycling local files"
37758 .cindex "cycling logs"
37759 .cindex "&'exicyclog'&"
37760 .cindex "log" "local files; writing to"
37761 Some operating systems provide centralized and standardized methods for cycling
37762 log files. For those that do not, a utility script called &'exicyclog'& is
37763 provided (see section &<<SECTcyclogfil>>&). This renames and compresses the
37764 main and reject logs each time it is called. The maximum number of old logs to
37765 keep can be set. It is suggested this script is run as a daily &'cron'& job.
37766
37767 An Exim delivery process opens the main log when it first needs to write to it,
37768 and it keeps the file open in case subsequent entries are required &-- for
37769 example, if a number of different deliveries are being done for the same
37770 message. However, remote SMTP deliveries can take a long time, and this means
37771 that the file may be kept open long after it is renamed if &'exicyclog'& or
37772 something similar is being used to rename log files on a regular basis. To
37773 ensure that a switch of log files is noticed as soon as possible, Exim calls
37774 &[stat()]& on the main log's name before reusing an open file, and if the file
37775 does not exist, or its inode has changed, the old file is closed and Exim
37776 tries to open the main log from scratch. Thus, an old log file may remain open
37777 for quite some time, but no Exim processes should write to it once it has been
37778 renamed.
37779
37780
37781
37782 .section "Datestamped log files" "SECTdatlogfil"
37783 .cindex "log" "datestamped files"
37784 Instead of cycling the main and reject log files by renaming them
37785 periodically, some sites like to use files whose names contain a datestamp,
37786 for example, &_mainlog-20031225_&. The datestamp is in the form &_yyyymmdd_& or
37787 &_yyyymm_&. Exim has support for this way of working. It is enabled by setting
37788 the &%log_file_path%& option to a path that includes &`%D`& or &`%M`& at the
37789 point where the datestamp is required. For example:
37790 .code
37791 log_file_path = /var/spool/exim/log/%slog-%D
37792 log_file_path = /var/log/exim-%s-%D.log
37793 log_file_path = /var/spool/exim/log/%D-%slog
37794 log_file_path = /var/log/exim/%s.%M
37795 .endd
37796 As before, &`%s`& is replaced by &"main"& or &"reject"&; the following are
37797 examples of names generated by the above examples:
37798 .code
37799 /var/spool/exim/log/mainlog-20021225
37800 /var/log/exim-reject-20021225.log
37801 /var/spool/exim/log/20021225-mainlog
37802 /var/log/exim/main.200212
37803 .endd
37804 When this form of log file is specified, Exim automatically switches to new
37805 files at midnight. It does not make any attempt to compress old logs; you
37806 will need to write your own script if you require this. You should not
37807 run &'exicyclog'& with this form of logging.
37808
37809 The location of the panic log is also determined by &%log_file_path%&, but it
37810 is not datestamped, because rotation of the panic log does not make sense.
37811 When generating the name of the panic log, &`%D`& or &`%M`& are removed from
37812 the string. In addition, if it immediately follows a slash, a following
37813 non-alphanumeric character is removed; otherwise a preceding non-alphanumeric
37814 character is removed. Thus, the four examples above would give these panic
37815 log names:
37816 .code
37817 /var/spool/exim/log/paniclog
37818 /var/log/exim-panic.log
37819 /var/spool/exim/log/paniclog
37820 /var/log/exim/panic
37821 .endd
37822
37823
37824 .section "Logging to syslog" "SECID249"
37825 .cindex "log" "syslog; writing to"
37826 The use of syslog does not change what Exim logs or the format of its messages,
37827 except in one respect. If &%syslog_timestamp%& is set false, the timestamps on
37828 Exim's log lines are omitted when these lines are sent to syslog. Apart from
37829 that, the same strings are written to syslog as to log files. The syslog
37830 &"facility"& is set to LOG_MAIL, and the program name to &"exim"&
37831 by default, but you can change these by setting the &%syslog_facility%& and
37832 &%syslog_processname%& options, respectively. If Exim was compiled with
37833 SYSLOG_LOG_PID set in &_Local/Makefile_& (this is the default in
37834 &_src/EDITME_&), then, on systems that permit it (all except ULTRIX), the
37835 LOG_PID flag is set so that the &[syslog()]& call adds the pid as well as
37836 the time and host name to each line.
37837 The three log streams are mapped onto syslog priorities as follows:
37838
37839 .ilist
37840 &'mainlog'& is mapped to LOG_INFO
37841 .next
37842 &'rejectlog'& is mapped to LOG_NOTICE
37843 .next
37844 &'paniclog'& is mapped to LOG_ALERT
37845 .endlist
37846
37847 Many log lines are written to both &'mainlog'& and &'rejectlog'&, and some are
37848 written to both &'mainlog'& and &'paniclog'&, so there will be duplicates if
37849 these are routed by syslog to the same place. You can suppress this duplication
37850 by setting &%syslog_duplication%& false.
37851
37852 Exim's log lines can sometimes be very long, and some of its &'rejectlog'&
37853 entries contain multiple lines when headers are included. To cope with both
37854 these cases, entries written to syslog are split into separate &[syslog()]&
37855 calls at each internal newline, and also after a maximum of
37856 870 data characters. (This allows for a total syslog line length of 1024, when
37857 additions such as timestamps are added.) If you are running a syslog
37858 replacement that can handle lines longer than the 1024 characters allowed by
37859 RFC 3164, you should set
37860 .code
37861 SYSLOG_LONG_LINES=yes
37862 .endd
37863 in &_Local/Makefile_& before building Exim. That stops Exim from splitting long
37864 lines, but it still splits at internal newlines in &'reject'& log entries.
37865
37866 To make it easy to re-assemble split lines later, each component of a split
37867 entry starts with a string of the form [<&'n'&>/<&'m'&>] or [<&'n'&>\<&'m'&>]
37868 where <&'n'&> is the component number and <&'m'&> is the total number of
37869 components in the entry. The / delimiter is used when the line was split
37870 because it was too long; if it was split because of an internal newline, the \
37871 delimiter is used. For example, supposing the length limit to be 50 instead of
37872 870, the following would be the result of a typical rejection message to
37873 &'mainlog'& (LOG_INFO), each line in addition being preceded by the time, host
37874 name, and pid as added by syslog:
37875 .code
37876 [1/5] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected from
37877 [2/5]  [127.0.0.1] (ph10): syntax error in 'From' header
37878 [3/5]  when scanning for sender: missing or malformed lo
37879 [4/5] cal part in "<>" (envelope sender is <ph10@cam.exa
37880 [5/5] mple>)
37881 .endd
37882 The same error might cause the following lines to be written to &"rejectlog"&
37883 (LOG_NOTICE):
37884 .code
37885 [1/18] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected fro
37886 [2/18] m [127.0.0.1] (ph10): syntax error in 'From' head
37887 [3/18] er when scanning for sender: missing or malformed
37888 [4/18]  local part in "<>" (envelope sender is <ph10@cam
37889 [5\18] .example>)
37890 [6\18] Recipients: ph10@some.domain.cam.example
37891 [7\18] P Received: from [127.0.0.1] (ident=ph10)
37892 [8\18]        by xxxxx.cam.example with smtp (Exim 4.00)
37893 [9\18]        id 16RdAL-0006pc-00
37894 [10/18]        for ph10@cam.example; Mon, 16 Sep 2002 16:
37895 [11\18] 09:43 +0100
37896 [12\18] F From: <>
37897 [13\18]   Subject: this is a test header
37898 [18\18]   X-something: this is another header
37899 [15/18] I Message-Id: <E16RdAL-0006pc-00@xxxxx.cam.examp
37900 [16\18] le>
37901 [17\18] B Bcc:
37902 [18/18]   Date: Mon, 16 Sep 2002 16:09:43 +0100
37903 .endd
37904 Log lines that are neither too long nor contain newlines are written to syslog
37905 without modification.
37906
37907 If only syslog is being used, the Exim monitor is unable to provide a log tail
37908 display, unless syslog is routing &'mainlog'& to a file on the local host and
37909 the environment variable EXIMON_LOG_FILE_PATH is set to tell the monitor
37910 where it is.
37911
37912
37913
37914 .section "Log line flags" "SECID250"
37915 One line is written to the main log for each message received, and for each
37916 successful, unsuccessful, and delayed delivery. These lines can readily be
37917 picked out by the distinctive two-character flags that immediately follow the
37918 timestamp. The flags are:
37919 .display
37920 &`<=`&     message arrival
37921 &`(=`&     message fakereject
37922 &`=>`&     normal message delivery
37923 &`->`&     additional address in same delivery
37924 &`>>`&     cutthrough message delivery
37925 &`*>`&     delivery suppressed by &%-N%&
37926 &`**`&     delivery failed; address bounced
37927 &`==`&     delivery deferred; temporary problem
37928 .endd
37929
37930
37931 .section "Logging message reception" "SECID251"
37932 .cindex "log" "reception line"
37933 The format of the single-line entry in the main log that is written for every
37934 message received is shown in the basic example below, which is split over
37935 several lines in order to fit it on the page:
37936 .code
37937 2002-10-31 08:57:53 16ZCW1-0005MB-00 <= kryten@dwarf.fict.example
37938   H=mailer.fict.example [192.168.123.123] U=exim
37939   P=smtp S=5678 id=<incoming message id>
37940 .endd
37941 The address immediately following &"<="& is the envelope sender address. A
37942 bounce message is shown with the sender address &"<>"&, and if it is locally
37943 generated, this is followed by an item of the form
37944 .code
37945 R=<message id>
37946 .endd
37947 which is a reference to the message that caused the bounce to be sent.
37948
37949 .cindex "HELO"
37950 .cindex "EHLO"
37951 For messages from other hosts, the H and U fields identify the remote host and
37952 record the RFC 1413 identity of the user that sent the message, if one was
37953 received. The number given in square brackets is the IP address of the sending
37954 host. If there is a single, unparenthesized  host name in the H field, as
37955 above, it has been verified to correspond to the IP address (see the
37956 &%host_lookup%& option). If the name is in parentheses, it was the name quoted
37957 by the remote host in the SMTP HELO or EHLO command, and has not been
37958 verified. If verification yields a different name to that given for HELO or
37959 EHLO, the verified name appears first, followed by the HELO or EHLO
37960 name in parentheses.
37961
37962 Misconfigured hosts (and mail forgers) sometimes put an IP address, with or
37963 without brackets, in the HELO or EHLO command, leading to entries in
37964 the log containing text like these examples:
37965 .code
37966 H=(10.21.32.43) [192.168.8.34]
37967 H=([10.21.32.43]) [192.168.8.34]
37968 .endd
37969 This can be confusing. Only the final address in square brackets can be relied
37970 on.
37971
37972 For locally generated messages (that is, messages not received over TCP/IP),
37973 the H field is omitted, and the U field contains the login name of the caller
37974 of Exim.
37975
37976 .cindex "authentication" "logging"
37977 .cindex "AUTH" "logging"
37978 For all messages, the P field specifies the protocol used to receive the
37979 message. This is the value that is stored in &$received_protocol$&. In the case
37980 of incoming SMTP messages, the value indicates whether or not any SMTP
37981 extensions (ESMTP), encryption, or authentication were used. If the SMTP
37982 session was encrypted, there is an additional X field that records the cipher
37983 suite that was used.
37984
37985 .cindex log protocol
37986 The protocol is set to &"esmtpsa"& or &"esmtpa"& for messages received from
37987 hosts that have authenticated themselves using the SMTP AUTH command. The first
37988 value is used when the SMTP connection was encrypted (&"secure"&). In this case
37989 there is an additional item A= followed by the name of the authenticator that
37990 was used. If an authenticated identification was set up by the authenticator's
37991 &%server_set_id%& option, this is logged too, separated by a colon from the
37992 authenticator name.
37993
37994 .cindex "size" "of message"
37995 The id field records the existing message id, if present. The size of the
37996 received message is given by the S field. When the message is delivered,
37997 headers may be removed or added, so that the size of delivered copies of the
37998 message may not correspond with this value (and indeed may be different to each
37999 other).
38000
38001 The &%log_selector%& option can be used to request the logging of additional
38002 data when a message is received. See section &<<SECTlogselector>>& below.
38003
38004
38005
38006 .section "Logging deliveries" "SECID252"
38007 .cindex "log" "delivery line"
38008 The format of the single-line entry in the main log that is written for every
38009 delivery is shown in one of the examples below, for local and remote
38010 deliveries, respectively. Each example has been split into multiple lines in order
38011 to fit it on the page:
38012 .code
38013 2002-10-31 08:59:13 16ZCW1-0005MB-00 => marv
38014   <marv@hitch.fict.example> R=localuser T=local_delivery
38015 2002-10-31 09:00:10 16ZCW1-0005MB-00 =>
38016   monk@holistic.fict.example R=dnslookup T=remote_smtp
38017   H=holistic.fict.example [192.168.234.234]
38018 .endd
38019 For ordinary local deliveries, the original address is given in angle brackets
38020 after the final delivery address, which might be a pipe or a file. If
38021 intermediate address(es) exist between the original and the final address, the
38022 last of these is given in parentheses after the final address. The R and T
38023 fields record the router and transport that were used to process the address.
38024
38025 If SMTP AUTH was used for the delivery there is an additional item A=
38026 followed by the name of the authenticator that was used.
38027 If an authenticated identification was set up by the authenticator's &%client_set_id%&
38028 option, this is logged too, separated by a colon from the authenticator name.
38029
38030 If a shadow transport was run after a successful local delivery, the log line
38031 for the successful delivery has an item added on the end, of the form
38032 .display
38033 &`ST=<`&&'shadow transport name'&&`>`&
38034 .endd
38035 If the shadow transport did not succeed, the error message is put in
38036 parentheses afterwards.
38037
38038 .cindex "asterisk" "after IP address"
38039 When more than one address is included in a single delivery (for example, two
38040 SMTP RCPT commands in one transaction) the second and subsequent addresses are
38041 flagged with &`->`& instead of &`=>`&. When two or more messages are delivered
38042 down a single SMTP connection, an asterisk follows the IP address in the log
38043 lines for the second and subsequent messages.
38044 When two or more messages are delivered down a single TLS connection, the
38045 DNS and some TLS-related information logged for the first message delivered
38046 will not be present in the log lines for the second and subsequent messages.
38047 TLS cipher information is still available.
38048
38049 .cindex "delivery" "cutthrough; logging"
38050 .cindex "cutthrough" "logging"
38051 When delivery is done in cutthrough mode it is flagged with &`>>`& and the log
38052 line precedes the reception line, since cutthrough waits for a possible
38053 rejection from the destination in case it can reject the sourced item.
38054
38055 The generation of a reply message by a filter file gets logged as a
38056 &"delivery"& to the addressee, preceded by &">"&.
38057
38058 The &%log_selector%& option can be used to request the logging of additional
38059 data when a message is delivered. See section &<<SECTlogselector>>& below.
38060
38061
38062 .section "Discarded deliveries" "SECID253"
38063 .cindex "discarded messages"
38064 .cindex "message" "discarded"
38065 .cindex "delivery" "discarded; logging"
38066 When a message is discarded as a result of the command &"seen finish"& being
38067 obeyed in a filter file which generates no deliveries, a log entry of the form
38068 .code
38069 2002-12-10 00:50:49 16auJc-0001UB-00 => discarded
38070   <low.club@bridge.example> R=userforward
38071 .endd
38072 is written, to record why no deliveries are logged. When a message is discarded
38073 because it is aliased to &":blackhole:"& the log line is like this:
38074 .code
38075 1999-03-02 09:44:33 10HmaX-0005vi-00 => :blackhole:
38076   <hole@nowhere.example> R=blackhole_router
38077 .endd
38078
38079
38080 .section "Deferred deliveries" "SECID254"
38081 When a delivery is deferred, a line of the following form is logged:
38082 .code
38083 2002-12-19 16:20:23 16aiQz-0002Q5-00 == marvin@endrest.example
38084   R=dnslookup T=smtp defer (146): Connection refused
38085 .endd
38086 In the case of remote deliveries, the error is the one that was given for the
38087 last IP address that was tried. Details of individual SMTP failures are also
38088 written to the log, so the above line would be preceded by something like
38089 .code
38090 2002-12-19 16:20:23 16aiQz-0002Q5-00 Failed to connect to
38091   mail1.endrest.example [192.168.239.239]: Connection refused
38092 .endd
38093 When a deferred address is skipped because its retry time has not been reached,
38094 a message is written to the log, but this can be suppressed by setting an
38095 appropriate value in &%log_selector%&.
38096
38097
38098
38099 .section "Delivery failures" "SECID255"
38100 .cindex "delivery" "failure; logging"
38101 If a delivery fails because an address cannot be routed, a line of the
38102 following form is logged:
38103 .code
38104 1995-12-19 16:20:23 0tRiQz-0002Q5-00 ** jim@trek99.example
38105   <jim@trek99.example>: unknown mail domain
38106 .endd
38107 If a delivery fails at transport time, the router and transport are shown, and
38108 the response from the remote host is included, as in this example:
38109 .code
38110 2002-07-11 07:14:17 17SXDU-000189-00 ** ace400@pb.example
38111   R=dnslookup T=remote_smtp: SMTP error from remote mailer
38112   after pipelined RCPT TO:<ace400@pb.example>: host
38113   pbmail3.py.example [192.168.63.111]: 553 5.3.0
38114   <ace400@pb.example>...Addressee unknown
38115 .endd
38116 The word &"pipelined"& indicates that the SMTP PIPELINING extension was being
38117 used. See &%hosts_avoid_esmtp%& in the &(smtp)& transport for a way of
38118 disabling PIPELINING. The log lines for all forms of delivery failure are
38119 flagged with &`**`&.
38120
38121
38122
38123 .section "Fake deliveries" "SECID256"
38124 .cindex "delivery" "fake; logging"
38125 If a delivery does not actually take place because the &%-N%& option has been
38126 used to suppress it, a normal delivery line is written to the log, except that
38127 &"=>"& is replaced by &"*>"&.
38128
38129
38130
38131 .section "Completion" "SECID257"
38132 A line of the form
38133 .code
38134 2002-10-31 09:00:11 16ZCW1-0005MB-00 Completed
38135 .endd
38136 is written to the main log when a message is about to be removed from the spool
38137 at the end of its processing.
38138
38139
38140
38141
38142 .section "Summary of Fields in Log Lines" "SECID258"
38143 .cindex "log" "summary of fields"
38144 A summary of the field identifiers that are used in log lines is shown in
38145 the following table:
38146 .display
38147 &`A   `&        authenticator name (and optional id and sender)
38148 &`C   `&        SMTP confirmation on delivery
38149 &`    `&        command list for &"no mail in SMTP session"&
38150 &`CV  `&        certificate verification status
38151 &`D   `&        duration of &"no mail in SMTP session"&
38152 &`DKIM`&        domain verified in incoming message
38153 &`DN  `&        distinguished name from peer certificate
38154 &`DS  `&        DNSSEC secured lookups
38155 &`DT  `&        on &`=>`&, &'=='& and &'**'& lines: time taken for, or to attempt, a delivery
38156 &`F   `&        sender address (on delivery lines)
38157 &`H   `&        host name and IP address
38158 &`I   `&        local interface used
38159 &`id  `&        message id (from header) for incoming message
38160 &`K   `&        CHUNKING extension used
38161 &`L   `&        on &`<=`& and &`=>`& lines: PIPELINING extension used
38162 &`M8S `&        8BITMIME status for incoming message
38163 &`P   `&        on &`<=`& lines: protocol used
38164 &`    `&        on &`=>`& and &`**`& lines: return path
38165 &`PRDR`&        PRDR extension used
38166 &`PRX `&        on &`<=`& and &`=>`& lines: proxy address
38167 &`Q   `&        alternate queue name
38168 &`QT  `&        on &`=>`& lines: time spent on queue so far
38169 &`    `&        on &"Completed"& lines: time spent on queue
38170 &`R   `&        on &`<=`& lines: reference for local bounce
38171 &`    `&        on &`=>`&  &`>>`& &`**`& and &`==`& lines: router name
38172 &`RT  `&        on &`<=`& lines: time taken for reception
38173 &`S   `&        size of message in bytes
38174 &`SNI `&        server name indication from TLS client hello
38175 &`ST  `&        shadow transport name
38176 &`T   `&        on &`<=`& lines: message subject (topic)
38177 &`TFO `&        connection took advantage of TCP Fast Open
38178 &`    `&        on &`=>`& &`**`& and &`==`& lines: transport name
38179 &`U   `&        local user or RFC 1413 identity
38180 &`X   `&        TLS cipher suite
38181 .endd
38182
38183
38184 .section "Other log entries" "SECID259"
38185 Various other types of log entry are written from time to time. Most should be
38186 self-explanatory. Among the more common are:
38187
38188 .ilist
38189 .cindex "retry" "time not reached"
38190 &'retry time not reached'&&~&~An address previously suffered a temporary error
38191 during routing or local delivery, and the time to retry has not yet arrived.
38192 This message is not written to an individual message log file unless it happens
38193 during the first delivery attempt.
38194 .next
38195 &'retry time not reached for any host'&&~&~An address previously suffered
38196 temporary errors during remote delivery, and the retry time has not yet arrived
38197 for any of the hosts to which it is routed.
38198 .next
38199 .cindex "spool directory" "file locked"
38200 &'spool file locked'&&~&~An attempt to deliver a message cannot proceed because
38201 some other Exim process is already working on the message. This can be quite
38202 common if queue running processes are started at frequent intervals. The
38203 &'exiwhat'& utility script can be used to find out what Exim processes are
38204 doing.
38205 .next
38206 .cindex "error" "ignored"
38207 &'error ignored'&&~&~There are several circumstances that give rise to this
38208 message:
38209 .olist
38210 Exim failed to deliver a bounce message whose age was greater than
38211 &%ignore_bounce_errors_after%&. The bounce was discarded.
38212 .next
38213 A filter file set up a delivery using the &"noerror"& option, and the delivery
38214 failed. The delivery was discarded.
38215 .next
38216 A delivery set up by a router configured with
38217 . ==== As this is a nested list, any displays it contains must be indented
38218 . ==== as otherwise they are too far to the left.
38219 .code
38220     errors_to = <>
38221 .endd
38222 failed. The delivery was discarded.
38223 .endlist olist
38224 .next
38225 .cindex DKIM "log line"
38226 &'DKIM: d='&&~&~Verbose results of a DKIM verification attempt, if enabled for
38227 logging and the message has a DKIM signature header.
38228 .endlist ilist
38229
38230
38231
38232
38233
38234 .section "Reducing or increasing what is logged" "SECTlogselector"
38235 .cindex "log" "selectors"
38236 By setting the &%log_selector%& global option, you can disable some of Exim's
38237 default logging, or you can request additional logging. The value of
38238 &%log_selector%& is made up of names preceded by plus or minus characters. For
38239 example:
38240 .code
38241 log_selector = +arguments -retry_defer
38242 .endd
38243 The list of optional log items is in the following table, with the default
38244 selection marked by asterisks:
38245 .display
38246 &` 8bitmime                   `&  received 8BITMIME status
38247 &`*acl_warn_skipped           `&  skipped &%warn%& statement in ACL
38248 &` address_rewrite            `&  address rewriting
38249 &` all_parents                `&  all parents in => lines
38250 &` arguments                  `&  command line arguments
38251 &`*connection_reject          `&  connection rejections
38252 &`*delay_delivery             `&  immediate delivery delayed
38253 &` deliver_time               `&  time taken to attempt delivery
38254 &` delivery_size              `&  add &`S=`&&'nnn'& to => lines
38255 &`*dkim                       `&  DKIM verified domain on <= lines
38256 &` dkim_verbose               `&  separate full DKIM verification result line, per signature
38257 &`*dnslist_defer              `&  defers of DNS list (aka RBL) lookups
38258 &` dnssec                     `&  DNSSEC secured lookups
38259 &`*etrn                       `&  ETRN commands
38260 &`*host_lookup_failed         `&  as it says
38261 &` ident_timeout              `&  timeout for ident connection
38262 &` incoming_interface         `&  local interface on <= and => lines
38263 &` incoming_port              `&  remote port on <= lines
38264 &`*lost_incoming_connection   `&  as it says (includes timeouts)
38265 &` millisec                   `&  millisecond timestamps and RT,QT,DT,D times
38266 &`*msg_id                     `&  on <= lines, Message-ID: header value
38267 &` msg_id_created             `&  on <= lines, Message-ID: header value when one had to be added
38268 &` outgoing_interface         `&  local interface on => lines
38269 &` outgoing_port              `&  add remote port to => lines
38270 &`*queue_run                  `&  start and end queue runs
38271 &` queue_time                 `&  time on queue for one recipient
38272 &` queue_time_overall         `&  time on queue for whole message
38273 &` pid                        `&  Exim process id
38274 &` pipelining                 `&  PIPELINING use, on <= and => lines
38275 &` proxy                      `&  proxy address on <= and => lines
38276 &` receive_time               `&  time taken to receive message
38277 &` received_recipients        `&  recipients on <= lines
38278 &` received_sender            `&  sender on <= lines
38279 &`*rejected_header            `&  header contents on reject log
38280 &`*retry_defer                `&  &"retry time not reached"&
38281 &` return_path_on_delivery    `&  put return path on => and ** lines
38282 &` sender_on_delivery         `&  add sender to => lines
38283 &`*sender_verify_fail         `&  sender verification failures
38284 &`*size_reject                `&  rejection because too big
38285 &`*skip_delivery              `&  delivery skipped in a queue run
38286 &`*smtp_confirmation          `&  SMTP confirmation on => lines
38287 &` smtp_connection            `&  incoming SMTP connections
38288 &` smtp_incomplete_transaction`&  incomplete SMTP transactions
38289 &` smtp_mailauth              `&  AUTH argument to MAIL commands
38290 &` smtp_no_mail               `&  session with no MAIL commands
38291 &` smtp_protocol_error        `&  SMTP protocol errors
38292 &` smtp_syntax_error          `&  SMTP syntax errors
38293 &` subject                    `&  contents of &'Subject:'& on <= lines
38294 &`*tls_certificate_verified   `&  certificate verification status
38295 &`*tls_cipher                 `&  TLS cipher suite on <= and => lines
38296 &` tls_peerdn                 `&  TLS peer DN on <= and => lines
38297 &` tls_resumption             `&  append * to cipher field
38298 &` tls_sni                    `&  TLS SNI on <= lines
38299 &` unknown_in_list            `&  DNS lookup failed in list match
38300
38301 &` all                        `&  all of the above
38302 .endd
38303 See also the &%slow_lookup_log%& main configuration option,
38304 section &<<SECID99>>&
38305
38306 More details on each of these items follows:
38307
38308 .ilist
38309 .cindex "8BITMIME"
38310 .cindex "log" "8BITMIME"
38311 &%8bitmime%&: This causes Exim to log any 8BITMIME status of received messages,
38312 which may help in tracking down interoperability issues with ancient MTAs
38313 that are not 8bit clean.  This is added to the &"<="& line, tagged with
38314 &`M8S=`& and a value of &`0`&, &`7`& or &`8`&, corresponding to "not given",
38315 &`7BIT`& and &`8BITMIME`& respectively.
38316 .next
38317 .cindex "&%warn%& ACL verb" "log when skipping"
38318 &%acl_warn_skipped%&: When an ACL &%warn%& statement is skipped because one of
38319 its conditions cannot be evaluated, a log line to this effect is written if
38320 this log selector is set.
38321 .next
38322 .cindex "log" "rewriting"
38323 .cindex "rewriting" "logging"
38324 &%address_rewrite%&: This applies both to global rewrites and per-transport
38325 rewrites, but not to rewrites in filters run as an unprivileged user (because
38326 such users cannot access the log).
38327 .next
38328 .cindex "log" "full parentage"
38329 &%all_parents%&: Normally only the original and final addresses are logged on
38330 delivery lines; with this selector, intermediate parents are given in
38331 parentheses between them.
38332 .next
38333 .cindex "log" "Exim arguments"
38334 .cindex "Exim arguments, logging"
38335 &%arguments%&: This causes Exim to write the arguments with which it was called
38336 to the main log, preceded by the current working directory. This is a debugging
38337 feature, added to make it easier to find out how certain MUAs call
38338 &_/usr/sbin/sendmail_&. The logging does not happen if Exim has given up root
38339 privilege because it was called with the &%-C%& or &%-D%& options. Arguments
38340 that are empty or that contain white space are quoted. Non-printing characters
38341 are shown as escape sequences. This facility cannot log unrecognized arguments,
38342 because the arguments are checked before the configuration file is read. The
38343 only way to log such cases is to interpose a script such as &_util/logargs.sh_&
38344 between the caller and Exim.
38345 .next
38346 .cindex "log" "connection rejections"
38347 &%connection_reject%&: A log entry is written whenever an incoming SMTP
38348 connection is rejected, for whatever reason.
38349 .next
38350 .cindex "log" "delayed delivery"
38351 .cindex "delayed delivery, logging"
38352 &%delay_delivery%&: A log entry is written whenever a delivery process is not
38353 started for an incoming message because the load is too high or too many
38354 messages were received on one connection. Logging does not occur if no delivery
38355 process is started because &%queue_only%& is set or &%-odq%& was used.
38356 .next
38357 .cindex "log" "delivery duration"
38358 &%deliver_time%&: For each delivery, the amount of real time it has taken to
38359 perform the actual delivery is logged as DT=<&'time'&>, for example, &`DT=1s`&.
38360 If millisecond logging is enabled, short times will be shown with greater
38361 precision, eg. &`DT=0.304s`&.
38362 .next
38363 .cindex "log" "message size on delivery"
38364 .cindex "size" "of message"
38365 &%delivery_size%&: For each delivery, the size of message delivered is added to
38366 the &"=>"& line, tagged with S=.
38367 .next
38368 .cindex log "DKIM verification"
38369 .cindex DKIM "verification logging"
38370 &%dkim%&: For message acceptance log lines, when an DKIM signature in the header
38371 verifies successfully a tag of DKIM is added, with one of the verified domains.
38372 .next
38373 .cindex log "DKIM verification"
38374 .cindex DKIM "verification logging"
38375 &%dkim_verbose%&: A log entry is written for each attempted DKIM verification.
38376 .next
38377 .cindex "log" "dnslist defer"
38378 .cindex "DNS list" "logging defer"
38379 .cindex "black list (DNS)"
38380 &%dnslist_defer%&: A log entry is written if an attempt to look up a host in a
38381 DNS black list suffers a temporary error.
38382 .next
38383 .cindex log dnssec
38384 .cindex dnssec logging
38385 &%dnssec%&: For message acceptance and (attempted) delivery log lines, when
38386 dns lookups gave secure results a tag of DS is added.
38387 For acceptance this covers the reverse and forward lookups for host name verification.
38388 It does not cover helo-name verification.
38389 For delivery this covers the SRV, MX, A and/or AAAA lookups.
38390 .next
38391 .cindex "log" "ETRN commands"
38392 .cindex "ETRN" "logging"
38393 &%etrn%&: Every valid ETRN command that is received is logged, before the ACL
38394 is run to determine whether or not it is actually accepted. An invalid ETRN
38395 command, or one received within a message transaction is not logged by this
38396 selector (see &%smtp_syntax_error%& and &%smtp_protocol_error%&).
38397 .next
38398 .cindex "log" "host lookup failure"
38399 &%host_lookup_failed%&: When a lookup of a host's IP addresses fails to find
38400 any addresses, or when a lookup of an IP address fails to find a host name, a
38401 log line is written. This logging does not apply to direct DNS lookups when
38402 routing email addresses, but it does apply to &"byname"& lookups.
38403 .next
38404 .cindex "log" "ident timeout"
38405 .cindex "RFC 1413" "logging timeout"
38406 &%ident_timeout%&: A log line is written whenever an attempt to connect to a
38407 client's ident port times out.
38408 .next
38409 .cindex "log" "incoming interface"
38410 .cindex "log" "local interface"
38411 .cindex "log" "local address and port"
38412 .cindex "TCP/IP" "logging local address and port"
38413 .cindex "interface" "logging"
38414 &%incoming_interface%&: The interface on which a message was received is added
38415 to the &"<="& line as an IP address in square brackets, tagged by I= and
38416 followed by a colon and the port number. The local interface and port are also
38417 added to other SMTP log lines, for example, &"SMTP connection from"&, to
38418 rejection lines, and (despite the name) to outgoing &"=>"& and &"->"& lines.
38419 The latter can be disabled by turning off the &%outgoing_interface%& option.
38420 .next
38421 .cindex log "incoming proxy address"
38422 .cindex proxy "logging proxy address"
38423 .cindex "TCP/IP" "logging proxy address"
38424 &%proxy%&: The internal (closest to the system running Exim) IP address
38425 of the proxy, tagged by PRX=, on the &"<="& line for a message accepted
38426 on a proxied connection
38427 or the &"=>"& line for a message delivered on a proxied connection.
38428 See &<<SECTproxyInbound>>& for more information.
38429 .next
38430 .cindex "log" "incoming remote port"
38431 .cindex "port" "logging remote"
38432 .cindex "TCP/IP" "logging incoming remote port"
38433 .vindex "&$sender_fullhost$&"
38434 .vindex "&$sender_rcvhost$&"
38435 &%incoming_port%&: The remote port number from which a message was received is
38436 added to log entries and &'Received:'& header lines, following the IP address
38437 in square brackets, and separated from it by a colon. This is implemented by
38438 changing the value that is put in the &$sender_fullhost$& and
38439 &$sender_rcvhost$& variables. Recording the remote port number has become more
38440 important with the widening use of NAT (see RFC 2505).
38441 .next
38442 .cindex "log" "dropped connection"
38443 &%lost_incoming_connection%&: A log line is written when an incoming SMTP
38444 connection is unexpectedly dropped.
38445 .next
38446 .cindex "log" "millisecond timestamps"
38447 .cindex millisecond logging
38448 .cindex timestamps "millisecond, in logs"
38449 &%millisec%&: Timestamps have a period and three decimal places of finer granularity
38450 appended to the seconds value.
38451 .next
38452 .cindex "log" "message id"
38453 &%msg_id%&: The value of the Message-ID: header.
38454 .next
38455 &%msg_id_created%&: The value of the Message-ID: header, when one had to be created.
38456 This will be either because the message is a bounce, or was submitted locally
38457 (submission mode) without one.
38458 The field identifier will have an asterix appended: &"id*="&.
38459 .next
38460 .cindex "log" "outgoing interface"
38461 .cindex "log" "local interface"
38462 .cindex "log" "local address and port"
38463 .cindex "TCP/IP" "logging local address and port"
38464 .cindex "interface" "logging"
38465 &%outgoing_interface%&: If &%incoming_interface%& is turned on, then the
38466 interface on which a message was sent is added to delivery lines as an I= tag
38467 followed by IP address in square brackets. You can disable this by turning
38468 off the &%outgoing_interface%& option.
38469 .next
38470 .cindex "log" "outgoing remote port"
38471 .cindex "port" "logging outgoing remote"
38472 .cindex "TCP/IP" "logging outgoing remote port"
38473 &%outgoing_port%&: The remote port number is added to delivery log lines (those
38474 containing => tags) following the IP address.
38475 The local port is also added if &%incoming_interface%& and
38476 &%outgoing_interface%& are both enabled.
38477 This option is not included in the default setting, because for most ordinary
38478 configurations, the remote port number is always 25 (the SMTP port), and the
38479 local port is a random ephemeral port.
38480 .next
38481 .cindex "log" "process ids in"
38482 .cindex "pid (process id)" "in log lines"
38483 &%pid%&: The current process id is added to every log line, in square brackets,
38484 immediately after the time and date.
38485 .next
38486 .cindex log pipelining
38487 .cindex pipelining "logging outgoing"
38488 &%pipelining%&: A field is added to delivery and accept
38489 log lines when the ESMTP PIPELINING extension was used.
38490 The field is a single "L".
38491
38492 On accept lines, where PIPELINING was offered but not used by the client,
38493 the field has a minus appended.
38494
38495 .cindex "pipelining" "early connection"
38496 If Exim is built with the SUPPORT_PIPE_CONNECT build option
38497 accept "L" fields have a period appended if the feature was
38498 offered but not used, or an asterisk appended if used.
38499 Delivery "L" fields have an asterisk appended if used.
38500
38501 .next
38502 .cindex "log" "queue run"
38503 .cindex "queue runner" "logging"
38504 &%queue_run%&: The start and end of every queue run are logged.
38505 .next
38506 .cindex "log" "queue time"
38507 &%queue_time%&: The amount of time the message has been in the queue on the
38508 local host is logged as QT=<&'time'&> on delivery (&`=>`&) lines, for example,
38509 &`QT=3m45s`&. The clock starts when Exim starts to receive the message, so it
38510 includes reception time as well as the delivery time for the current address.
38511 This means that it may be longer than the difference between the arrival and
38512 delivery log line times, because the arrival log line is not written until the
38513 message has been successfully received.
38514 If millisecond logging is enabled, short times will be shown with greater
38515 precision, eg. &`QT=1.578s`&.
38516 .next
38517 &%queue_time_overall%&: The amount of time the message has been in the queue on
38518 the local host is logged as QT=<&'time'&> on &"Completed"& lines, for
38519 example, &`QT=3m45s`&. The clock starts when Exim starts to receive the
38520 message, so it includes reception time as well as the total delivery time.
38521 .next
38522 .cindex "log" "receive duration"
38523 &%receive_time%&: For each message, the amount of real time it has taken to
38524 perform the reception is logged as RT=<&'time'&>, for example, &`RT=1s`&.
38525 If millisecond logging is enabled, short times will be shown with greater
38526 precision, eg. &`RT=0.204s`&.
38527 .next
38528 .cindex "log" "recipients"
38529 &%received_recipients%&: The recipients of a message are listed in the main log
38530 as soon as the message is received. The list appears at the end of the log line
38531 that is written when a message is received, preceded by the word &"for"&. The
38532 addresses are listed after they have been qualified, but before any rewriting
38533 has taken place.
38534 Recipients that were discarded by an ACL for MAIL or RCPT do not appear
38535 in the list.
38536 .next
38537 .cindex "log" "sender reception"
38538 &%received_sender%&: The unrewritten original sender of a message is added to
38539 the end of the log line that records the message's arrival, after the word
38540 &"from"& (before the recipients if &%received_recipients%& is also set).
38541 .next
38542 .cindex "log" "header lines for rejection"
38543 &%rejected_header%&: If a message's header has been received at the time a
38544 rejection is written to the reject log, the complete header is added to the
38545 log. Header logging can be turned off individually for messages that are
38546 rejected by the &[local_scan()]& function (see section &<<SECTapiforloc>>&).
38547 .next
38548 .cindex "log" "retry defer"
38549 &%retry_defer%&: A log line is written if a delivery is deferred because a
38550 retry time has not yet been reached. However, this &"retry time not reached"&
38551 message is always omitted from individual message logs after the first delivery
38552 attempt.
38553 .next
38554 .cindex "log" "return path"
38555 &%return_path_on_delivery%&: The return path that is being transmitted with
38556 the message is included in delivery and bounce lines, using the tag P=.
38557 This is omitted if no delivery actually happens, for example, if routing fails,
38558 or if delivery is to &_/dev/null_& or to &`:blackhole:`&.
38559 .next
38560 .cindex "log" "sender on delivery"
38561 &%sender_on_delivery%&: The message's sender address is added to every delivery
38562 and bounce line, tagged by F= (for &"from"&).
38563 This is the original sender that was received with the message; it is not
38564 necessarily the same as the outgoing return path.
38565 .next
38566 .cindex "log" "sender verify failure"
38567 &%sender_verify_fail%&: If this selector is unset, the separate log line that
38568 gives details of a sender verification failure is not written. Log lines for
38569 the rejection of SMTP commands contain just &"sender verify failed"&, so some
38570 detail is lost.
38571 .next
38572 .cindex "log" "size rejection"
38573 &%size_reject%&: A log line is written whenever a message is rejected because
38574 it is too big.
38575 .next
38576 .cindex "log" "frozen messages; skipped"
38577 .cindex "frozen messages" "logging skipping"
38578 &%skip_delivery%&: A log line is written whenever a message is skipped during a
38579 queue run because it is frozen or because another process is already delivering
38580 it.
38581 .cindex "&""spool file is locked""&"
38582 The message that is written is &"spool file is locked"&.
38583 .next
38584 .cindex "log" "smtp confirmation"
38585 .cindex "SMTP" "logging confirmation"
38586 .cindex "LMTP" "logging confirmation"
38587 &%smtp_confirmation%&: The response to the final &"."& in the SMTP or LMTP dialogue for
38588 outgoing messages is added to delivery log lines in the form &`C=`&<&'text'&>.
38589 A number of MTAs (including Exim) return an identifying string in this
38590 response.
38591 .next
38592 .cindex "log" "SMTP connections"
38593 .cindex "SMTP" "logging connections"
38594 &%smtp_connection%&: A log line is written whenever an incoming SMTP connection is
38595 established or closed, unless the connection is from a host that matches
38596 &%hosts_connection_nolog%&. (In contrast, &%lost_incoming_connection%& applies
38597 only when the closure is unexpected.) This applies to connections from local
38598 processes that use &%-bs%& as well as to TCP/IP connections. If a connection is
38599 dropped in the middle of a message, a log line is always written, whether or
38600 not this selector is set, but otherwise nothing is written at the start and end
38601 of connections unless this selector is enabled.
38602
38603 For TCP/IP connections to an Exim daemon, the current number of connections is
38604 included in the log message for each new connection, but note that the count is
38605 reset if the daemon is restarted.
38606 Also, because connections are closed (and the closure is logged) in
38607 subprocesses, the count may not include connections that have been closed but
38608 whose termination the daemon has not yet noticed. Thus, while it is possible to
38609 match up the opening and closing of connections in the log, the value of the
38610 logged counts may not be entirely accurate.
38611 .next
38612 .cindex "log" "SMTP transaction; incomplete"
38613 .cindex "SMTP" "logging incomplete transactions"
38614 &%smtp_incomplete_transaction%&: When a mail transaction is aborted by
38615 RSET, QUIT, loss of connection, or otherwise, the incident is logged,
38616 and the message sender plus any accepted recipients are included in the log
38617 line. This can provide evidence of dictionary attacks.
38618 .next
38619 .cindex "log" "non-MAIL SMTP sessions"
38620 .cindex "MAIL" "logging session without"
38621 &%smtp_no_mail%&: A line is written to the main log whenever an accepted SMTP
38622 connection terminates without having issued a MAIL command. This includes both
38623 the case when the connection is dropped, and the case when QUIT is used. It
38624 does not include cases where the connection is rejected right at the start (by
38625 an ACL, or because there are too many connections, or whatever). These cases
38626 already have their own log lines.
38627
38628 The log line that is written contains the identity of the client in the usual
38629 way, followed by D= and a time, which records the duration of the connection.
38630 If the connection was authenticated, this fact is logged exactly as it is for
38631 an incoming message, with an A= item. If the connection was encrypted, CV=,
38632 DN=, and X= items may appear as they do for an incoming message, controlled by
38633 the same logging options.
38634
38635 Finally, if any SMTP commands were issued during the connection, a C= item
38636 is added to the line, listing the commands that were used. For example,
38637 .code
38638 C=EHLO,QUIT
38639 .endd
38640 shows that the client issued QUIT straight after EHLO. If there were fewer
38641 than 20 commands, they are all listed. If there were more than 20 commands,
38642 the last 20 are listed, preceded by &"..."&. However, with the default
38643 setting of 10 for &%smtp_accept_max_nonmail%&, the connection will in any case
38644 have been aborted before 20 non-mail commands are processed.
38645 .next
38646 &%smtp_mailauth%&: A third subfield with the authenticated sender,
38647 colon-separated, is appended to the A= item for a message arrival or delivery
38648 log line, if an AUTH argument to the SMTP MAIL command (see &<<SECTauthparamail>>&)
38649 was accepted or used.
38650 .next
38651 .cindex "log" "SMTP protocol error"
38652 .cindex "SMTP" "logging protocol error"
38653 &%smtp_protocol_error%&: A log line is written for every SMTP protocol error
38654 encountered. Exim does not have perfect detection of all protocol errors
38655 because of transmission delays and the use of pipelining. If PIPELINING has
38656 been advertised to a client, an Exim server assumes that the client will use
38657 it, and therefore it does not count &"expected"& errors (for example, RCPT
38658 received after rejecting MAIL) as protocol errors.
38659 .next
38660 .cindex "SMTP" "logging syntax errors"
38661 .cindex "SMTP" "syntax errors; logging"
38662 .cindex "SMTP" "unknown command; logging"
38663 .cindex "log" "unknown SMTP command"
38664 .cindex "log" "SMTP syntax error"
38665 &%smtp_syntax_error%&: A log line is written for every SMTP syntax error
38666 encountered. An unrecognized command is treated as a syntax error. For an
38667 external connection, the host identity is given; for an internal connection
38668 using &%-bs%& the sender identification (normally the calling user) is given.
38669 .next
38670 .cindex "log" "subject"
38671 .cindex "subject, logging"
38672 &%subject%&: The subject of the message is added to the arrival log line,
38673 preceded by &"T="& (T for &"topic"&, since S is already used for &"size"&).
38674 Any MIME &"words"& in the subject are decoded. The &%print_topbitchars%& option
38675 specifies whether characters with values greater than 127 should be logged
38676 unchanged, or whether they should be rendered as escape sequences.
38677 .next
38678 .cindex "log" "certificate verification"
38679 .cindex log DANE
38680 .cindex DANE logging
38681 &%tls_certificate_verified%&: An extra item is added to <= and => log lines
38682 when TLS is in use. The item is &`CV=yes`& if the peer's certificate was
38683 verified
38684 using a CA trust anchor,
38685 &`CA=dane`& if using a DNS trust anchor,
38686 and &`CV=no`& if not.
38687 .next
38688 .cindex "log" "TLS cipher"
38689 .cindex "TLS" "logging cipher"
38690 &%tls_cipher%&: When a message is sent or received over an encrypted
38691 connection, the cipher suite used is added to the log line, preceded by X=.
38692 .next
38693 .cindex "log" "TLS peer DN"
38694 .cindex "TLS" "logging peer DN"
38695 &%tls_peerdn%&: When a message is sent or received over an encrypted
38696 connection, and a certificate is supplied by the remote host, the peer DN is
38697 added to the log line, preceded by DN=.
38698 .next
38699 .cindex "log" "TLS resumption"
38700 .cindex "TLS" "logging session resumption"
38701 .new
38702 &%tls_resumption%&: When a message is sent or received over an encrypted
38703 connection and the TLS session resumed one used on a previous TCP connection,
38704 an asterisk is appended to the X= cipher field in the log line.
38705 .wen
38706 .next
38707 .cindex "log" "TLS SNI"
38708 .cindex "TLS" "logging SNI"
38709 .cindex SNI logging
38710 &%tls_sni%&: When a message is received over an encrypted connection, and
38711 the remote host provided the Server Name Indication extension, the SNI is
38712 added to the log line, preceded by SNI=.
38713 .next
38714 .cindex "log" "DNS failure in list"
38715 &%unknown_in_list%&: This setting causes a log entry to be written when the
38716 result of a list match is failure because a DNS lookup failed.
38717 .endlist
38718
38719
38720 .section "Message log" "SECID260"
38721 .cindex "message" "log file for"
38722 .cindex "log" "message log; description of"
38723 .cindex "&_msglog_& directory"
38724 .oindex "&%preserve_message_logs%&"
38725 In addition to the general log files, Exim writes a log file for each message
38726 that it handles. The names of these per-message logs are the message ids, and
38727 they are kept in the &_msglog_& sub-directory of the spool directory. Each
38728 message log contains copies of the log lines that apply to the message. This
38729 makes it easier to inspect the status of an individual message without having
38730 to search the main log. A message log is deleted when processing of the message
38731 is complete, unless &%preserve_message_logs%& is set, but this should be used
38732 only with great care because they can fill up your disk very quickly.
38733
38734 On a heavily loaded system, it may be desirable to disable the use of
38735 per-message logs, in order to reduce disk I/O. This can be done by setting the
38736 &%message_logs%& option false.
38737 .ecindex IIDloggen
38738
38739
38740
38741
38742 . ////////////////////////////////////////////////////////////////////////////
38743 . ////////////////////////////////////////////////////////////////////////////
38744
38745 .chapter "Exim utilities" "CHAPutils"
38746 .scindex IIDutils "utilities"
38747 A number of utility scripts and programs are supplied with Exim and are
38748 described in this chapter. There is also the Exim Monitor, which is covered in
38749 the next chapter. The utilities described here are:
38750
38751 .itable none 0 0 3  7* left  15* left  40* left
38752 .irow &<<SECTfinoutwha>>&     &'exiwhat'&       &&&
38753   "list what Exim processes are doing"
38754 .irow &<<SECTgreptheque>>&    &'exiqgrep'&      "grep the queue"
38755 .irow &<<SECTsumtheque>>&     &'exiqsumm'&      "summarize the queue"
38756 .irow &<<SECTextspeinf>>&     &'exigrep'&       "search the main log"
38757 .irow &<<SECTexipick>>&       &'exipick'&       "select messages on &&&
38758                                                 various criteria"
38759 .irow &<<SECTcyclogfil>>&     &'exicyclog'&     "cycle (rotate) log files"
38760 .irow &<<SECTmailstat>>&      &'eximstats'&     &&&
38761   "extract statistics from the log"
38762 .irow &<<SECTcheckaccess>>&   &'exim_checkaccess'& &&&
38763   "check address acceptance from given IP"
38764 .irow &<<SECTdbmbuild>>&      &'exim_dbmbuild'& "build a DBM file"
38765 .irow &<<SECTfinindret>>&     &'exinext'&       "extract retry information"
38766 .irow &<<SECThindatmai>>&     &'exim_dumpdb'&   "dump a hints database"
38767 .irow &<<SECThindatmai>>&     &'exim_tidydb'&   "clean up a hints database"
38768 .irow &<<SECThindatmai>>&     &'exim_fixdb'&    "patch a hints database"
38769 .irow &<<SECTmailboxmaint>>&  &'exim_lock'&     "lock a mailbox file"
38770 .endtable
38771
38772 Another utility that might be of use to sites with many MTAs is Tom Kistner's
38773 &'exilog'&. It provides log visualizations across multiple Exim servers. See
38774 &url(https://duncanthrax.net/exilog/) for details.
38775
38776
38777
38778
38779 .section "Finding out what Exim processes are doing (exiwhat)" "SECTfinoutwha"
38780 .cindex "&'exiwhat'&"
38781 .cindex "process, querying"
38782 .cindex "SIGUSR1"
38783 On operating systems that can restart a system call after receiving a signal
38784 (most modern OS), an Exim process responds to the SIGUSR1 signal by writing
38785 a line describing what it is doing to the file &_exim-process.info_& in the
38786 Exim spool directory. The &'exiwhat'& script sends the signal to all Exim
38787 processes it can find, having first emptied the file. It then waits for one
38788 second to allow the Exim processes to react before displaying the results. In
38789 order to run &'exiwhat'& successfully you have to have sufficient privilege to
38790 send the signal to the Exim processes, so it is normally run as root.
38791
38792 &*Warning*&: This is not an efficient process. It is intended for occasional
38793 use by system administrators. It is not sensible, for example, to set up a
38794 script that sends SIGUSR1 signals to Exim processes at short intervals.
38795
38796
38797 Unfortunately, the &'ps'& command that &'exiwhat'& uses to find Exim processes
38798 varies in different operating systems. Not only are different options used,
38799 but the format of the output is different. For this reason, there are some
38800 system configuration options that configure exactly how &'exiwhat'& works. If
38801 it doesn't seem to be working for you, check the following compile-time
38802 options:
38803 .display
38804 &`EXIWHAT_PS_CMD    `& the command for running &'ps'&
38805 &`EXIWHAT_PS_ARG    `& the argument for &'ps'&
38806 &`EXIWHAT_EGREP_ARG `& the argument for &'egrep'& to select from &'ps'& output
38807 &`EXIWHAT_KILL_ARG  `& the argument for the &'kill'& command
38808 .endd
38809 An example of typical output from &'exiwhat'& is
38810 .code
38811 164 daemon: -q1h, listening on port 25
38812 10483 running queue: waiting for 0tAycK-0002ij-00 (10492)
38813 10492 delivering 0tAycK-0002ij-00 to mail.ref.example
38814   [10.19.42.42] (editor@ref.example)
38815 10592 handling incoming call from [192.168.243.242]
38816 10628 accepting a local non-SMTP message
38817 .endd
38818 The first number in the output line is the process number. The third line has
38819 been split here, in order to fit it on the page.
38820
38821
38822
38823 .section "Selective queue listing (exiqgrep)" "SECTgreptheque"
38824 .cindex "&'exiqgrep'&"
38825 .cindex "queue" "grepping"
38826 This utility is a Perl script contributed by Matt Hubbard. It runs
38827 .code
38828 exim -bpu
38829 .endd
38830 or (in case &*-a*& switch is specified)
38831 .code
38832 exim -bp
38833 .endd
38834 The &*-C*& option is used to specify an alternate &_exim.conf_& which might
38835 contain alternate exim configuration the queue management might be using.
38836
38837 to obtain a queue listing, and then greps the output to select messages
38838 that match given criteria. The following selection options are available:
38839
38840 .vlist
38841 .vitem &*-f*&&~<&'regex'&>
38842 Match the sender address using a case-insensitive search. The field that is
38843 tested is enclosed in angle brackets, so you can test for bounce messages with
38844 .code
38845 exiqgrep -f '^<>$'
38846 .endd
38847 .vitem &*-r*&&~<&'regex'&>
38848 Match a recipient address using a case-insensitive search. The field that is
38849 tested is not enclosed in angle brackets.
38850
38851 .vitem &*-s*&&~<&'regex'&>
38852 Match against the size field.
38853
38854 .vitem &*-y*&&~<&'seconds'&>
38855 Match messages that are younger than the given time.
38856
38857 .vitem &*-o*&&~<&'seconds'&>
38858 Match messages that are older than the given time.
38859
38860 .vitem &*-z*&
38861 Match only frozen messages.
38862
38863 .vitem &*-x*&
38864 Match only non-frozen messages.
38865
38866 .vitem &*-G*&&~<&'queuename'&>
38867 Match only messages in the given queue.  Without this, the default queue is searched.
38868 .endlist
38869
38870 The following options control the format of the output:
38871
38872 .vlist
38873 .vitem &*-c*&
38874 Display only the count of matching messages.
38875
38876 .vitem &*-l*&
38877 Long format &-- display the full message information as output by Exim. This is
38878 the default.
38879
38880 .vitem &*-i*&
38881 Display message ids only.
38882
38883 .vitem &*-b*&
38884 Brief format &-- one line per message.
38885
38886 .vitem &*-R*&
38887 Display messages in reverse order.
38888
38889 .vitem &*-a*&
38890 Include delivered recipients in queue listing.
38891 .endlist
38892
38893 There is one more option, &%-h%&, which outputs a list of options.
38894
38895
38896
38897 .section "Summarizing the queue (exiqsumm)" "SECTsumtheque"
38898 .cindex "&'exiqsumm'&"
38899 .cindex "queue" "summary"
38900 The &'exiqsumm'& utility is a Perl script which reads the output of &`exim
38901 -bp`& and produces a summary of the messages in the queue. Thus, you use it by
38902 running a command such as
38903 .code
38904 exim -bp | exiqsumm
38905 .endd
38906 The output consists of one line for each domain that has messages waiting for
38907 it, as in the following example:
38908 .code
38909 3   2322   74m   66m  msn.com.example
38910 .endd
38911 Each line lists the number of pending deliveries for a domain, their total
38912 volume, and the length of time that the oldest and the newest messages have
38913 been waiting. Note that the number of pending deliveries is greater than the
38914 number of messages when messages have more than one recipient.
38915
38916 A summary line is output at the end. By default the output is sorted on the
38917 domain name, but &'exiqsumm'& has the options &%-a%& and &%-c%&, which cause
38918 the output to be sorted by oldest message and by count of messages,
38919 respectively. There are also three options that split the messages for each
38920 domain into two or more subcounts: &%-b%& separates bounce messages, &%-f%&
38921 separates frozen messages, and &%-s%& separates messages according to their
38922 sender.
38923
38924 The output of &'exim -bp'& contains the original addresses in the message, so
38925 this also applies to the output from &'exiqsumm'&. No domains from addresses
38926 generated by aliasing or forwarding are included (unless the &%one_time%&
38927 option of the &(redirect)& router has been used to convert them into &"top
38928 level"& addresses).
38929
38930
38931
38932
38933 .section "Extracting specific information from the log (exigrep)" &&&
38934          "SECTextspeinf"
38935 .cindex "&'exigrep'&"
38936 .cindex "log" "extracts; grepping for"
38937 The &'exigrep'& utility is a Perl script that searches one or more main log
38938 files for entries that match a given pattern. When it finds a match, it
38939 extracts all the log entries for the relevant message, not just those that
38940 match the pattern. Thus, &'exigrep'& can extract complete log entries for a
38941 given message, or all mail for a given user, or for a given host, for example.
38942 The input files can be in Exim log format or syslog format.
38943 If a matching log line is not associated with a specific message, it is
38944 included in &'exigrep'&'s output without any additional lines. The usage is:
38945 .display
38946 &`exigrep [-t<`&&'n'&&`>] [-I] [-l] [-M] [-v] <`&&'pattern'&&`> [<`&&'log file'&&`>] ...`&
38947 .endd
38948 If no log filenames are given on the command line, the standard input is read.
38949
38950 The &%-t%& argument specifies a number of seconds. It adds an additional
38951 condition for message selection. Messages that are complete are shown only if
38952 they spent more than <&'n'&> seconds in the queue.
38953
38954 By default, &'exigrep'& does case-insensitive matching. The &%-I%& option
38955 makes it case-sensitive. This may give a performance improvement when searching
38956 large log files. Without &%-I%&, the Perl pattern matches use Perl's &`/i`&
38957 option; with &%-I%& they do not. In both cases it is possible to change the
38958 case sensitivity within the pattern by using &`(?i)`& or &`(?-i)`&.
38959
38960 The &%-l%& option means &"literal"&, that is, treat all characters in the
38961 pattern as standing for themselves. Otherwise the pattern must be a Perl
38962 regular expression.
38963
38964 The &%-v%& option inverts the matching condition. That is, a line is selected
38965 if it does &'not'& match the pattern.
38966
38967 The &%-M%& options means &"related messages"&. &'exigrep'& will show messages
38968 that are generated as a result/response to a message that &'exigrep'& matched
38969 normally.
38970
38971 Example of &%-M%&:
38972 user_a sends a message to user_b, which generates a bounce back to user_b. If
38973 &'exigrep'& is used to search for &"user_a"&, only the first message will be
38974 displayed.  But if &'exigrep'& is used to search for &"user_b"&, the first and
38975 the second (bounce) message will be displayed. Using &%-M%& with &'exigrep'&
38976 when searching for &"user_a"& will show both messages since the bounce is
38977 &"related"& to or a &"result"& of the first message that was found by the
38978 search term.
38979
38980 If the location of a &'zcat'& command is known from the definition of
38981 ZCAT_COMMAND in &_Local/Makefile_&, &'exigrep'& automatically passes any file
38982 whose name ends in COMPRESS_SUFFIX through &'zcat'& as it searches it.
38983 If the ZCAT_COMMAND is not executable, &'exigrep'& tries to use
38984 autodetection of some well known compression extensions.
38985
38986
38987 .section "Selecting messages by various criteria (exipick)" "SECTexipick"
38988 .cindex "&'exipick'&"
38989 John Jetmore's &'exipick'& utility is included in the Exim distribution. It
38990 lists messages from the queue according to a variety of criteria. For details
38991 of &'exipick'&'s facilities, run &'exipick'& with
38992 the &%--help%& option.
38993
38994
38995 .section "Cycling log files (exicyclog)" "SECTcyclogfil"
38996 .cindex "log" "cycling local files"
38997 .cindex "cycling logs"
38998 .cindex "&'exicyclog'&"
38999 The &'exicyclog'& script can be used to cycle (rotate) &'mainlog'& and
39000 &'rejectlog'& files. This is not necessary if only syslog is being used, or if
39001 you are using log files with datestamps in their names (see section
39002 &<<SECTdatlogfil>>&). Some operating systems have their own standard mechanisms
39003 for log cycling, and these can be used instead of &'exicyclog'& if preferred.
39004 There are two command line options for &'exicyclog'&:
39005 .ilist
39006 &%-k%& <&'count'&> specifies the number of log files to keep, overriding the
39007 default that is set when Exim is built. The default default is 10.
39008 .next
39009 &%-l%& <&'path'&> specifies the log file path, in the same format as Exim's
39010 &%log_file_path%& option (for example, &`/var/log/exim_%slog`&), again
39011 overriding the script's default, which is to find the setting from Exim's
39012 configuration.
39013 .endlist
39014
39015 Each time &'exicyclog'& is run the filenames get &"shuffled down"& by one. If
39016 the main log filename is &_mainlog_& (the default) then when &'exicyclog'& is
39017 run &_mainlog_& becomes &_mainlog.01_&, the previous &_mainlog.01_& becomes
39018 &_mainlog.02_& and so on, up to the limit that is set in the script or by the
39019 &%-k%& option. Log files whose numbers exceed the limit are discarded. Reject
39020 logs are handled similarly.
39021
39022 If the limit is greater than 99, the script uses 3-digit numbers such as
39023 &_mainlog.001_&, &_mainlog.002_&, etc. If you change from a number less than 99
39024 to one that is greater, or &'vice versa'&, you will have to fix the names of
39025 any existing log files.
39026
39027 If no &_mainlog_& file exists, the script does nothing. Files that &"drop off"&
39028 the end are deleted. All files with numbers greater than 01 are compressed,
39029 using a compression command which is configured by the COMPRESS_COMMAND
39030 setting in &_Local/Makefile_&. It is usual to run &'exicyclog'& daily from a
39031 root &%crontab%& entry of the form
39032 .code
39033 1 0 * * * su exim -c /usr/exim/bin/exicyclog
39034 .endd
39035 assuming you have used the name &"exim"& for the Exim user. You can run
39036 &'exicyclog'& as root if you wish, but there is no need.
39037
39038
39039
39040 .section "Mail statistics (eximstats)" "SECTmailstat"
39041 .cindex "statistics"
39042 .cindex "&'eximstats'&"
39043 A Perl script called &'eximstats'& is provided for extracting statistical
39044 information from log files. The output is either plain text, or HTML.
39045 . --- 2018-09-07: LogReport's Lire appears to be dead; website is a Yahoo Japan
39046 . --- 404 error and everything else points to that.
39047
39048 The &'eximstats'& script has been hacked about quite a bit over time. The
39049 latest version is the result of some extensive revision by Steve Campbell. A
39050 lot of information is given by default, but there are options for suppressing
39051 various parts of it. Following any options, the arguments to the script are a
39052 list of files, which should be main log files. For example:
39053 .code
39054 eximstats -nr /var/spool/exim/log/mainlog.01
39055 .endd
39056 By default, &'eximstats'& extracts information about the number and volume of
39057 messages received from or delivered to various hosts. The information is sorted
39058 both by message count and by volume, and the top fifty hosts in each category
39059 are listed on the standard output. Similar information, based on email
39060 addresses or domains instead of hosts can be requested by means of various
39061 options. For messages delivered and received locally, similar statistics are
39062 also produced per user.
39063
39064 The output also includes total counts and statistics about delivery errors, and
39065 histograms showing the number of messages received and deliveries made in each
39066 hour of the day. A delivery with more than one address in its envelope (for
39067 example, an SMTP transaction with more than one RCPT command) is counted
39068 as a single delivery by &'eximstats'&.
39069
39070 Though normally more deliveries than receipts are reported (as messages may
39071 have multiple recipients), it is possible for &'eximstats'& to report more
39072 messages received than delivered, even though the queue is empty at the start
39073 and end of the period in question. If an incoming message contains no valid
39074 recipients, no deliveries are recorded for it. A bounce message is handled as
39075 an entirely separate message.
39076
39077 &'eximstats'& always outputs a grand total summary giving the volume and number
39078 of messages received and deliveries made, and the number of hosts involved in
39079 each case. It also outputs the number of messages that were delayed (that is,
39080 not completely delivered at the first attempt), and the number that had at
39081 least one address that failed.
39082
39083 The remainder of the output is in sections that can be independently disabled
39084 or modified by various options. It consists of a summary of deliveries by
39085 transport, histograms of messages received and delivered per time interval
39086 (default per hour), information about the time messages spent in the queue,
39087 a list of relayed messages, lists of the top fifty sending hosts, local
39088 senders, destination hosts, and destination local users by count and by volume,
39089 and a list of delivery errors that occurred.
39090
39091 The relay information lists messages that were actually relayed, that is, they
39092 came from a remote host and were directly delivered to some other remote host,
39093 without being processed (for example, for aliasing or forwarding) locally.
39094
39095 There are quite a few options for &'eximstats'& to control exactly what it
39096 outputs. These are documented in the Perl script itself, and can be extracted
39097 by running the command &(perldoc)& on the script. For example:
39098 .code
39099 perldoc /usr/exim/bin/eximstats
39100 .endd
39101
39102 .section "Checking access policy (exim_checkaccess)" "SECTcheckaccess"
39103 .cindex "&'exim_checkaccess'&"
39104 .cindex "policy control" "checking access"
39105 .cindex "checking access"
39106 The &%-bh%& command line argument allows you to run a fake SMTP session with
39107 debugging output, in order to check what Exim is doing when it is applying
39108 policy controls to incoming SMTP mail. However, not everybody is sufficiently
39109 familiar with the SMTP protocol to be able to make full use of &%-bh%&, and
39110 sometimes you just want to answer the question &"Does this address have
39111 access?"& without bothering with any further details.
39112
39113 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%&. It takes
39114 two arguments, an IP address and an email address:
39115 .code
39116 exim_checkaccess 10.9.8.7 A.User@a.domain.example
39117 .endd
39118 The utility runs a call to Exim with the &%-bh%& option, to test whether the
39119 given email address would be accepted in a RCPT command in a TCP/IP
39120 connection from the host with the given IP address. The output of the utility
39121 is either the word &"accepted"&, or the SMTP error response, for example:
39122 .code
39123 Rejected:
39124 550 Relay not permitted
39125 .endd
39126 When running this test, the utility uses &`<>`& as the envelope sender address
39127 for the MAIL command, but you can change this by providing additional
39128 options. These are passed directly to the Exim command. For example, to specify
39129 that the test is to be run with the sender address &'himself@there.example'&
39130 you can use:
39131 .code
39132 exim_checkaccess 10.9.8.7 A.User@a.domain.example \
39133                  -f himself@there.example
39134 .endd
39135 Note that these additional Exim command line items must be given after the two
39136 mandatory arguments.
39137
39138 Because the &%exim_checkaccess%& uses &%-bh%&, it does not perform callouts
39139 while running its checks. You can run checks that include callouts by using
39140 &%-bhc%&, but this is not yet available in a &"packaged"& form.
39141
39142
39143
39144 .section "Making DBM files (exim_dbmbuild)" "SECTdbmbuild"
39145 .cindex "DBM" "building dbm files"
39146 .cindex "building DBM files"
39147 .cindex "&'exim_dbmbuild'&"
39148 .cindex "lower casing"
39149 .cindex "binary zero" "in lookup key"
39150 The &'exim_dbmbuild'& program reads an input file containing keys and data in
39151 the format used by the &(lsearch)& lookup (see section
39152 &<<SECTsinglekeylookups>>&). It writes a DBM file using the lower-cased alias
39153 names as keys and the remainder of the information as data. The lower-casing
39154 can be prevented by calling the program with the &%-nolc%& option.
39155
39156 A terminating zero is included as part of the key string. This is expected by
39157 the &(dbm)& lookup type. However, if the option &%-nozero%& is given,
39158 &'exim_dbmbuild'& creates files without terminating zeroes in either the key
39159 strings or the data strings. The &(dbmnz)& lookup type can be used with such
39160 files.
39161
39162 The program requires two arguments: the name of the input file (which can be a
39163 single hyphen to indicate the standard input), and the name of the output file.
39164 It creates the output under a temporary name, and then renames it if all went
39165 well.
39166
39167 .cindex "USE_DB"
39168 If the native DB interface is in use (USE_DB is set in a compile-time
39169 configuration file &-- this is common in free versions of Unix) the two
39170 filenames must be different, because in this mode the Berkeley DB functions
39171 create a single output file using exactly the name given. For example,
39172 .code
39173 exim_dbmbuild /etc/aliases /etc/aliases.db
39174 .endd
39175 reads the system alias file and creates a DBM version of it in
39176 &_/etc/aliases.db_&.
39177
39178 In systems that use the &'ndbm'& routines (mostly proprietary versions of
39179 Unix), two files are used, with the suffixes &_.dir_& and &_.pag_&. In this
39180 environment, the suffixes are added to the second argument of
39181 &'exim_dbmbuild'&, so it can be the same as the first. This is also the case
39182 when the Berkeley functions are used in compatibility mode (though this is not
39183 recommended), because in that case it adds a &_.db_& suffix to the filename.
39184
39185 If a duplicate key is encountered, the program outputs a warning, and when it
39186 finishes, its return code is 1 rather than zero, unless the &%-noduperr%&
39187 option is used. By default, only the first of a set of duplicates is used &--
39188 this makes it compatible with &(lsearch)& lookups. There is an option
39189 &%-lastdup%& which causes it to use the data for the last duplicate instead.
39190 There is also an option &%-nowarn%&, which stops it listing duplicate keys to
39191 &%stderr%&. For other errors, where it doesn't actually make a new file, the
39192 return code is 2.
39193
39194
39195
39196
39197 .section "Finding individual retry times (exinext)" "SECTfinindret"
39198 .cindex "retry" "times"
39199 .cindex "&'exinext'&"
39200 A utility called &'exinext'& (mostly a Perl script) provides the ability to
39201 fish specific information out of the retry database. Given a mail domain (or a
39202 complete address), it looks up the hosts for that domain, and outputs any retry
39203 information for the hosts or for the domain. At present, the retry information
39204 is obtained by running &'exim_dumpdb'& (see below) and post-processing the
39205 output. For example:
39206 .code
39207 $ exinext piglet@milne.fict.example
39208 kanga.milne.example:192.168.8.1 error 146: Connection refused
39209   first failed: 21-Feb-1996 14:57:34
39210   last tried:   21-Feb-1996 14:57:34
39211   next try at:  21-Feb-1996 15:02:34
39212 roo.milne.example:192.168.8.3 error 146: Connection refused
39213   first failed: 20-Jan-1996 13:12:08
39214   last tried:   21-Feb-1996 11:42:03
39215   next try at:  21-Feb-1996 19:42:03
39216   past final cutoff time
39217 .endd
39218 You can also give &'exinext'& a local part, without a domain, and it
39219 will give any retry information for that local part in your default domain.
39220 A message id can be used to obtain retry information pertaining to a specific
39221 message. This exists only when an attempt to deliver a message to a remote host
39222 suffers a message-specific error (see section &<<SECToutSMTPerr>>&).
39223 &'exinext'& is not particularly efficient, but then it is not expected to be
39224 run very often.
39225
39226 The &'exinext'& utility calls Exim to find out information such as the location
39227 of the spool directory. The utility has &%-C%& and &%-D%& options, which are
39228 passed on to the &'exim'& commands. The first specifies an alternate Exim
39229 configuration file, and the second sets macros for use within the configuration
39230 file. These features are mainly to help in testing, but might also be useful in
39231 environments where more than one configuration file is in use.
39232
39233
39234
39235 .section "Hints database maintenance" "SECThindatmai"
39236 .cindex "hints database" "maintenance"
39237 .cindex "maintaining Exim's hints database"
39238 Three utility programs are provided for maintaining the DBM files that Exim
39239 uses to contain its delivery hint information. Each program requires two
39240 arguments. The first specifies the name of Exim's spool directory, and the
39241 second is the name of the database it is to operate on. These are as follows:
39242
39243 .ilist
39244 &'retry'&: the database of retry information
39245 .next
39246 &'wait-'&<&'transport name'&>: databases of information about messages waiting
39247 for remote hosts
39248 .next
39249 &'callout'&: the callout cache
39250 .next
39251 &'ratelimit'&: the data for implementing the ratelimit ACL condition
39252 .next
39253 .new
39254 &'tls'&: TLS session resumption data
39255 .wen
39256 .next
39257 &'misc'&: other hints data
39258 .endlist
39259
39260 The &'misc'& database is used for
39261
39262 .ilist
39263 Serializing ETRN runs (when &%smtp_etrn_serialize%& is set)
39264 .next
39265 Serializing delivery to a specific host (when &%serialize_hosts%& is set in an
39266 &(smtp)& transport)
39267 .next
39268 Limiting the concurrency of specific transports (when &%max_parallel%& is set
39269 in a transport)
39270 .endlist
39271
39272
39273
39274 .section "exim_dumpdb" "SECID261"
39275 .cindex "&'exim_dumpdb'&"
39276 The entire contents of a database are written to the standard output by the
39277 &'exim_dumpdb'& program, which has no options or arguments other than the
39278 spool and database names. For example, to dump the retry database:
39279 .code
39280 exim_dumpdb /var/spool/exim retry
39281 .endd
39282 Two lines of output are produced for each entry:
39283 .code
39284 T:mail.ref.example:192.168.242.242 146 77 Connection refused
39285 31-Oct-1995 12:00:12 02-Nov-1995 12:21:39 02-Nov-1995 20:21:39 *
39286 .endd
39287 The first item on the first line is the key of the record. It starts with one
39288 of the letters R, or T, depending on whether it refers to a routing or
39289 transport retry. For a local delivery, the next part is the local address; for
39290 a remote delivery it is the name of the remote host, followed by its failing IP
39291 address (unless &%retry_include_ip_address%& is set false on the &(smtp)&
39292 transport). If the remote port is not the standard one (port 25), it is added
39293 to the IP address. Then there follows an error code, an additional error code,
39294 and a textual description of the error.
39295
39296 The three times on the second line are the time of first failure, the time of
39297 the last delivery attempt, and the computed time for the next attempt. The line
39298 ends with an asterisk if the cutoff time for the last retry rule has been
39299 exceeded.
39300
39301 Each output line from &'exim_dumpdb'& for the &'wait-xxx'& databases
39302 consists of a host name followed by a list of ids for messages that are or were
39303 waiting to be delivered to that host. If there are a very large number for any
39304 one host, continuation records, with a sequence number added to the host name,
39305 may be seen. The data in these records is often out of date, because a message
39306 may be routed to several alternative hosts, and Exim makes no effort to keep
39307 cross-references.
39308
39309
39310
39311 .section "exim_tidydb" "SECID262"
39312 .cindex "&'exim_tidydb'&"
39313 The &'exim_tidydb'& utility program is used to tidy up the contents of a hints
39314 database. If run with no options, it removes all records that are more than 30
39315 days old. The age is calculated from the date and time that the record was last
39316 updated. Note that, in the case of the retry database, it is &'not'& the time
39317 since the first delivery failure. Information about a host that has been down
39318 for more than 30 days will remain in the database, provided that the record is
39319 updated sufficiently often.
39320
39321 The cutoff date can be altered by means of the &%-t%& option, which must be
39322 followed by a time. For example, to remove all records older than a week from
39323 the retry database:
39324 .code
39325 exim_tidydb -t 7d /var/spool/exim retry
39326 .endd
39327 Both the &'wait-xxx'& and &'retry'& databases contain items that involve
39328 message ids. In the former these appear as data in records keyed by host &--
39329 they were messages that were waiting for that host &-- and in the latter they
39330 are the keys for retry information for messages that have suffered certain
39331 types of error. When &'exim_tidydb'& is run, a check is made to ensure that
39332 message ids in database records are those of messages that are still on the
39333 queue. Message ids for messages that no longer exist are removed from
39334 &'wait-xxx'& records, and if this leaves any records empty, they are deleted.
39335 For the &'retry'& database, records whose keys are non-existent message ids are
39336 removed. The &'exim_tidydb'& utility outputs comments on the standard output
39337 whenever it removes information from the database.
39338
39339 Certain records are automatically removed by Exim when they are no longer
39340 needed, but others are not. For example, if all the MX hosts for a domain are
39341 down, a retry record is created for each one. If the primary MX host comes back
39342 first, its record is removed when Exim successfully delivers to it, but the
39343 records for the others remain because Exim has not tried to use those hosts.
39344
39345 It is important, therefore, to run &'exim_tidydb'& periodically on all the
39346 hints databases. You should do this at a quiet time of day, because it requires
39347 a database to be locked (and therefore inaccessible to Exim) while it does its
39348 work. Removing records from a DBM file does not normally make the file smaller,
39349 but all the common DBM libraries are able to re-use the space that is released.
39350 After an initial phase of increasing in size, the databases normally reach a
39351 point at which they no longer get any bigger, as long as they are regularly
39352 tidied.
39353
39354 &*Warning*&: If you never run &'exim_tidydb'&, the space used by the hints
39355 databases is likely to keep on increasing.
39356
39357
39358
39359
39360 .section "exim_fixdb" "SECID263"
39361 .cindex "&'exim_fixdb'&"
39362 The &'exim_fixdb'& program is a utility for interactively modifying databases.
39363 Its main use is for testing Exim, but it might also be occasionally useful for
39364 getting round problems in a live system. It has no options, and its interface
39365 is somewhat crude. On entry, it prompts for input with a right angle-bracket. A
39366 key of a database record can then be entered, and the data for that record is
39367 displayed.
39368
39369 If &"d"& is typed at the next prompt, the entire record is deleted. For all
39370 except the &'retry'& database, that is the only operation that can be carried
39371 out. For the &'retry'& database, each field is output preceded by a number, and
39372 data for individual fields can be changed by typing the field number followed
39373 by new data, for example:
39374 .code
39375 > 4 951102:1000
39376 .endd
39377 resets the time of the next delivery attempt. Time values are given as a
39378 sequence of digit pairs for year, month, day, hour, and minute. Colons can be
39379 used as optional separators.
39380
39381
39382
39383
39384 .section "Mailbox maintenance (exim_lock)" "SECTmailboxmaint"
39385 .cindex "mailbox" "maintenance"
39386 .cindex "&'exim_lock'&"
39387 .cindex "locking mailboxes"
39388 The &'exim_lock'& utility locks a mailbox file using the same algorithm as
39389 Exim. For a discussion of locking issues, see section &<<SECTopappend>>&.
39390 &'Exim_lock'& can be used to prevent any modification of a mailbox by Exim or
39391 a user agent while investigating a problem. The utility requires the name of
39392 the file as its first argument. If the locking is successful, the second
39393 argument is run as a command (using C's &[system()]& function); if there is no
39394 second argument, the value of the SHELL environment variable is used; if this
39395 is unset or empty, &_/bin/sh_& is run. When the command finishes, the mailbox
39396 is unlocked and the utility ends. The following options are available:
39397
39398 .vlist
39399 .vitem &%-fcntl%&
39400 Use &[fcntl()]& locking on the open mailbox.
39401
39402 .vitem &%-flock%&
39403 Use &[flock()]& locking on the open mailbox, provided the operating system
39404 supports it.
39405
39406 .vitem &%-interval%&
39407 This must be followed by a number, which is a number of seconds; it sets the
39408 interval to sleep between retries (default 3).
39409
39410 .vitem &%-lockfile%&
39411 Create a lock file before opening the mailbox.
39412
39413 .vitem &%-mbx%&
39414 Lock the mailbox using MBX rules.
39415
39416 .vitem &%-q%&
39417 Suppress verification output.
39418
39419 .vitem &%-retries%&
39420 This must be followed by a number; it sets the number of times to try to get
39421 the lock (default 10).
39422
39423 .vitem &%-restore_time%&
39424 This option causes &%exim_lock%& to restore the modified and read times to the
39425 locked file before exiting. This allows you to access a locked mailbox (for
39426 example, to take a backup copy) without disturbing the times that the user
39427 subsequently sees.
39428
39429 .vitem &%-timeout%&
39430 This must be followed by a number, which is a number of seconds; it sets a
39431 timeout to be used with a blocking &[fcntl()]& lock. If it is not set (the
39432 default), a non-blocking call is used.
39433
39434 .vitem &%-v%&
39435 Generate verbose output.
39436 .endlist
39437
39438 If none of &%-fcntl%&, &%-flock%&, &%-lockfile%& or &%-mbx%& are given, the
39439 default is to create a lock file and also to use &[fcntl()]& locking on the
39440 mailbox, which is the same as Exim's default. The use of &%-flock%& or
39441 &%-fcntl%& requires that the file be writeable; the use of &%-lockfile%&
39442 requires that the directory containing the file be writeable. Locking by lock
39443 file does not last forever; Exim assumes that a lock file is expired if it is
39444 more than 30 minutes old.
39445
39446 The &%-mbx%& option can be used with either or both of &%-fcntl%& or
39447 &%-flock%&. It assumes &%-fcntl%& by default. MBX locking causes a shared lock
39448 to be taken out on the open mailbox, and an exclusive lock on the file
39449 &_/tmp/.n.m_& where &'n'& and &'m'& are the device number and inode
39450 number of the mailbox file. When the locking is released, if an exclusive lock
39451 can be obtained for the mailbox, the file in &_/tmp_& is deleted.
39452
39453 The default output contains verification of the locking that takes place. The
39454 &%-v%& option causes some additional information to be given. The &%-q%& option
39455 suppresses all output except error messages.
39456
39457 A command such as
39458 .code
39459 exim_lock /var/spool/mail/spqr
39460 .endd
39461 runs an interactive shell while the file is locked, whereas
39462 .display
39463 &`exim_lock -q /var/spool/mail/spqr <<End`&
39464 <&'some commands'&>
39465 &`End`&
39466 .endd
39467 runs a specific non-interactive sequence of commands while the file is locked,
39468 suppressing all verification output. A single command can be run by a command
39469 such as
39470 .code
39471 exim_lock -q /var/spool/mail/spqr \
39472   "cp /var/spool/mail/spqr /some/where"
39473 .endd
39474 Note that if a command is supplied, it must be entirely contained within the
39475 second argument &-- hence the quotes.
39476 .ecindex IIDutils
39477
39478
39479 . ////////////////////////////////////////////////////////////////////////////
39480 . ////////////////////////////////////////////////////////////////////////////
39481
39482 .chapter "The Exim monitor" "CHAPeximon"
39483 .scindex IIDeximon "Exim monitor" "description"
39484 .cindex "X-windows"
39485 .cindex "&'eximon'&"
39486 .cindex "Local/eximon.conf"
39487 .cindex "&_exim_monitor/EDITME_&"
39488 The Exim monitor is an application which displays in an X window information
39489 about the state of Exim's queue and what Exim is doing. An admin user can
39490 perform certain operations on messages from this GUI interface; however all
39491 such facilities are also available from the command line, and indeed, the
39492 monitor itself makes use of the command line to perform any actions requested.
39493
39494
39495
39496 .section "Running the monitor" "SECID264"
39497 The monitor is started by running the script called &'eximon'&. This is a shell
39498 script that sets up a number of environment variables, and then runs the
39499 binary called &_eximon.bin_&. The default appearance of the monitor window can
39500 be changed by editing the &_Local/eximon.conf_& file created by editing
39501 &_exim_monitor/EDITME_&. Comments in that file describe what the various
39502 parameters are for.
39503
39504 The parameters that get built into the &'eximon'& script can be overridden for
39505 a particular invocation by setting up environment variables of the same names,
39506 preceded by &`EXIMON_`&. For example, a shell command such as
39507 .code
39508 EXIMON_LOG_DEPTH=400 eximon
39509 .endd
39510 (in a Bourne-compatible shell) runs &'eximon'& with an overriding setting of
39511 the LOG_DEPTH parameter. If EXIMON_LOG_FILE_PATH is set in the environment, it
39512 overrides the Exim log file configuration. This makes it possible to have
39513 &'eximon'& tailing log data that is written to syslog, provided that MAIL.INFO
39514 syslog messages are routed to a file on the local host.
39515
39516 X resources can be used to change the appearance of the window in the normal
39517 way. For example, a resource setting of the form
39518 .code
39519 Eximon*background: gray94
39520 .endd
39521 changes the colour of the background to light grey rather than white. The
39522 stripcharts are drawn with both the data lines and the reference lines in
39523 black. This means that the reference lines are not visible when on top of the
39524 data. However, their colour can be changed by setting a resource called
39525 &"highlight"& (an odd name, but that's what the Athena stripchart widget uses).
39526 For example, if your X server is running Unix, you could set up lighter
39527 reference lines in the stripcharts by obeying
39528 .code
39529 xrdb -merge <<End
39530 Eximon*highlight: gray
39531 End
39532 .endd
39533 .cindex "admin user"
39534 In order to see the contents of messages in the queue, and to operate on them,
39535 &'eximon'& must either be run as root or by an admin user.
39536
39537 The command-line parameters of &'eximon'& are passed to &_eximon.bin_& and may
39538 contain X11 resource parameters interpreted by the X11 library.  In addition,
39539 if the first parameter starts with the string "gdb" then it is removed and the
39540 binary is invoked under gdb (the parameter is used as the gdb command-name, so
39541 versioned variants of gdb can be invoked).
39542
39543 The monitor's window is divided into three parts. The first contains one or
39544 more stripcharts and two action buttons, the second contains a &"tail"& of the
39545 main log file, and the third is a display of the queue of messages awaiting
39546 delivery, with two more action buttons. The following sections describe these
39547 different parts of the display.
39548
39549
39550
39551
39552 .section "The stripcharts" "SECID265"
39553 .cindex "stripchart"
39554 The first stripchart is always a count of messages in the queue. Its name can
39555 be configured by setting QUEUE_STRIPCHART_NAME in the
39556 &_Local/eximon.conf_& file. The remaining stripcharts are defined in the
39557 configuration script by regular expression matches on log file entries, making
39558 it possible to display, for example, counts of messages delivered to certain
39559 hosts or using certain transports. The supplied defaults display counts of
39560 received and delivered messages, and of local and SMTP deliveries. The default
39561 period between stripchart updates is one minute; this can be adjusted by a
39562 parameter in the &_Local/eximon.conf_& file.
39563
39564 The stripchart displays rescale themselves automatically as the value they are
39565 displaying changes. There are always 10 horizontal lines in each chart; the
39566 title string indicates the value of each division when it is greater than one.
39567 For example, &"x2"& means that each division represents a value of 2.
39568
39569 It is also possible to have a stripchart which shows the percentage fullness of
39570 a particular disk partition, which is useful when local deliveries are confined
39571 to a single partition.
39572
39573 .cindex "&%statvfs%& function"
39574 This relies on the availability of the &[statvfs()]& function or equivalent in
39575 the operating system. Most, but not all versions of Unix that support Exim have
39576 this. For this particular stripchart, the top of the chart always represents
39577 100%, and the scale is given as &"x10%"&. This chart is configured by setting
39578 SIZE_STRIPCHART and (optionally) SIZE_STRIPCHART_NAME in the
39579 &_Local/eximon.conf_& file.
39580
39581
39582
39583
39584 .section "Main action buttons" "SECID266"
39585 .cindex "size" "of monitor window"
39586 .cindex "Exim monitor" "window size"
39587 .cindex "window size"
39588 Below the stripcharts there is an action button for quitting the monitor. Next
39589 to this is another button marked &"Size"&. They are placed here so that
39590 shrinking the window to its default minimum size leaves just the queue count
39591 stripchart and these two buttons visible. Pressing the &"Size"& button causes
39592 the window to expand to its maximum size, unless it is already at the maximum,
39593 in which case it is reduced to its minimum.
39594
39595 When expanding to the maximum, if the window cannot be fully seen where it
39596 currently is, it is moved back to where it was the last time it was at full
39597 size. When it is expanding from its minimum size, the old position is
39598 remembered, and next time it is reduced to the minimum it is moved back there.
39599
39600 The idea is that you can keep a reduced window just showing one or two
39601 stripcharts at a convenient place on your screen, easily expand it to show
39602 the full window when required, and just as easily put it back to what it was.
39603 The idea is copied from what the &'twm'& window manager does for its
39604 &'f.fullzoom'& action. The minimum size of the window can be changed by setting
39605 the MIN_HEIGHT and MIN_WIDTH values in &_Local/eximon.conf_&.
39606
39607 Normally, the monitor starts up with the window at its full size, but it can be
39608 built so that it starts up with the window at its smallest size, by setting
39609 START_SMALL=yes in &_Local/eximon.conf_&.
39610
39611
39612
39613 .section "The log display" "SECID267"
39614 .cindex "log" "tail of; in monitor"
39615 The second section of the window is an area in which a display of the tail of
39616 the main log is maintained.
39617 To save space on the screen, the timestamp on each log line is shortened by
39618 removing the date and, if &%log_timezone%& is set, the timezone.
39619 The log tail is not available when the only destination for logging data is
39620 syslog, unless the syslog lines are routed to a local file whose name is passed
39621 to &'eximon'& via the EXIMON_LOG_FILE_PATH environment variable.
39622
39623 The log sub-window has a scroll bar at its lefthand side which can be used to
39624 move back to look at earlier text, and the up and down arrow keys also have a
39625 scrolling effect. The amount of log that is kept depends on the setting of
39626 LOG_BUFFER in &_Local/eximon.conf_&, which specifies the amount of memory
39627 to use. When this is full, the earlier 50% of data is discarded &-- this is
39628 much more efficient than throwing it away line by line. The sub-window also has
39629 a horizontal scroll bar for accessing the ends of long log lines. This is the
39630 only means of horizontal scrolling; the right and left arrow keys are not
39631 available. Text can be cut from this part of the window using the mouse in the
39632 normal way. The size of this subwindow is controlled by parameters in the
39633 configuration file &_Local/eximon.conf_&.
39634
39635 Searches of the text in the log window can be carried out by means of the ^R
39636 and ^S keystrokes, which default to a reverse and a forward search,
39637 respectively. The search covers only the text that is displayed in the window.
39638 It cannot go further back up the log.
39639
39640 The point from which the search starts is indicated by a caret marker. This is
39641 normally at the end of the text in the window, but can be positioned explicitly
39642 by pointing and clicking with the left mouse button, and is moved automatically
39643 by a successful search. If new text arrives in the window when it is scrolled
39644 back, the caret remains where it is, but if the window is not scrolled back,
39645 the caret is moved to the end of the new text.
39646
39647 Pressing ^R or ^S pops up a window into which the search text can be typed.
39648 There are buttons for selecting forward or reverse searching, for carrying out
39649 the search, and for cancelling. If the &"Search"& button is pressed, the search
39650 happens and the window remains so that further searches can be done. If the
39651 &"Return"& key is pressed, a single search is done and the window is closed. If
39652 ^C is typed the search is cancelled.
39653
39654 The searching facility is implemented using the facilities of the Athena text
39655 widget. By default this pops up a window containing both &"search"& and
39656 &"replace"& options. In order to suppress the unwanted &"replace"& portion for
39657 eximon, a modified version of the &%TextPop%& widget is distributed with Exim.
39658 However, the linkers in BSDI and HP-UX seem unable to handle an externally
39659 provided version of &%TextPop%& when the remaining parts of the text widget
39660 come from the standard libraries. The compile-time option EXIMON_TEXTPOP can be
39661 unset to cut out the modified &%TextPop%&, making it possible to build Eximon
39662 on these systems, at the expense of having unwanted items in the search popup
39663 window.
39664
39665
39666
39667 .section "The queue display" "SECID268"
39668 .cindex "queue" "display in monitor"
39669 The bottom section of the monitor window contains a list of all messages that
39670 are in the queue, which includes those currently being received or delivered,
39671 as well as those awaiting delivery. The size of this subwindow is controlled by
39672 parameters in the configuration file &_Local/eximon.conf_&, and the frequency
39673 at which it is updated is controlled by another parameter in the same file &--
39674 the default is 5 minutes, since queue scans can be quite expensive. However,
39675 there is an &"Update"& action button just above the display which can be used
39676 to force an update of the queue display at any time.
39677
39678 When a host is down for some time, a lot of pending mail can build up for it,
39679 and this can make it hard to deal with other messages in the queue. To help
39680 with this situation there is a button next to &"Update"& called &"Hide"&. If
39681 pressed, a dialogue box called &"Hide addresses ending with"& is put up. If you
39682 type anything in here and press &"Return"&, the text is added to a chain of
39683 such texts, and if every undelivered address in a message matches at least one
39684 of the texts, the message is not displayed.
39685
39686 If there is an address that does not match any of the texts, all the addresses
39687 are displayed as normal. The matching happens on the ends of addresses so, for
39688 example, &'cam.ac.uk'& specifies all addresses in Cambridge, while
39689 &'xxx@foo.com.example'& specifies just one specific address. When any hiding
39690 has been set up, a button called &"Unhide"& is displayed. If pressed, it
39691 cancels all hiding. Also, to ensure that hidden messages do not get forgotten,
39692 a hide request is automatically cancelled after one hour.
39693
39694 While the dialogue box is displayed, you can't press any buttons or do anything
39695 else to the monitor window. For this reason, if you want to cut text from the
39696 queue display to use in the dialogue box, you have to do the cutting before
39697 pressing the &"Hide"& button.
39698
39699 The queue display contains, for each unhidden queued message, the length of
39700 time it has been in the queue, the size of the message, the message id, the
39701 message sender, and the first undelivered recipient, all on one line. If it is
39702 a bounce message, the sender is shown as &"<>"&. If there is more than one
39703 recipient to which the message has not yet been delivered, subsequent ones are
39704 listed on additional lines, up to a maximum configured number, following which
39705 an ellipsis is displayed. Recipients that have already received the message are
39706 not shown.
39707
39708 .cindex "frozen messages" "display"
39709 If a message is frozen, an asterisk is displayed at the left-hand side.
39710
39711 The queue display has a vertical scroll bar, and can also be scrolled by means
39712 of the arrow keys. Text can be cut from it using the mouse in the normal way.
39713 The text searching facilities, as described above for the log window, are also
39714 available, but the caret is always moved to the end of the text when the queue
39715 display is updated.
39716
39717
39718
39719 .section "The queue menu" "SECID269"
39720 .cindex "queue" "menu in monitor"
39721 If the &%shift%& key is held down and the left button is clicked when the mouse
39722 pointer is over the text for any message, an action menu pops up, and the first
39723 line of the queue display for the message is highlighted. This does not affect
39724 any selected text.
39725
39726 If you want to use some other event for popping up the menu, you can set the
39727 MENU_EVENT parameter in &_Local/eximon.conf_& to change the default, or
39728 set EXIMON_MENU_EVENT in the environment before starting the monitor. The
39729 value set in this parameter is a standard X event description. For example, to
39730 run eximon using &%ctrl%& rather than &%shift%& you could use
39731 .code
39732 EXIMON_MENU_EVENT='Ctrl<Btn1Down>' eximon
39733 .endd
39734 The title of the menu is the message id, and it contains entries which act as
39735 follows:
39736
39737 .ilist
39738 &'message log'&: The contents of the message log for the message are displayed
39739 in a new text window.
39740 .next
39741 &'headers'&: Information from the spool file that contains the envelope
39742 information and headers is displayed in a new text window. See chapter
39743 &<<CHAPspool>>& for a description of the format of spool files.
39744 .next
39745 &'body'&: The contents of the spool file containing the body of the message are
39746 displayed in a new text window. There is a default limit of 20,000 bytes to the
39747 amount of data displayed. This can be changed by setting the BODY_MAX
39748 option at compile time, or the EXIMON_BODY_MAX option at runtime.
39749 .next
39750 &'deliver message'&: A call to Exim is made using the &%-M%& option to request
39751 delivery of the message. This causes an automatic thaw if the message is
39752 frozen. The &%-v%& option is also set, and the output from Exim is displayed in
39753 a new text window. The delivery is run in a separate process, to avoid holding
39754 up the monitor while the delivery proceeds.
39755 .next
39756 &'freeze message'&: A call to Exim is made using the &%-Mf%& option to request
39757 that the message be frozen.
39758 .next
39759 .cindex "thawing messages"
39760 .cindex "unfreezing messages"
39761 .cindex "frozen messages" "thawing"
39762 &'thaw message'&: A call to Exim is made using the &%-Mt%& option to request
39763 that the message be thawed.
39764 .next
39765 .cindex "delivery" "forcing failure"
39766 &'give up on msg'&: A call to Exim is made using the &%-Mg%& option to request
39767 that Exim gives up trying to deliver the message. A bounce message is generated
39768 for any remaining undelivered addresses.
39769 .next
39770 &'remove message'&: A call to Exim is made using the &%-Mrm%& option to request
39771 that the message be deleted from the system without generating a bounce
39772 message.
39773 .next
39774 &'add recipient'&: A dialog box is displayed into which a recipient address can
39775 be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
39776 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
39777 Otherwise it must be entered as a fully qualified address. Pressing RETURN
39778 causes a call to Exim to be made using the &%-Mar%& option to request that an
39779 additional recipient be added to the message, unless the entry box is empty, in
39780 which case no action is taken.
39781 .next
39782 &'mark delivered'&: A dialog box is displayed into which a recipient address
39783 can be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
39784 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
39785 Otherwise it must be entered as a fully qualified address. Pressing RETURN
39786 causes a call to Exim to be made using the &%-Mmd%& option to mark the given
39787 recipient address as already delivered, unless the entry box is empty, in which
39788 case no action is taken.
39789 .next
39790 &'mark all delivered'&: A call to Exim is made using the &%-Mmad%& option to
39791 mark all recipient addresses as already delivered.
39792 .next
39793 &'edit sender'&: A dialog box is displayed initialized with the current
39794 sender's address. Pressing RETURN causes a call to Exim to be made using the
39795 &%-Mes%& option to replace the sender address, unless the entry box is empty,
39796 in which case no action is taken. If you want to set an empty sender (as in
39797 bounce messages), you must specify it as &"<>"&. Otherwise, if the address is
39798 not qualified and the QUALIFY_DOMAIN parameter is set in &_Local/eximon.conf_&,
39799 the address is qualified with that domain.
39800 .endlist
39801
39802 When a delivery is forced, a window showing the &%-v%& output is displayed. In
39803 other cases when a call to Exim is made, if there is any output from Exim (in
39804 particular, if the command fails) a window containing the command and the
39805 output is displayed. Otherwise, the results of the action are normally apparent
39806 from the log and queue displays. However, if you set ACTION_OUTPUT=yes in
39807 &_Local/eximon.conf_&, a window showing the Exim command is always opened, even
39808 if no output is generated.
39809
39810 The queue display is automatically updated for actions such as freezing and
39811 thawing, unless ACTION_QUEUE_UPDATE=no has been set in
39812 &_Local/eximon.conf_&. In this case the &"Update"& button has to be used to
39813 force an update of the display after one of these actions.
39814
39815 In any text window that is displayed as result of a menu action, the normal
39816 cut-and-paste facility is available, and searching can be carried out using ^R
39817 and ^S, as described above for the log tail window.
39818 .ecindex IIDeximon
39819
39820
39821
39822
39823
39824 . ////////////////////////////////////////////////////////////////////////////
39825 . ////////////////////////////////////////////////////////////////////////////
39826
39827 .chapter "Security considerations" "CHAPsecurity"
39828 .scindex IIDsecurcon "security" "discussion of"
39829 This chapter discusses a number of issues concerned with security, some of
39830 which are also covered in other parts of this manual.
39831
39832 For reasons that this author does not understand, some people have promoted
39833 Exim as a &"particularly secure"& mailer. Perhaps it is because of the
39834 existence of this chapter in the documentation. However, the intent of the
39835 chapter is simply to describe the way Exim works in relation to certain
39836 security concerns, not to make any specific claims about the effectiveness of
39837 its security as compared with other MTAs.
39838
39839 What follows is a description of the way Exim is supposed to be. Best efforts
39840 have been made to try to ensure that the code agrees with the theory, but an
39841 absence of bugs can never be guaranteed. Any that are reported will get fixed
39842 as soon as possible.
39843
39844
39845 .section "Building a more &""hardened""& Exim" "SECID286"
39846 .cindex "security" "build-time features"
39847 There are a number of build-time options that can be set in &_Local/Makefile_&
39848 to create Exim binaries that are &"harder"& to attack, in particular by a rogue
39849 Exim administrator who does not have the root password, or by someone who has
39850 penetrated the Exim (but not the root) account. These options are as follows:
39851
39852 .ilist
39853 ALT_CONFIG_PREFIX can be set to a string that is required to match the
39854 start of any filenames used with the &%-C%& option. When it is set, these
39855 filenames are also not allowed to contain the sequence &"/../"&. (However, if
39856 the value of the &%-C%& option is identical to the value of CONFIGURE_FILE in
39857 &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as usual.) There is no
39858 default setting for &%ALT_CONFIG_PREFIX%&.
39859
39860 If the permitted configuration files are confined to a directory to
39861 which only root has access, this guards against someone who has broken
39862 into the Exim account from running a privileged Exim with an arbitrary
39863 configuration file, and using it to break into other accounts.
39864 .next
39865
39866 If a non-trusted configuration file (i.e. not the default configuration file
39867 or one which is trusted by virtue of being listed in the TRUSTED_CONFIG_LIST
39868 file) is specified with &%-C%&, or if macros are given with &%-D%& (but see
39869 the next item), then root privilege is retained only if the caller of Exim is
39870 root. This locks out the possibility of testing a configuration using &%-C%&
39871 right through message reception and delivery, even if the caller is root. The
39872 reception works, but by that time, Exim is running as the Exim user, so when
39873 it re-execs to regain privilege for the delivery, the use of &%-C%& causes
39874 privilege to be lost. However, root can test reception and delivery using two
39875 separate commands.
39876
39877 .next
39878 The WHITELIST_D_MACROS build option declares some macros to be safe to override
39879 with &%-D%& if the real uid is one of root, the Exim run-time user or the
39880 CONFIGURE_OWNER, if defined.  The potential impact of this option is limited by
39881 requiring the run-time value supplied to &%-D%& to match a regex that errs on
39882 the restrictive side.  Requiring build-time selection of safe macros is onerous
39883 but this option is intended solely as a transition mechanism to permit
39884 previously-working configurations to continue to work after release 4.73.
39885 .next
39886 If DISABLE_D_OPTION is defined, the use of the &%-D%& command line option
39887 is disabled.
39888 .next
39889 FIXED_NEVER_USERS can be set to a colon-separated list of users that are
39890 never to be used for any deliveries. This is like the &%never_users%& runtime
39891 option, but it cannot be overridden; the runtime option adds additional users
39892 to the list. The default setting is &"root"&; this prevents a non-root user who
39893 is permitted to modify the runtime file from using Exim as a way to get root.
39894 .endlist
39895
39896
39897
39898 .section "Root privilege" "SECID270"
39899 .cindex "setuid"
39900 .cindex "root privilege"
39901 The Exim binary is normally setuid to root, which means that it gains root
39902 privilege (runs as root) when it starts execution. In some special cases (for
39903 example, when the daemon is not in use and there are no local deliveries), it
39904 may be possible to run Exim setuid to some user other than root. This is
39905 discussed in the next section. However, in most installations, root privilege
39906 is required for two things:
39907
39908 .ilist
39909 To set up a socket connected to the standard SMTP port (25) when initialising
39910 the listening daemon. If Exim is run from &'inetd'&, this privileged action is
39911 not required.
39912 .next
39913 To be able to change uid and gid in order to read users' &_.forward_& files and
39914 perform local deliveries as the receiving user or as specified in the
39915 configuration.
39916 .endlist
39917
39918 It is not necessary to be root to do any of the other things Exim does, such as
39919 receiving messages and delivering them externally over SMTP, and it is
39920 obviously more secure if Exim does not run as root except when necessary.
39921 For this reason, a user and group for Exim to use must be defined in
39922 &_Local/Makefile_&. These are known as &"the Exim user"& and &"the Exim
39923 group"&. Their values can be changed by the runtime configuration, though this
39924 is not recommended. Often a user called &'exim'& is used, but some sites use
39925 &'mail'& or another user name altogether.
39926
39927 Exim uses &[setuid()]& whenever it gives up root privilege. This is a permanent
39928 abdication; the process cannot regain root afterwards. Prior to release 4.00,
39929 &[seteuid()]& was used in some circumstances, but this is no longer the case.
39930
39931 After a new Exim process has interpreted its command line options, it changes
39932 uid and gid in the following cases:
39933
39934 .ilist
39935 .oindex "&%-C%&"
39936 .oindex "&%-D%&"
39937 If the &%-C%& option is used to specify an alternate configuration file, or if
39938 the &%-D%& option is used to define macro values for the configuration, and the
39939 calling process is not running as root, the uid and gid are changed to those of
39940 the calling process.
39941 However, if DISABLE_D_OPTION is defined in &_Local/Makefile_&, the &%-D%&
39942 option may not be used at all.
39943 If WHITELIST_D_MACROS is defined in &_Local/Makefile_&, then some macro values
39944 can be supplied if the calling process is running as root, the Exim run-time
39945 user or CONFIGURE_OWNER, if defined.
39946 .next
39947 .oindex "&%-be%&"
39948 .oindex "&%-bf%&"
39949 .oindex "&%-bF%&"
39950 If the expansion test option (&%-be%&) or one of the filter testing options
39951 (&%-bf%& or &%-bF%&) are used, the uid and gid are changed to those of the
39952 calling process.
39953 .next
39954 If the process is not a daemon process or a queue runner process or a delivery
39955 process or a process for testing address routing (started with &%-bt%&), the
39956 uid and gid are changed to the Exim user and group. This means that Exim always
39957 runs under its own uid and gid when receiving messages. This also applies when
39958 testing address verification
39959 .oindex "&%-bv%&"
39960 .oindex "&%-bh%&"
39961 (the &%-bv%& option) and testing incoming message policy controls (the &%-bh%&
39962 option).
39963 .next
39964 For a daemon, queue runner, delivery, or address testing process, the uid
39965 remains as root at this stage, but the gid is changed to the Exim group.
39966 .endlist
39967
39968 The processes that initially retain root privilege behave as follows:
39969
39970 .ilist
39971 A daemon process changes the gid to the Exim group and the uid to the Exim
39972 user after setting up one or more listening sockets. The &[initgroups()]&
39973 function is called, so that if the Exim user is in any additional groups, they
39974 will be used during message reception.
39975 .next
39976 A queue runner process retains root privilege throughout its execution. Its
39977 job is to fork a controlled sequence of delivery processes.
39978 .next
39979 A delivery process retains root privilege throughout most of its execution,
39980 but any actual deliveries (that is, the transports themselves) are run in
39981 subprocesses which always change to a non-root uid and gid. For local
39982 deliveries this is typically the uid and gid of the owner of the mailbox; for
39983 remote deliveries, the Exim uid and gid are used. Once all the delivery
39984 subprocesses have been run, a delivery process changes to the Exim uid and gid
39985 while doing post-delivery tidying up such as updating the retry database and
39986 generating bounce and warning messages.
39987
39988 While the recipient addresses in a message are being routed, the delivery
39989 process runs as root. However, if a user's filter file has to be processed,
39990 this is done in a subprocess that runs under the individual user's uid and
39991 gid. A system filter is run as root unless &%system_filter_user%& is set.
39992 .next
39993 A process that is testing addresses (the &%-bt%& option) runs as root so that
39994 the routing is done in the same environment as a message delivery.
39995 .endlist
39996
39997
39998
39999
40000 .section "Running Exim without privilege" "SECTrunexiwitpri"
40001 .cindex "privilege, running without"
40002 .cindex "unprivileged running"
40003 .cindex "root privilege" "running without"
40004 Some installations like to run Exim in an unprivileged state for more of its
40005 operation, for added security. Support for this mode of operation is provided
40006 by the global option &%deliver_drop_privilege%&. When this is set, the uid and
40007 gid are changed to the Exim user and group at the start of a delivery process
40008 (and also queue runner and address testing processes). This means that address
40009 routing is no longer run as root, and the deliveries themselves cannot change
40010 to any other uid.
40011
40012 .cindex SIGHUP
40013 .cindex "daemon" "restarting"
40014 Leaving the binary setuid to root, but setting &%deliver_drop_privilege%& means
40015 that the daemon can still be started in the usual way, and it can respond
40016 correctly to SIGHUP because the re-invocation regains root privilege.
40017
40018 An alternative approach is to make Exim setuid to the Exim user and also setgid
40019 to the Exim group. If you do this, the daemon must be started from a root
40020 process. (Calling Exim from a root process makes it behave in the way it does
40021 when it is setuid root.) However, the daemon cannot restart itself after a
40022 SIGHUP signal because it cannot regain privilege.
40023
40024 It is still useful to set &%deliver_drop_privilege%& in this case, because it
40025 stops Exim from trying to re-invoke itself to do a delivery after a message has
40026 been received. Such a re-invocation is a waste of resources because it has no
40027 effect.
40028
40029 If restarting the daemon is not an issue (for example, if &%mua_wrapper%& is
40030 set, or &'inetd'& is being used instead of a daemon), having the binary setuid
40031 to the Exim user seems a clean approach, but there is one complication:
40032
40033 In this style of operation, Exim is running with the real uid and gid set to
40034 those of the calling process, and the effective uid/gid set to Exim's values.
40035 Ideally, any association with the calling process' uid/gid should be dropped,
40036 that is, the real uid/gid should be reset to the effective values so as to
40037 discard any privileges that the caller may have. While some operating systems
40038 have a function that permits this action for a non-root effective uid, quite a
40039 number of them do not. Because of this lack of standardization, Exim does not
40040 address this problem at this time.
40041
40042 For this reason, the recommended approach for &"mostly unprivileged"& running
40043 is to keep the Exim binary setuid to root, and to set
40044 &%deliver_drop_privilege%&. This also has the advantage of allowing a daemon to
40045 be used in the most straightforward way.
40046
40047 If you configure Exim not to run delivery processes as root, there are a
40048 number of restrictions on what you can do:
40049
40050 .ilist
40051 You can deliver only as the Exim user/group. You should  explicitly use the
40052 &%user%& and &%group%& options to override routers or local transports that
40053 normally deliver as the recipient. This makes sure that configurations that
40054 work in this mode function the same way in normal mode. Any implicit or
40055 explicit specification of another user causes an error.
40056 .next
40057 Use of &_.forward_& files is severely restricted, such that it is usually
40058 not worthwhile to include them in the configuration.
40059 .next
40060 Users who wish to use &_.forward_& would have to make their home directory and
40061 the file itself accessible to the Exim user. Pipe and append-to-file entries,
40062 and their equivalents in Exim filters, cannot be used. While they could be
40063 enabled in the Exim user's name, that would be insecure and not very useful.
40064 .next
40065 Unless the local user mailboxes are all owned by the Exim user (possible in
40066 some POP3 or IMAP-only environments):
40067
40068 .olist
40069 They must be owned by the Exim group and be writeable by that group. This
40070 implies you must set &%mode%& in the appendfile configuration, as well as the
40071 mode of the mailbox files themselves.
40072 .next
40073 You must set &%no_check_owner%&, since most or all of the files will not be
40074 owned by the Exim user.
40075 .next
40076 You must set &%file_must_exist%&, because Exim cannot set the owner correctly
40077 on a newly created mailbox when unprivileged. This also implies that new
40078 mailboxes need to be created manually.
40079 .endlist olist
40080 .endlist ilist
40081
40082
40083 These restrictions severely restrict what can be done in local deliveries.
40084 However, there are no restrictions on remote deliveries. If you are running a
40085 gateway host that does no local deliveries, setting &%deliver_drop_privilege%&
40086 gives more security at essentially no cost.
40087
40088 If you are using the &%mua_wrapper%& facility (see chapter
40089 &<<CHAPnonqueueing>>&), &%deliver_drop_privilege%& is forced to be true.
40090
40091
40092
40093
40094 .section "Delivering to local files" "SECID271"
40095 Full details of the checks applied by &(appendfile)& before it writes to a file
40096 are given in chapter &<<CHAPappendfile>>&.
40097
40098
40099
40100 .section "Running local commands" "SECTsecconslocalcmds"
40101 .cindex "security" "local commands"
40102 .cindex "security" "command injection attacks"
40103 There are a number of ways in which an administrator can configure Exim to run
40104 commands based upon received, untrustworthy, data. Further, in some
40105 configurations a user who can control a &_.forward_& file can also arrange to
40106 run commands. Configuration to check includes, but is not limited to:
40107
40108 .ilist
40109 Use of &%use_shell%& in the pipe transport: various forms of shell command
40110 injection may be possible with this option present. It is dangerous and should
40111 be used only with considerable caution. Consider constraints which whitelist
40112 allowed characters in a variable which is to be used in a pipe transport that
40113 has &%use_shell%& enabled.
40114 .next
40115 A number of options such as &%forbid_filter_run%&, &%forbid_filter_perl%&,
40116 &%forbid_filter_dlfunc%& and so forth which restrict facilities available to
40117 &_.forward_& files in a redirect router. If Exim is running on a central mail
40118 hub to which ordinary users do not have shell access, but home directories are
40119 NFS mounted (for instance) then administrators should review the list of these
40120 forbid options available, and should bear in mind that the options that may
40121 need forbidding can change as new features are added between releases.
40122 .next
40123 The &%${run...}%& expansion item does not use a shell by default, but
40124 administrators can configure use of &_/bin/sh_& as part of the command.
40125 Such invocations should be viewed with prejudicial suspicion.
40126 .next
40127 Administrators who use embedded Perl are advised to explore how Perl's
40128 taint checking might apply to their usage.
40129 .next
40130 Use of &%${expand...}%& is somewhat analogous to shell's eval builtin and
40131 administrators are well advised to view its use with suspicion, in case (for
40132 instance) it allows a local-part to contain embedded Exim directives.
40133 .next
40134 Use of &%${match_local_part...}%& and friends becomes more dangerous if
40135 Exim was built with EXPAND_LISTMATCH_RHS defined: the second string in
40136 each can reference arbitrary lists and files, rather than just being a list
40137 of opaque strings.
40138 The EXPAND_LISTMATCH_RHS option was added and set false by default because of
40139 real-world security vulnerabilities caused by its use with untrustworthy data
40140 injected in, for SQL injection attacks.
40141 Consider the use of the &%inlisti%& expansion condition instead.
40142 .endlist
40143
40144
40145
40146
40147 .section "Trust in configuration data" "SECTsecconfdata"
40148 .cindex "security" "data sources"
40149 .cindex "security" "regular expressions"
40150 .cindex "regular expressions" "security"
40151 .cindex "PCRE" "security"
40152 If configuration data for Exim can come from untrustworthy sources, there
40153 are some issues to be aware of:
40154
40155 .ilist
40156 Use of &%${expand...}%& may provide a path for shell injection attacks.
40157 .next
40158 Letting untrusted data provide a regular expression is unwise.
40159 .next
40160 Using &%${match...}%& to apply a fixed regular expression against untrusted
40161 data may result in pathological behaviour within PCRE.  Be aware of what
40162 "backtracking" means and consider options for being more strict with a regular
40163 expression. Avenues to explore include limiting what can match (avoiding &`.`&
40164 when &`[a-z0-9]`& or other character class will do), use of atomic grouping and
40165 possessive quantifiers or just not using regular expressions against untrusted
40166 data.
40167 .next
40168 It can be important to correctly use &%${quote:...}%&,
40169 &%${quote_local_part:...}%& and &%${quote_%&<&'lookup-type'&>&%:...}%& expansion
40170 items to ensure that data is correctly constructed.
40171 .next
40172 Some lookups might return multiple results, even though normal usage is only
40173 expected to yield one result.
40174 .endlist
40175
40176
40177
40178
40179 .section "IPv4 source routing" "SECID272"
40180 .cindex "source routing" "in IP packets"
40181 .cindex "IP source routing"
40182 Many operating systems suppress IP source-routed packets in the kernel, but
40183 some cannot be made to do this, so Exim does its own check. It logs incoming
40184 IPv4 source-routed TCP calls, and then drops them. Things are all different in
40185 IPv6. No special checking is currently done.
40186
40187
40188
40189 .section "The VRFY, EXPN, and ETRN commands in SMTP" "SECID273"
40190 Support for these SMTP commands is disabled by default. If required, they can
40191 be enabled by defining suitable ACLs.
40192
40193
40194
40195
40196 .section "Privileged users" "SECID274"
40197 .cindex "trusted users"
40198 .cindex "admin user"
40199 .cindex "privileged user"
40200 .cindex "user" "trusted"
40201 .cindex "user" "admin"
40202 Exim recognizes two sets of users with special privileges. Trusted users are
40203 able to submit new messages to Exim locally, but supply their own sender
40204 addresses and information about a sending host. For other users submitting
40205 local messages, Exim sets up the sender address from the uid, and doesn't
40206 permit a remote host to be specified.
40207
40208 .oindex "&%-f%&"
40209 However, an untrusted user is permitted to use the &%-f%& command line option
40210 in the special form &%-f <>%& to indicate that a delivery failure for the
40211 message should not cause an error report. This affects the message's envelope,
40212 but it does not affect the &'Sender:'& header. Untrusted users may also be
40213 permitted to use specific forms of address with the &%-f%& option by setting
40214 the &%untrusted_set_sender%& option.
40215
40216 Trusted users are used to run processes that receive mail messages from some
40217 other mail domain and pass them on to Exim for delivery either locally, or over
40218 the Internet. Exim trusts a caller that is running as root, as the Exim user,
40219 as any user listed in the &%trusted_users%& configuration option, or under any
40220 group listed in the &%trusted_groups%& option.
40221
40222 Admin users are permitted to do things to the messages on Exim's queue. They
40223 can freeze or thaw messages, cause them to be returned to their senders, remove
40224 them entirely, or modify them in various ways. In addition, admin users can run
40225 the Exim monitor and see all the information it is capable of providing, which
40226 includes the contents of files on the spool.
40227
40228 .oindex "&%-M%&"
40229 .oindex "&%-q%&"
40230 By default, the use of the &%-M%& and &%-q%& options to cause Exim to attempt
40231 delivery of messages on its queue is restricted to admin users. This
40232 restriction can be relaxed by setting the &%no_prod_requires_admin%& option.
40233 Similarly, the use of &%-bp%& (and its variants) to list the contents of the
40234 queue is also restricted to admin users. This restriction can be relaxed by
40235 setting &%no_queue_list_requires_admin%&.
40236
40237 Exim recognizes an admin user if the calling process is running as root or as
40238 the Exim user or if any of the groups associated with the calling process is
40239 the Exim group. It is not necessary actually to be running under the Exim
40240 group. However, if admin users who are not root or the Exim user are to access
40241 the contents of files on the spool via the Exim monitor (which runs
40242 unprivileged), Exim must be built to allow group read access to its spool
40243 files.
40244
40245 By default, regular users are trusted to perform basic testing and
40246 introspection commands, as themselves.  This setting can be tightened by
40247 setting the &%commandline_checks_require_admin%& option.
40248 This affects most of the checking options,
40249 such as &%-be%& and anything else &%-b*%&.
40250
40251
40252 .section "Spool files" "SECID275"
40253 .cindex "spool directory" "files"
40254 Exim's spool directory and everything it contains is owned by the Exim user and
40255 set to the Exim group. The mode for spool files is defined in the
40256 &_Local/Makefile_& configuration file, and defaults to 0640. This means that
40257 any user who is a member of the Exim group can access these files.
40258
40259
40260
40261 .section "Use of argv[0]" "SECID276"
40262 Exim examines the last component of &%argv[0]%&, and if it matches one of a set
40263 of specific strings, Exim assumes certain options. For example, calling Exim
40264 with the last component of &%argv[0]%& set to &"rsmtp"& is exactly equivalent
40265 to calling it with the option &%-bS%&. There are no security implications in
40266 this.
40267
40268
40269
40270 .section "Use of %f formatting" "SECID277"
40271 The only use made of &"%f"& by Exim is in formatting load average values. These
40272 are actually stored in integer variables as 1000 times the load average.
40273 Consequently, their range is limited and so therefore is the length of the
40274 converted output.
40275
40276
40277
40278 .section "Embedded Exim path" "SECID278"
40279 Exim uses its own path name, which is embedded in the code, only when it needs
40280 to re-exec in order to regain root privilege. Therefore, it is not root when it
40281 does so. If some bug allowed the path to get overwritten, it would lead to an
40282 arbitrary program's being run as exim, not as root.
40283
40284
40285
40286 .section "Dynamic module directory" "SECTdynmoddir"
40287 Any dynamically loadable modules must be installed into the directory
40288 defined in &`LOOKUP_MODULE_DIR`& in &_Local/Makefile_& for Exim to permit
40289 loading it.
40290
40291
40292 .section "Use of sprintf()" "SECID279"
40293 .cindex "&[sprintf()]&"
40294 A large number of occurrences of &"sprintf"& in the code are actually calls to
40295 &'string_sprintf()'&, a function that returns the result in malloc'd store.
40296 The intermediate formatting is done into a large fixed buffer by a function
40297 that runs through the format string itself, and checks the length of each
40298 conversion before performing it, thus preventing buffer overruns.
40299
40300 The remaining uses of &[sprintf()]& happen in controlled circumstances where
40301 the output buffer is known to be sufficiently long to contain the converted
40302 string.
40303
40304
40305
40306 .section "Use of debug_printf() and log_write()" "SECID280"
40307 Arbitrary strings are passed to both these functions, but they do their
40308 formatting by calling the function &'string_vformat()'&, which runs through
40309 the format string itself, and checks the length of each conversion.
40310
40311
40312
40313 .section "Use of strcat() and strcpy()" "SECID281"
40314 These are used only in cases where the output buffer is known to be large
40315 enough to hold the result.
40316 .ecindex IIDsecurcon
40317
40318
40319
40320
40321 . ////////////////////////////////////////////////////////////////////////////
40322 . ////////////////////////////////////////////////////////////////////////////
40323
40324 .chapter "Format of spool files" "CHAPspool"
40325 .scindex IIDforspo1 "format" "spool files"
40326 .scindex IIDforspo2 "spool directory" "format of files"
40327 .scindex IIDforspo3 "spool files" "format of"
40328 .cindex "spool files" "editing"
40329 A message on Exim's queue consists of two files, whose names are the message id
40330 followed by -D and -H, respectively. The data portion of the message is kept in
40331 the -D file on its own. The message's envelope, status, and headers are all
40332 kept in the -H file, whose format is described in this chapter. Each of these
40333 two files contains the final component of its own name as its first line. This
40334 is insurance against disk crashes where the directory is lost but the files
40335 themselves are recoverable.
40336
40337 The file formats may be changed, or new formats added, at any release.
40338 Spool files are not intended as an interface to other programs
40339 and should not be used as such.
40340
40341 Some people are tempted into editing -D files in order to modify messages. You
40342 need to be extremely careful if you do this; it is not recommended and you are
40343 on your own if you do it. Here are some of the pitfalls:
40344
40345 .ilist
40346 You must ensure that Exim does not try to deliver the message while you are
40347 fiddling with it. The safest way is to take out a write lock on the -D file,
40348 which is what Exim itself does, using &[fcntl()]&. If you update the file in
40349 place, the lock will be retained. If you write a new file and rename it, the
40350 lock will be lost at the instant of rename.
40351 .next
40352 .vindex "&$body_linecount$&"
40353 If you change the number of lines in the file, the value of
40354 &$body_linecount$&, which is stored in the -H file, will be incorrect and can
40355 cause incomplete transmission of messages or undeliverable messages.
40356 .next
40357 If the message is in MIME format, you must take care not to break it.
40358 .next
40359 If the message is cryptographically signed, any change will invalidate the
40360 signature.
40361 .endlist
40362 All in all, modifying -D files is fraught with danger.
40363
40364 Files whose names end with -J may also be seen in the &_input_& directory (or
40365 its subdirectories when &%split_spool_directory%& is set). These are journal
40366 files, used to record addresses to which the message has been delivered during
40367 the course of a delivery attempt. If there are still undelivered recipients at
40368 the end, the -H file is updated, and the -J file is deleted. If, however, there
40369 is some kind of crash (for example, a power outage) before this happens, the -J
40370 file remains in existence. When Exim next processes the message, it notices the
40371 -J file and uses it to update the -H file before starting the next delivery
40372 attempt.
40373
40374 Files whose names end with -K or .eml may also be seen in the spool.
40375 These are temporaries used for DKIM or malware processing, when that is used.
40376 They should be tidied up by normal operations; any old ones are probably
40377 relics of crashes and can be removed.
40378
40379 .section "Format of the -H file" "SECID282"
40380 .cindex "uid (user id)" "in spool file"
40381 .cindex "gid (group id)" "in spool file"
40382 The second line of the -H file contains the login name for the uid of the
40383 process that called Exim to read the message, followed by the numerical uid and
40384 gid. For a locally generated message, this is normally the user who sent the
40385 message. For a message received over TCP/IP via the daemon, it is
40386 normally the Exim user.
40387
40388 The third line of the file contains the address of the message's sender as
40389 transmitted in the envelope, contained in angle brackets. The sender address is
40390 empty for bounce messages. For incoming SMTP mail, the sender address is given
40391 in the MAIL command. For locally generated mail, the sender address is
40392 created by Exim from the login name of the current user and the configured
40393 &%qualify_domain%&. However, this can be overridden by the &%-f%& option or a
40394 leading &"From&~"& line if the caller is trusted, or if the supplied address is
40395 &"<>"& or an address that matches &%untrusted_set_senders%&.
40396
40397 The fourth line contains two numbers. The first is the time that the message
40398 was received, in the conventional Unix form &-- the number of seconds since the
40399 start of the epoch. The second number is a count of the number of messages
40400 warning of delayed delivery that have been sent to the sender.
40401
40402 There follow a number of lines starting with a hyphen. These can appear in any
40403 order, and are omitted when not relevant:
40404
40405 .vlist
40406 .vitem "&%-acl%&&~<&'number'&>&~<&'length'&>"
40407 This item is obsolete, and is not generated from Exim release 4.61 onwards;
40408 &%-aclc%& and &%-aclm%& are used instead. However, &%-acl%& is still
40409 recognized, to provide backward compatibility. In the old format, a line of
40410 this form is present for every ACL variable that is not empty. The number
40411 identifies the variable; the &%acl_c%&&*x*& variables are numbered 0&--9 and
40412 the &%acl_m%&&*x*& variables are numbered 10&--19. The length is the length of
40413 the data string for the variable. The string itself starts at the beginning of
40414 the next line, and is followed by a newline character. It may contain internal
40415 newlines.
40416
40417 .vitem "&%-aclc%&&~<&'rest-of-name'&>&~<&'length'&>"
40418 A line of this form is present for every ACL connection variable that is
40419 defined. Note that there is a space between &%-aclc%& and the rest of the name.
40420 The length is the length of the data string for the variable. The string itself
40421 starts at the beginning of the next line, and is followed by a newline
40422 character. It may contain internal newlines.
40423
40424 .vitem "&%-aclm%&&~<&'rest-of-name'&>&~<&'length'&>"
40425 A line of this form is present for every ACL message variable that is defined.
40426 Note that there is a space between &%-aclm%& and the rest of the name. The
40427 length is the length of the data string for the variable. The string itself
40428 starts at the beginning of the next line, and is followed by a newline
40429 character. It may contain internal newlines.
40430
40431 .vitem "&%-active_hostname%&&~<&'hostname'&>"
40432 This is present if, when the message was received over SMTP, the value of
40433 &$smtp_active_hostname$& was different to the value of &$primary_hostname$&.
40434
40435 .vitem &%-allow_unqualified_recipient%&
40436 This is present if unqualified recipient addresses are permitted in header
40437 lines (to stop such addresses from being qualified if rewriting occurs at
40438 transport time). Local messages that were input using &%-bnq%& and remote
40439 messages from hosts that match &%recipient_unqualified_hosts%& set this flag.
40440
40441 .vitem &%-allow_unqualified_sender%&
40442 This is present if unqualified sender addresses are permitted in header lines
40443 (to stop such addresses from being qualified if rewriting occurs at transport
40444 time). Local messages that were input using &%-bnq%& and remote messages from
40445 hosts that match &%sender_unqualified_hosts%& set this flag.
40446
40447 .vitem "&%-auth_id%&&~<&'text'&>"
40448 The id information for a message received on an authenticated SMTP connection
40449 &-- the value of the &$authenticated_id$& variable.
40450
40451 .vitem "&%-auth_sender%&&~<&'address'&>"
40452 The address of an authenticated sender &-- the value of the
40453 &$authenticated_sender$& variable.
40454
40455 .vitem "&%-body_linecount%&&~<&'number'&>"
40456 This records the number of lines in the body of the message, and is
40457 present unless &%-spool_file_wireformat%& is.
40458
40459 .vitem "&%-body_zerocount%&&~<&'number'&>"
40460 This records the number of binary zero bytes in the body of the message, and is
40461 present if the number is greater than zero.
40462
40463 .vitem &%-deliver_firsttime%&
40464 This is written when a new message is first added to the spool. When the spool
40465 file is updated after a deferral, it is omitted.
40466
40467 .vitem "&%-frozen%&&~<&'time'&>"
40468 .cindex "frozen messages" "spool data"
40469 The message is frozen, and the freezing happened at <&'time'&>.
40470
40471 .vitem "&%-helo_name%&&~<&'text'&>"
40472 This records the host name as specified by a remote host in a HELO or EHLO
40473 command.
40474
40475 .vitem "&%-host_address%&&~<&'address'&>.<&'port'&>"
40476 This records the IP address of the host from which the message was received and
40477 the remote port number that was used. It is omitted for locally generated
40478 messages.
40479
40480 .vitem "&%-host_auth%&&~<&'text'&>"
40481 If the message was received on an authenticated SMTP connection, this records
40482 the name of the authenticator &-- the value of the
40483 &$sender_host_authenticated$& variable.
40484
40485 .vitem &%-host_lookup_failed%&
40486 This is present if an attempt to look up the sending host's name from its IP
40487 address failed. It corresponds to the &$host_lookup_failed$& variable.
40488
40489 .vitem "&%-host_name%&&~<&'text'&>"
40490 .cindex "reverse DNS lookup"
40491 .cindex "DNS" "reverse lookup"
40492 This records the name of the remote host from which the message was received,
40493 if the host name was looked up from the IP address when the message was being
40494 received. It is not present if no reverse lookup was done.
40495
40496 .vitem "&%-ident%&&~<&'text'&>"
40497 For locally submitted messages, this records the login of the originating user,
40498 unless it was a trusted user and the &%-oMt%& option was used to specify an
40499 ident value. For messages received over TCP/IP, this records the ident string
40500 supplied by the remote host, if any.
40501
40502 .vitem "&%-interface_address%&&~<&'address'&>.<&'port'&>"
40503 This records the IP address of the local interface and the port number through
40504 which a message was received from a remote host. It is omitted for locally
40505 generated messages.
40506
40507 .vitem &%-local%&
40508 The message is from a local sender.
40509
40510 .vitem &%-localerror%&
40511 The message is a locally-generated bounce message.
40512
40513 .vitem "&%-local_scan%&&~<&'string'&>"
40514 This records the data string that was returned by the &[local_scan()]& function
40515 when the message was received &-- the value of the &$local_scan_data$&
40516 variable. It is omitted if no data was returned.
40517
40518 .vitem &%-manual_thaw%&
40519 The message was frozen but has been thawed manually, that is, by an explicit
40520 Exim command rather than via the auto-thaw process.
40521
40522 .vitem &%-N%&
40523 A testing delivery process was started using the &%-N%& option to suppress any
40524 actual deliveries, but delivery was deferred. At any further delivery attempts,
40525 &%-N%& is assumed.
40526
40527 .vitem &%-received_protocol%&
40528 This records the value of the &$received_protocol$& variable, which contains
40529 the name of the protocol by which the message was received.
40530
40531 .vitem &%-sender_set_untrusted%&
40532 The envelope sender of this message was set by an untrusted local caller (used
40533 to ensure that the caller is displayed in queue listings).
40534
40535 .vitem "&%-spam_score_int%&&~<&'number'&>"
40536 If a message was scanned by SpamAssassin, this is present. It records the value
40537 of &$spam_score_int$&.
40538
40539 .vitem &%-spool_file_wireformat%&
40540 The -D file for this message is in wire-format (for ESMTP CHUNKING)
40541 rather than Unix-format.
40542 The line-ending is CRLF rather than newline.
40543 There is still, however, no leading-dot-stuffing.
40544
40545 .vitem &%-tls_certificate_verified%&
40546 A TLS certificate was received from the client that sent this message, and the
40547 certificate was verified by the server.
40548
40549 .vitem "&%-tls_cipher%&&~<&'cipher name'&>"
40550 When the message was received over an encrypted connection, this records the
40551 name of the cipher suite that was used.
40552
40553 .vitem "&%-tls_peerdn%&&~<&'peer DN'&>"
40554 When the message was received over an encrypted connection, and a certificate
40555 was received from the client, this records the Distinguished Name from that
40556 certificate.
40557 .endlist
40558
40559 Any of the above may have an extra hyphen prepended, to indicate the the
40560 corresponding data is untrusted.
40561
40562 Following the options there is a list of those addresses to which the message
40563 is not to be delivered. This set of addresses is initialized from the command
40564 line when the &%-t%& option is used and &%extract_addresses_remove_arguments%&
40565 is set; otherwise it starts out empty. Whenever a successful delivery is made,
40566 the address is added to this set. The addresses are kept internally as a
40567 balanced binary tree, and it is a representation of that tree which is written
40568 to the spool file. If an address is expanded via an alias or forward file, the
40569 original address is added to the tree when deliveries to all its child
40570 addresses are complete.
40571
40572 If the tree is empty, there is a single line in the spool file containing just
40573 the text &"XX"&. Otherwise, each line consists of two letters, which are either
40574 Y or N, followed by an address. The address is the value for the node of the
40575 tree, and the letters indicate whether the node has a left branch and/or a
40576 right branch attached to it, respectively. If branches exist, they immediately
40577 follow. Here is an example of a three-node tree:
40578 .code
40579 YY darcy@austen.fict.example
40580 NN alice@wonderland.fict.example
40581 NN editor@thesaurus.ref.example
40582 .endd
40583 After the non-recipients tree, there is a list of the message's recipients.
40584 This is a simple list, preceded by a count. It includes all the original
40585 recipients of the message, including those to whom the message has already been
40586 delivered. In the simplest case, the list contains one address per line. For
40587 example:
40588 .code
40589 4
40590 editor@thesaurus.ref.example
40591 darcy@austen.fict.example
40592 rdo@foundation
40593 alice@wonderland.fict.example
40594 .endd
40595 However, when a child address has been added to the top-level addresses as a
40596 result of the use of the &%one_time%& option on a &(redirect)& router, each
40597 line is of the following form:
40598 .display
40599 <&'top-level address'&> <&'errors_to address'&> &&&
40600   <&'length'&>,<&'parent number'&>#<&'flag bits'&>
40601 .endd
40602 The 01 flag bit indicates the presence of the three other fields that follow
40603 the top-level address. Other bits may be used in future to support additional
40604 fields. The <&'parent number'&> is the offset in the recipients list of the
40605 original parent of the &"one time"& address. The first two fields are the
40606 envelope sender that is associated with this address and its length. If the
40607 length is zero, there is no special envelope sender (there are then two space
40608 characters in the line). A non-empty field can arise from a &(redirect)& router
40609 that has an &%errors_to%& setting.
40610
40611
40612 A blank line separates the envelope and status information from the headers
40613 which follow. A header may occupy several lines of the file, and to save effort
40614 when reading it in, each header is preceded by a number and an identifying
40615 character. The number is the number of characters in the header, including any
40616 embedded newlines and the terminating newline. The character is one of the
40617 following:
40618
40619 .table2 50pt
40620 .row <&'blank'&>         "header in which Exim has no special interest"
40621 .row &`B`&               "&'Bcc:'& header"
40622 .row &`C`&               "&'Cc:'& header"
40623 .row &`F`&               "&'From:'& header"
40624 .row &`I`&               "&'Message-id:'& header"
40625 .row &`P`&               "&'Received:'& header &-- P for &""postmark""&"
40626 .row &`R`&               "&'Reply-To:'& header"
40627 .row &`S`&               "&'Sender:'& header"
40628 .row &`T`&               "&'To:'& header"
40629 .row &`*`&               "replaced or deleted header"
40630 .endtable
40631
40632 Deleted or replaced (rewritten) headers remain in the spool file for debugging
40633 purposes. They are not transmitted when the message is delivered. Here is a
40634 typical set of headers:
40635 .code
40636 111P Received: by hobbit.fict.example with local (Exim 4.00)
40637 id 14y9EI-00026G-00; Fri, 11 May 2001 10:28:59 +0100
40638 049  Message-Id: <E14y9EI-00026G-00@hobbit.fict.example>
40639 038* X-rewrote-sender: bb@hobbit.fict.example
40640 042* From: Bilbo Baggins <bb@hobbit.fict.example>
40641 049F From: Bilbo Baggins <B.Baggins@hobbit.fict.example>
40642 099* To: alice@wonderland.fict.example, rdo@foundation,
40643 darcy@austen.fict.example, editor@thesaurus.ref.example
40644 104T To: alice@wonderland.fict.example, rdo@foundation.example,
40645 darcy@austen.fict.example, editor@thesaurus.ref.example
40646 038  Date: Fri, 11 May 2001 10:28:59 +0100
40647 .endd
40648 The asterisked headers indicate that the envelope sender, &'From:'& header, and
40649 &'To:'& header have been rewritten, the last one because routing expanded the
40650 unqualified domain &'foundation'&.
40651 .ecindex IIDforspo1
40652 .ecindex IIDforspo2
40653 .ecindex IIDforspo3
40654
40655 .section "Format of the -D file" "SECID282a"
40656 The data file is traditionally in Unix-standard format: lines are ended with
40657 an ASCII newline character.
40658 However, when the &%spool_wireformat%& main option is used some -D files
40659 can have an alternate format.
40660 This is flagged by a &%-spool_file_wireformat%& line in the corresponding -H file.
40661 The -D file lines (not including the first name-component line) are
40662 suitable for direct copying to the wire when transmitting using the
40663 ESMTP CHUNKING option, meaning lower processing overhead.
40664 Lines are terminated with an ASCII CRLF pair.
40665 There is no dot-stuffing (and no dot-termination).
40666
40667 . ////////////////////////////////////////////////////////////////////////////
40668 . ////////////////////////////////////////////////////////////////////////////
40669
40670 .chapter "DKIM, SPF, SRS and DMARC" "CHAPdkim" &&&
40671          "DKIM, SPF, SRS and DMARC Support"
40672
40673 .section "DKIM (DomainKeys Identified Mail)" SECDKIM
40674 .cindex "DKIM"
40675
40676 DKIM is a mechanism by which messages sent by some entity can be provably
40677 linked to a domain which that entity controls.  It permits reputation to
40678 be tracked on a per-domain basis, rather than merely upon source IP address.
40679 DKIM is documented in RFC 6376.
40680
40681 As DKIM relies on the message being unchanged in transit, messages handled
40682 by a mailing-list (which traditionally adds to the message) will not match
40683 any original DKIM signature.
40684
40685 DKIM support is compiled into Exim by default if TLS support is present.
40686 It can be disabled by setting DISABLE_DKIM=yes in &_Local/Makefile_&.
40687
40688 Exim's DKIM implementation allows for
40689 .olist
40690 Signing outgoing messages: This function is implemented in the SMTP transport.
40691 It can co-exist with all other Exim features
40692 (including transport filters)
40693 except cutthrough delivery.
40694 .next
40695 Verifying signatures in incoming messages: This is implemented by an additional
40696 ACL (acl_smtp_dkim), which can be called several times per message, with
40697 different signature contexts.
40698 .endlist
40699
40700 In typical Exim style, the verification implementation does not include any
40701 default "policy". Instead it enables you to build your own policy using
40702 Exim's standard controls.
40703
40704 Please note that verification of DKIM signatures in incoming mail is turned
40705 on by default for logging (in the <= line) purposes.
40706
40707 Additional log detail can be enabled using the &%dkim_verbose%& log_selector.
40708 When set, for each signature in incoming email,
40709 exim will log a line displaying the most important signature details, and the
40710 signature status. Here is an example (with line-breaks added for clarity):
40711 .code
40712 2009-09-09 10:22:28 1MlIRf-0003LU-U3 DKIM:
40713     d=facebookmail.com s=q1-2009b
40714     c=relaxed/relaxed a=rsa-sha1
40715     i=@facebookmail.com t=1252484542 [verification succeeded]
40716 .endd
40717
40718 You might want to turn off DKIM verification processing entirely for internal
40719 or relay mail sources. To do that, set the &%dkim_disable_verify%& ACL
40720 control modifier. This should typically be done in the RCPT ACL, at points
40721 where you accept mail from relay sources (internal hosts or authenticated
40722 senders).
40723
40724
40725 .section "Signing outgoing messages" "SECDKIMSIGN"
40726 .cindex "DKIM" "signing"
40727
40728 For signing to be usable you must have published a DKIM record in DNS.
40729 Note that RFC 8301 (which does not cover EC keys) says:
40730 .code
40731 rsa-sha1 MUST NOT be used for signing or verifying.
40732
40733 Signers MUST use RSA keys of at least 1024 bits for all keys.
40734 Signers SHOULD use RSA keys of at least 2048 bits.
40735 .endd
40736
40737 Note also that the key content (the 'p=' field)
40738 in the DNS record is different between RSA and EC keys;
40739 for the former it is the base64 of the ASN.1 for the RSA public key
40740 (equivalent to the private-key .pem with the header/trailer stripped)
40741 but for EC keys it is the base64 of the pure key; no ASN.1 wrapping.
40742
40743 Signing is enabled by setting private options on the SMTP transport.
40744 These options take (expandable) strings as arguments.
40745
40746 .option dkim_domain smtp string list&!! unset
40747 The domain(s) you want to sign with.
40748 After expansion, this can be a list.
40749 Each element in turn,
40750 lowercased,
40751 is put into the &%$dkim_domain%& expansion variable
40752 while expanding the remaining signing options.
40753 If it is empty after expansion, DKIM signing is not done,
40754 and no error will result even if &%dkim_strict%& is set.
40755
40756 .option dkim_selector smtp string list&!! unset
40757 This sets the key selector string.
40758 After expansion, which can use &$dkim_domain$&, this can be a list.
40759 Each element in turn is put in the expansion
40760 variable &%$dkim_selector%& which may be used in the &%dkim_private_key%&
40761 option along with &%$dkim_domain%&.
40762 If the option is empty after expansion, DKIM signing is not done for this domain,
40763 and no error will result even if &%dkim_strict%& is set.
40764
40765 .option dkim_private_key smtp string&!! unset
40766 This sets the private key to use.
40767 You can use the &%$dkim_domain%& and
40768 &%$dkim_selector%& expansion variables to determine the private key to use.
40769 The result can either
40770 .ilist
40771 be a valid RSA private key in ASCII armor (.pem file), including line breaks
40772 .next
40773 with GnuTLS 3.6.0 or OpenSSL 1.1.1 or later,
40774 be a valid Ed25519 private key (same format as above)
40775 .next
40776 start with a slash, in which case it is treated as a file that contains
40777 the private key
40778 .next
40779 be "0", "false" or the empty string, in which case the message will not
40780 be signed. This case will not result in an error, even if &%dkim_strict%&
40781 is set.
40782 .endlist
40783
40784 To generate keys under OpenSSL:
40785 .code
40786 openssl genrsa -out dkim_rsa.private 2048
40787 openssl rsa -in dkim_rsa.private -out /dev/stdout -pubout -outform PEM
40788 .endd
40789 The result file from the first command should be retained, and
40790 this option set to use it.
40791 Take the base-64 lines from the output of the second command, concatenated,
40792 for the DNS TXT record.
40793 See section 3.6 of RFC6376 for the record specification.
40794
40795 Under GnuTLS:
40796 .code
40797 certtool --generate-privkey --rsa --bits=2048 --password='' -8 --outfile=dkim_rsa.private
40798 certtool --load-privkey=dkim_rsa.private --pubkey-info
40799 .endd
40800
40801 Note that RFC 8301 says:
40802 .code
40803 Signers MUST use RSA keys of at least 1024 bits for all keys.
40804 Signers SHOULD use RSA keys of at least 2048 bits.
40805 .endd
40806
40807 EC keys for DKIM are defined by RFC 8463.
40808 They are considerably smaller than RSA keys for equivalent protection.
40809 As they are a recent development, users should consider dual-signing
40810 (by setting a list of selectors, and an expansion for this option)
40811 for some transition period.
40812 The "_CRYPTO_SIGN_ED25519" macro will be defined if support is present
40813 for EC keys.
40814
40815 OpenSSL 1.1.1 and GnuTLS 3.6.0 can create Ed25519 private keys:
40816 .code
40817 openssl genpkey -algorithm ed25519 -out dkim_ed25519.private
40818 certtool --generate-privkey --key-type=ed25519 --outfile=dkim_ed25519.private
40819 .endd
40820
40821 To produce the required public key value for a DNS record:
40822 .code
40823 openssl pkey -outform DER -pubout -in dkim_ed25519.private | tail -c +13 | base64
40824 certtool --load_privkey=dkim_ed25519.private --pubkey_info --outder | tail -c +13 | base64
40825 .endd
40826
40827 Exim also supports an alternate format
40828 of Ed25519 keys in DNS which was a candidate during development
40829 of the standard, but not adopted.
40830 A future release will probably drop that support.
40831
40832 .option dkim_hash smtp string&!! sha256
40833 Can be set to any one of the supported hash methods, which are:
40834 .ilist
40835 &`sha1`& &-- should not be used, is old and insecure
40836 .next
40837 &`sha256`& &-- the default
40838 .next
40839 &`sha512`& &-- possibly more secure but less well supported
40840 .endlist
40841
40842 Note that RFC 8301 says:
40843 .code
40844 rsa-sha1 MUST NOT be used for signing or verifying.
40845 .endd
40846
40847 .option dkim_identity smtp string&!! unset
40848 If set after expansion, the value is used to set an "i=" tag in
40849 the signing header.  The DKIM standards restrict the permissible
40850 syntax of this optional tag to a mail address, with possibly-empty
40851 local part, an @, and a domain identical to or subdomain of the "d="
40852 tag value.  Note that Exim does not check the value.
40853
40854 .option dkim_canon smtp string&!! unset
40855 This option sets the canonicalization method used when signing a message.
40856 The DKIM RFC currently supports two methods: "simple" and "relaxed".
40857 The option defaults to "relaxed" when unset. Note: the current implementation
40858 only supports signing with the same canonicalization method for both headers and body.
40859
40860 .option dkim_strict smtp string&!! unset
40861 This  option  defines  how  Exim  behaves  when  signing a message that
40862 should be signed fails for some reason.  When the expansion evaluates to
40863 either &"1"& or &"true"&, Exim will defer. Otherwise Exim will send the message
40864 unsigned. You can use the &%$dkim_domain%& and &%$dkim_selector%& expansion
40865 variables here.
40866
40867 .option dkim_sign_headers smtp string&!! "see below"
40868 If set, this option must expand to a colon-separated
40869 list of header names.
40870 Headers with these names, or the absence or such a header, will be included
40871 in the message signature.
40872 When unspecified, the header names listed in RFC4871 will be used,
40873 whether or not each header is present in the message.
40874 The default list is available for the expansion in the macro
40875 &"_DKIM_SIGN_HEADERS"&
40876 and an oversigning variant is in &"_DKIM_OVERSIGN_HEADERS"&.
40877
40878 If a name is repeated, multiple headers by that name (or the absence thereof)
40879 will be signed.  The textually later headers in the headers part of the
40880 message are signed first, if there are multiples.
40881
40882 A name can be prefixed with either an &"="& or a &"+"& character.
40883 If an &"="& prefix is used, all headers that are present with this name
40884 will be signed.
40885 If a &"+"& prefix if used, all headers that are present with this name
40886 will be signed, and one signature added for a missing header with the
40887 name will be appended.
40888
40889 .option dkim_timestamps smtp integer&!! unset
40890 This option controls the inclusion of timestamp information in the signature.
40891 If not set, no such information will be included.
40892 Otherwise, must be an unsigned number giving an offset in seconds from the current time
40893 for the expiry tag
40894 (eg. 1209600 for two weeks);
40895 both creation (t=) and expiry (x=) tags will be included.
40896
40897 RFC 6376 lists these tags as RECOMMENDED.
40898
40899
40900 .section "Verifying DKIM signatures in incoming mail" "SECDKIMVFY"
40901 .cindex "DKIM" "verification"
40902
40903 Verification of DKIM signatures in SMTP incoming email is done for all
40904 messages for which an ACL control &%dkim_disable_verify%& has not been set.
40905 .cindex DKIM "selecting signature algorithms"
40906 Individual classes of signature algorithm can be ignored by changing
40907 the main options &%dkim_verify_hashes%& or &%dkim_verify_keytypes%&.
40908 The &%dkim_verify_minimal%& option can be set to cease verification
40909 processing for a message once the first passing signature is found.
40910
40911 .cindex authentication "expansion item"
40912 Performing verification sets up information used by the
40913 &%authresults%& expansion item.
40914
40915 For most purposes the default option settings suffice and the remainder
40916 of this section can be ignored.
40917
40918 The results of verification are made available to the
40919 &%acl_smtp_dkim%& ACL, which can examine and modify them.
40920 A missing ACL definition defaults to accept.
40921 By default, the ACL is called once for each
40922 syntactically(!) correct signature in the incoming message.
40923 If any ACL call does not accept, the message is not accepted.
40924 If a cutthrough delivery was in progress for the message, that is
40925 summarily dropped (having wasted the transmission effort).
40926
40927 To evaluate the verification result in the ACL
40928 a large number of expansion variables
40929 containing the signature status and its details are set up during the
40930 runtime of the ACL.
40931
40932 Calling the ACL only for existing signatures is not sufficient to build
40933 more advanced policies. For that reason, the main option
40934 &%dkim_verify_signers%&, and an expansion variable
40935 &%$dkim_signers%& exist.
40936
40937 The main option &%dkim_verify_signers%& can be set to a colon-separated
40938 list of DKIM domains or identities for which the ACL &%acl_smtp_dkim%& is
40939 called. It is expanded when the message has been received. At this point,
40940 the expansion variable &%$dkim_signers%& already contains a colon-separated
40941 list of signer domains and identities for the message. When
40942 &%dkim_verify_signers%& is not specified in the main configuration,
40943 it defaults as:
40944 .code
40945 dkim_verify_signers = $dkim_signers
40946 .endd
40947 This leads to the default behaviour of calling &%acl_smtp_dkim%& for each
40948 DKIM signature in the message. Current DKIM verifiers may want to explicitly
40949 call the ACL for known domains or identities. This would be achieved as follows:
40950 .code
40951 dkim_verify_signers = paypal.com:ebay.com:$dkim_signers
40952 .endd
40953 This would result in &%acl_smtp_dkim%& always being called for "paypal.com"
40954 and "ebay.com", plus all domains and identities that have signatures in the message.
40955 You can also be more creative in constructing your policy. For example:
40956 .code
40957 dkim_verify_signers = $sender_address_domain:$dkim_signers
40958 .endd
40959
40960 If a domain or identity is listed several times in the (expanded) value of
40961 &%dkim_verify_signers%&, the ACL is only called once for that domain or identity.
40962
40963 Note that if the option is set using untrustworthy data
40964 (such as the From: header)
40965 care should be taken to force lowercase for domains
40966 and for the domain part if identities.
40967 The default setting can be regarded as trustworthy in this respect.
40968
40969 If multiple signatures match a domain (or identity), the ACL is called once
40970 for each matching signature.
40971
40972
40973 Inside the DKIM ACL, the following expansion variables are
40974 available (from most to least important):
40975
40976
40977 .vlist
40978 .vitem &%$dkim_cur_signer%&
40979 The signer that is being evaluated in this ACL run. This can be a domain or
40980 an identity. This is one of the list items from the expanded main option
40981 &%dkim_verify_signers%& (see above).
40982
40983 .vitem &%$dkim_verify_status%&
40984 Within the DKIM ACL,
40985 a string describing the general status of the signature. One of
40986 .ilist
40987 &%none%&: There is no signature in the message for the current domain or
40988 identity (as reflected by &%$dkim_cur_signer%&).
40989 .next
40990 &%invalid%&: The signature could not be verified due to a processing error.
40991 More detail is available in &%$dkim_verify_reason%&.
40992 .next
40993 &%fail%&: Verification of the signature failed.  More detail is
40994 available in &%$dkim_verify_reason%&.
40995 .next
40996 &%pass%&: The signature passed verification. It is valid.
40997 .endlist
40998
40999 This variable can be overwritten using an ACL 'set' modifier.
41000 This might, for instance, be done to enforce a policy restriction on
41001 hash-method or key-size:
41002 .code
41003   warn condition       = ${if eq {$dkim_verify_status}{pass}}
41004        condition       = ${if eq {${length_3:$dkim_algo}}{rsa}}
41005        condition       = ${if or {{eq {$dkim_algo}{rsa-sha1}} \
41006                                   {< {$dkim_key_length}{1024}}}}
41007        logwrite        = NOTE: forcing DKIM verify fail (was pass)
41008        set dkim_verify_status = fail
41009        set dkim_verify_reason = hash too weak or key too short
41010 .endd
41011
41012 So long as a DKIM ACL is defined (it need do no more than accept),
41013 after all the DKIM ACL runs have completed, the value becomes a
41014 colon-separated list of the values after each run.
41015 This is maintained for the mime, prdr and data ACLs.
41016
41017 .vitem &%$dkim_verify_reason%&
41018 A string giving a little bit more detail when &%$dkim_verify_status%& is either
41019 "fail" or "invalid". One of
41020 .ilist
41021 &%pubkey_unavailable%& (when &%$dkim_verify_status%&="invalid"): The public
41022 key for the domain could not be retrieved. This may be a temporary problem.
41023 .next
41024 &%pubkey_syntax%& (when &%$dkim_verify_status%&="invalid"): The public key
41025 record for the domain is syntactically invalid.
41026 .next
41027 &%bodyhash_mismatch%& (when &%$dkim_verify_status%&="fail"): The calculated
41028 body hash does not match the one specified in the signature header. This
41029 means that the message body was modified in transit.
41030 .next
41031 &%signature_incorrect%& (when &%$dkim_verify_status%&="fail"): The signature
41032 could not be verified. This may mean that headers were modified,
41033 re-written or otherwise changed in a way which is incompatible with
41034 DKIM verification. It may of course also mean that the signature is forged.
41035 .endlist
41036
41037 This variable can be overwritten, with any value, using an ACL 'set' modifier.
41038
41039 .vitem &%$dkim_domain%&
41040 The signing domain. IMPORTANT: This variable is only populated if there is
41041 an actual signature in the message for the current domain or identity (as
41042 reflected by &%$dkim_cur_signer%&).
41043
41044 .vitem &%$dkim_identity%&
41045 The signing identity, if present. IMPORTANT: This variable is only populated
41046 if there is an actual signature in the message for the current domain or
41047 identity (as reflected by &%$dkim_cur_signer%&).
41048
41049 .vitem &%$dkim_selector%&
41050 The key record selector string.
41051
41052 .vitem &%$dkim_algo%&
41053 The algorithm used. One of 'rsa-sha1' or 'rsa-sha256'.
41054 If running under GnuTLS 3.6.0 or OpenSSL 1.1.1 or later,
41055 may also be 'ed25519-sha256'.
41056 The "_CRYPTO_SIGN_ED25519" macro will be defined if support is present
41057 for EC keys.
41058
41059 Note that RFC 8301 says:
41060 .code
41061 rsa-sha1 MUST NOT be used for signing or verifying.
41062
41063 DKIM signatures identified as having been signed with historic
41064 algorithms (currently, rsa-sha1) have permanently failed evaluation
41065 .endd
41066
41067 To enforce this you must either have a DKIM ACL which checks this variable
41068 and overwrites the &$dkim_verify_status$& variable as discussed above,
41069 or have set the main option &%dkim_verify_hashes%& to exclude
41070 processing of such signatures.
41071
41072 .vitem &%$dkim_canon_body%&
41073 The body canonicalization method. One of 'relaxed' or 'simple'.
41074
41075 .vitem &%$dkim_canon_headers%&
41076 The header canonicalization method. One of 'relaxed' or 'simple'.
41077
41078 .vitem &%$dkim_copiedheaders%&
41079 A transcript of headers and their values which are included in the signature
41080 (copied from the 'z=' tag of the signature).
41081 Note that RFC6376 requires that verification fail if the From: header is
41082 not included in the signature.  Exim does not enforce this; sites wishing
41083 strict enforcement should code the check explicitly.
41084
41085 .vitem &%$dkim_bodylength%&
41086 The number of signed body bytes. If zero ("0"), the body is unsigned. If no
41087 limit was set by the signer, "9999999999999" is returned. This makes sure
41088 that this variable always expands to an integer value.
41089 &*Note:*& The presence of the signature tag specifying a signing body length
41090 is one possible route to spoofing of valid DKIM signatures.
41091 A paranoid implementation might wish to regard signature where this variable
41092 shows less than the "no limit" return as being invalid.
41093
41094 .vitem &%$dkim_created%&
41095 UNIX timestamp reflecting the date and time when the signature was created.
41096 When this was not specified by the signer, "0" is returned.
41097
41098 .vitem &%$dkim_expires%&
41099 UNIX timestamp reflecting the date and time when the signer wants the
41100 signature to be treated as "expired". When this was not specified by the
41101 signer, "9999999999999" is returned. This makes it possible to do useful
41102 integer size comparisons against this value.
41103 Note that Exim does not check this value.
41104
41105 .vitem &%$dkim_headernames%&
41106 A colon-separated list of names of headers included in the signature.
41107
41108 .vitem &%$dkim_key_testing%&
41109 "1" if the key record has the "testing" flag set, "0" if not.
41110
41111 .vitem &%$dkim_key_nosubdomains%&
41112 "1" if the key record forbids subdomaining, "0" otherwise.
41113
41114 .vitem &%$dkim_key_srvtype%&
41115 Service type (tag s=) from the key record. Defaults to "*" if not specified
41116 in the key record.
41117
41118 .vitem &%$dkim_key_granularity%&
41119 Key granularity (tag g=) from the key record. Defaults to "*" if not specified
41120 in the key record.
41121
41122 .vitem &%$dkim_key_notes%&
41123 Notes from the key record (tag n=).
41124
41125 .vitem &%$dkim_key_length%&
41126 Number of bits in the key.
41127 Valid only once the key is loaded, which is at the time the header signature
41128 is verified, which is after the body hash is.
41129
41130 Note that RFC 8301 says:
41131 .code
41132 Verifiers MUST NOT consider signatures using RSA keys of
41133 less than 1024 bits as valid signatures.
41134 .endd
41135
41136 This is enforced by the default setting for the &%dkim_verify_min_keysizes%&
41137 option.
41138
41139 .endlist
41140
41141 In addition, two ACL conditions are provided:
41142
41143 .vlist
41144 .vitem &%dkim_signers%&
41145 ACL condition that checks a colon-separated list of domains or identities
41146 for a match against the domain or identity that the ACL is currently verifying
41147 (reflected by &%$dkim_cur_signer%&). This is typically used to restrict an ACL
41148 verb to a group of domains or identities. For example:
41149
41150 .code
41151 # Warn when Mail purportedly from GMail has no gmail signature
41152 warn sender_domains = gmail.com
41153      dkim_signers = gmail.com
41154      dkim_status = none
41155      log_message = GMail sender without gmail.com DKIM signature
41156 .endd
41157
41158 Note that the above does not check for a total lack of DKIM signing;
41159 for that check for empty &$h_DKIM-Signature:$& in the data ACL.
41160
41161 .vitem &%dkim_status%&
41162 ACL condition that checks a colon-separated list of possible DKIM verification
41163 results against the actual result of verification. This is typically used
41164 to restrict an ACL verb to a list of verification outcomes, for example:
41165
41166 .code
41167 deny sender_domains = paypal.com:paypal.de
41168      dkim_signers = paypal.com:paypal.de
41169      dkim_status = none:invalid:fail
41170      message = Mail from Paypal with invalid/missing signature
41171 .endd
41172
41173 The possible status keywords are: 'none','invalid','fail' and 'pass'. Please
41174 see the documentation of the &%$dkim_verify_status%& expansion variable above
41175 for more information of what they mean.
41176 .endlist
41177
41178
41179
41180
41181 .section "SPF (Sender Policy Framework)" SECSPF
41182 .cindex SPF verification
41183
41184 SPF is a mechanism whereby a domain may assert which IP addresses may transmit
41185 messages with its domain in the envelope from, documented by RFC 7208.
41186 For more information on SPF see &url(http://www.open-spf.org), a static copy of
41187 the &url(http://openspf.org).
41188 . --- 2019-10-28: still not https, open-spf.org is told to be a
41189 . --- web-archive copy of the now dead openspf.org site
41190 . --- See https://www.mail-archive.com/mailop@mailop.org/msg08019.html for a
41191 . --- discussion.
41192
41193 Messages sent by a system not authorised will fail checking of such assertions.
41194 This includes retransmissions done by traditional forwarders.
41195
41196 SPF verification support is built into Exim if SUPPORT_SPF=yes is set in
41197 &_Local/Makefile_&.  The support uses the &_libspf2_& library
41198 &url(https://www.libspf2.org/).
41199 There is no Exim involvement in the transmission of messages;
41200 publishing certain DNS records is all that is required.
41201
41202 For verification, an ACL condition and an expansion lookup are provided.
41203 .cindex authentication "expansion item"
41204 Performing verification sets up information used by the
41205 &%authresults%& expansion item.
41206
41207
41208 .cindex SPF "ACL condition"
41209 .cindex ACL "spf condition"
41210 The ACL condition "spf" can be used at or after the MAIL ACL.
41211 It takes as an argument a list of strings giving the outcome of the SPF check,
41212 and will succeed for any matching outcome.
41213 Valid strings are:
41214 .vlist
41215 .vitem &%pass%&
41216 The SPF check passed, the sending host is positively verified by SPF.
41217
41218 .vitem &%fail%&
41219 The SPF check failed, the sending host is NOT allowed to send mail for the
41220 domain in the envelope-from address.
41221
41222 .vitem &%softfail%&
41223 The SPF check failed, but the queried domain can't absolutely confirm that this
41224 is a forgery.
41225
41226 .vitem &%none%&
41227 The queried domain does not publish SPF records.
41228
41229 .vitem &%neutral%&
41230 The SPF check returned a "neutral" state.  This means the queried domain has
41231 published a SPF record, but wants to allow outside servers to send mail under
41232 its domain as well.  This should be treated like "none".
41233
41234 .vitem &%permerror%&
41235 This indicates a syntax error in the SPF record of the queried domain.
41236 You may deny messages when this occurs.
41237
41238 .vitem &%temperror%&
41239 This indicates a temporary error during all processing, including Exim's
41240 SPF processing.  You may defer messages when this occurs.
41241 .endlist
41242
41243 You can prefix each string with an exclamation mark to  invert
41244 its meaning,  for example  "!fail" will  match all  results but
41245 "fail".  The  string  list is  evaluated  left-to-right,  in a
41246 short-circuit fashion.
41247
41248 Example:
41249 .code
41250 deny spf = fail
41251      message = $sender_host_address is not allowed to send mail from \
41252                ${if def:sender_address_domain \
41253                     {$sender_address_domain}{$sender_helo_name}}.  \
41254                Please see http://www.open-spf.org/Why;\
41255                identity=${if def:sender_address_domain \
41256                              {$sender_address}{$sender_helo_name}};\
41257                ip=$sender_host_address
41258 .endd
41259
41260 Note: The above mentioned URL may not be as helpful as expected. You are
41261 encouraged to replace the link with a link to a site with more
41262 explanations.
41263
41264 When the spf condition has run, it sets up several expansion
41265 variables:
41266
41267 .cindex SPF "verification variables"
41268 .vlist
41269 .vitem &$spf_header_comment$&
41270 .vindex &$spf_header_comment$&
41271   This contains a human-readable string describing the outcome
41272   of the SPF check. You can add it to a custom header or use
41273   it for logging purposes.
41274
41275 .vitem &$spf_received$&
41276 .vindex &$spf_received$&
41277   This contains a complete Received-SPF: header that can be
41278   added to the message. Please note that according to the SPF
41279   draft, this header must be added at the top of the header
41280   list. Please see section 10 on how you can do this.
41281
41282   Note: in case of "Best-guess" (see below), the convention is
41283   to put this string in a header called X-SPF-Guess: instead.
41284
41285 .vitem &$spf_result$&
41286 .vindex &$spf_result$&
41287   This contains the outcome of the SPF check in string form,
41288   one of pass, fail, softfail, none, neutral, permerror or
41289   temperror.
41290
41291 .vitem &$spf_result_guessed$&
41292 .vindex &$spf_result_guessed$&
41293   This boolean is true only if a best-guess operation was used
41294   and required in order to obtain a result.
41295
41296 .vitem &$spf_smtp_comment$&
41297 .vindex &$spf_smtp_comment$&
41298 .vindex &%spf_smtp_comment_template%&
41299   This contains a string that can be used in a SMTP response
41300   to the calling party. Useful for "fail".
41301   The string is generated by the SPF library from the template configured in the main config
41302   option &%spf_smtp_comment_template%&.
41303 .endlist
41304
41305
41306 .cindex SPF "ACL condition"
41307 .cindex ACL "spf_guess condition"
41308 .cindex SPF "best guess"
41309 In addition to SPF, you can also perform checks for so-called
41310 "Best-guess".  Strictly speaking, "Best-guess" is not standard
41311 SPF, but it is supported by the same framework that enables SPF
41312 capability.
41313 Refer to &url(http://www.open-spf.org/FAQ/Best_guess_record)
41314 for a description of what it means.
41315 . --- 2019-10-28: still not https:
41316
41317 To access this feature, simply use the spf_guess condition in place
41318 of the spf one.  For example:
41319
41320 .code
41321 deny spf_guess = fail
41322      message = $sender_host_address doesn't look trustworthy to me
41323 .endd
41324
41325 In case you decide to reject messages based on this check, you
41326 should note that although it uses the same framework, "Best-guess"
41327 is not SPF, and therefore you should not mention SPF at all in your
41328 reject message.
41329
41330 When the spf_guess condition has run, it sets up the same expansion
41331 variables as when spf condition is run, described above.
41332
41333 Additionally, since Best-guess is not standardized, you may redefine
41334 what "Best-guess" means to you by redefining the main configuration
41335 &%spf_guess%& option.
41336 For example, the following:
41337
41338 .code
41339 spf_guess = v=spf1 a/16 mx/16 ptr ?all
41340 .endd
41341
41342 would relax host matching rules to a broader network range.
41343
41344
41345 .cindex SPF "lookup expansion"
41346 .cindex lookup spf
41347 A lookup expansion is also available. It takes an email
41348 address as the key and an IP address
41349 (v4 or v6)
41350 as the database:
41351
41352 .code
41353   ${lookup {username@domain} spf {ip.ip.ip.ip}}
41354 .endd
41355
41356 The lookup will return the same result strings as can appear in
41357 &$spf_result$& (pass,fail,softfail,neutral,none,err_perm,err_temp).
41358
41359
41360
41361
41362
41363 .section "SRS (Sender Rewriting Scheme)" SECTSRS
41364 .cindex SRS "sender rewriting scheme"
41365
41366 .new
41367 SRS can be used to modify sender addresses when forwarding so that
41368 SPF verification does not object to them.
41369 It operates by encoding the original envelope sender in a new
41370 sender local part and using a domain run by the forwarding site
41371 as the new domain for the sender.  Any DSN message should be returned
41372 to this new sender at the forwarding site, which can extract the
41373 original sender from the coded local part and forward the DSN to
41374 the originator.
41375
41376 This is a way of avoiding the breakage that SPF does to forwarding.
41377 The constructed local-part will be longer than the original,
41378 leading to possible problems with very long addresses.
41379 The changing of the sender address also hinders the tracing of mail
41380 problems.
41381
41382 Exim can be built to include native SRS support.  To do this
41383 SUPPORT_SRS=yes must be defined in &_Local/Makefile_&.
41384 If this has been done, the macros _HAVE_SRS and _HAVE_NATIVE_SRS
41385 will be defined.
41386 The support is limited to SRS0-encoding; SRS1 is not supported.
41387
41388 .cindex SRS excoding
41389 To encode an address use this expansion item:
41390 .vlist
41391 .vitem &*${srs_encode&~{*&<&'secret'&>&*}{*&<&'return&~path'&>&*}{*&<&'original&~domain'&>&*}}*&
41392 .cindex "&%srs_encode%& expansion item"
41393 .cindex SRS "expansion item"
41394 The first argument should be a secret known and used by all systems
41395 handling the recipient domain for the original message.
41396 There is no need to periodically change this key; a timestamp is also
41397 encoded.
41398 The second argument should be given as the envelope sender address before this
41399 encoding operation.
41400 The third argument should be the recipient domain of the message when
41401 it arrived at this system.
41402 .endlist
41403
41404 .cindex SRS decoding
41405 To decode an address use this expansion condition:
41406 .vlist
41407 .vitem &*inbound_srs&~{*&<&'local&~part'&>&*}{*&<&'secret'&>&*}*&
41408 The first argument should be the recipient local prt as is was received.
41409 The second argument is the site secret.
41410
41411 If the messages is not for an SRS-encoded recipient the condition will
41412 return false.  If it is, the condition will return true and the variable
41413 &$srs_recipient$& will be set to the decoded (original) value.
41414 .endlist
41415
41416 Example usage:
41417 .code
41418   #macro
41419   SRS_SECRET = <pick something unique for your site for this. Use on all MXs.>
41420   
41421   #routers
41422
41423   outbound:
41424     driver =    dnslookup
41425     # if outbound, and forwarding has been done, use an alternate transport
41426     domains =   ! +my_domains
41427     transport = ${if eq {$local_part@$domain} \
41428                         {$original_local_part@$original_domain} \
41429                      {remote_smtp} {remote_forwarded_smtp}}
41430   
41431   inbound_srs:
41432     driver =    redirect
41433     senders =   :
41434     domains =   +my_domains
41435     # detect inbound bounces which are SRS'd, and decode them
41436     condition = ${if inbound_srs {$local_part} {SRS_SECRET}}
41437     data =      $srs_recipient
41438   
41439   inbound_srs_failure:
41440     driver =    redirect
41441     senders =   :
41442     domains =   +my_domains
41443     # detect inbound bounces which look SRS'd but are invalid
41444     condition = ${if inbound_srs {$local_part} {}}
41445     allow_fail
41446     data =      :fail: Invalid SRS recipient address
41447
41448   #... further routers here
41449
41450   
41451   # transport; should look like the non-forward outbound
41452   # one, plus the max_rcpt and return_path options
41453   remote_forwarded_smtp:
41454     driver =              smtp
41455     # modify the envelope from, for mails that we forward
41456     max_rcpt =            1
41457     return_path =         ${srs_encode {SRS_SECRET} {$return_path} {$original_domain}}
41458 .endd
41459
41460
41461 .wen
41462
41463
41464
41465 .section DMARC SECDMARC
41466 .cindex DMARC verification
41467
41468 DMARC combines feedback from SPF, DKIM, and header From: in order
41469 to attempt to provide better indicators of the authenticity of an
41470 email.  This document does not explain the fundamentals; you
41471 should read and understand how it works by visiting the website at
41472 &url(http://www.dmarc.org/).
41473
41474 If Exim is built with DMARC support,
41475 the libopendmarc library is used.
41476
41477 For building Exim yourself, obtain the library from
41478 &url(http://sourceforge.net/projects/opendmarc/)
41479 to obtain a copy, or find it in your favorite package
41480 repository.  You will need to attend to the local/Makefile feature
41481 SUPPORT_DMARC and the associated LDFLAGS addition.
41482 This description assumes
41483 that headers will be in /usr/local/include, and that the libraries
41484 are in /usr/local/lib.
41485
41486 . subsection
41487
41488 There are three main-configuration options:
41489 .cindex DMARC "configuration options"
41490
41491 The &%dmarc_tld_file%& option
41492 .oindex &%dmarc_tld_file%&
41493 defines the location of a text file of valid
41494 top level domains the opendmarc library uses
41495 during domain parsing. Maintained by Mozilla,
41496 the most current version can be downloaded
41497 from a link at &url(https://publicsuffix.org/list/public_suffix_list.dat).
41498 See also the util/renew-opendmarc-tlds.sh script.
41499 The default for the option is unset.
41500 If not set, DMARC processing is disabled.
41501
41502
41503 The &%dmarc_history_file%& option, if set
41504 .oindex &%dmarc_history_file%&
41505 defines the location of a file to log results
41506 of dmarc verification on inbound emails. The
41507 contents are importable by the opendmarc tools
41508 which will manage the data, send out DMARC
41509 reports, and expire the data. Make sure the
41510 directory of this file is writable by the user
41511 exim runs as.
41512 The default is unset.
41513
41514 The &%dmarc_forensic_sender%& option
41515 .oindex &%dmarc_forensic_sender%&
41516 defines an alternate email address to use when sending a
41517 forensic report detailing alignment failures
41518 if a sender domain's dmarc record specifies it
41519 and you have configured Exim to send them.
41520 If set, this is expanded and used for the
41521 From: header line; the address is extracted
41522 from it and used for the envelope from.
41523 If not set (the default), the From: header is expanded from
41524 the dsn_from option, and <> is used for the
41525 envelope from.
41526
41527 . I wish we had subsections...
41528
41529 .cindex DMARC controls
41530 By default, the DMARC processing will run for any remote,
41531 non-authenticated user.  It makes sense to only verify DMARC
41532 status of messages coming from remote, untrusted sources.  You can
41533 use standard conditions such as hosts, senders, etc, to decide that
41534 DMARC verification should *not* be performed for them and disable
41535 DMARC with an ACL control modifier:
41536 .code
41537   control = dmarc_disable_verify
41538 .endd
41539 A DMARC record can also specify a "forensic address", which gives
41540 exim an email address to submit reports about failed alignment.
41541 Exim does not do this by default because in certain conditions it
41542 results in unintended information leakage (what lists a user might
41543 be subscribed to, etc).  You must configure exim to submit forensic
41544 reports to the owner of the domain.  If the DMARC record contains a
41545 forensic address and you specify the control statement below, then
41546 exim will send these forensic emails.  It is also advised that you
41547 configure a &%dmarc_forensic_sender%& because the default sender address
41548 construction might be inadequate.
41549 .code
41550   control = dmarc_enable_forensic
41551 .endd
41552 (AGAIN: You can choose not to send these forensic reports by simply
41553 not putting the dmarc_enable_forensic control line at any point in
41554 your exim config.  If you don't tell exim to send them, it will not
41555 send them.)
41556
41557 There are no options to either control.  Both must appear before
41558 the DATA acl.
41559
41560 . subsection
41561
41562 DMARC checks cam be run on incoming SMTP  messages by using the
41563 &"dmarc_status"& ACL condition in the DATA ACL.  You are required to
41564 call the &"spf"& condition first in the ACLs, then the &"dmarc_status"&
41565 condition.  Putting this condition in the ACLs is required in order
41566 for a DMARC check to actually occur.  All of the variables are set
41567 up before the DATA ACL, but there is no actual DMARC check that
41568 occurs until a &"dmarc_status"& condition is encountered in the ACLs.
41569
41570 The &"dmarc_status"& condition takes a list of strings on its
41571 right-hand side.  These strings describe recommended action based
41572 on the DMARC check.  To understand what the policy recommendations
41573 mean, refer to the DMARC website above.  Valid strings are:
41574 .display
41575 &'accept      '& The DMARC check passed and the library recommends accepting the email.
41576 &'reject      '& The DMARC check failed and the library recommends rejecting the email.
41577 &'quarantine  '& The DMARC check failed and the library recommends keeping it for further inspection.
41578 &'none        '& The DMARC check passed and the library recommends no specific action, neutral.
41579 &'norecord    '& No policy section in the DMARC record for this sender domain.
41580 &'nofrom      '& Unable to determine the domain of the sender.
41581 &'temperror   '& Library error or dns error.
41582 &'off         '& The DMARC check was disabled for this email.
41583 .endd
41584 You can prefix each string with an exclamation mark to invert its
41585 meaning, for example "!accept" will match all results but
41586 "accept".  The string list is evaluated left-to-right in a
41587 short-circuit fashion.  When a string matches the outcome of the
41588 DMARC check, the condition succeeds.  If none of the listed
41589 strings matches the outcome of the DMARC check, the condition
41590 fails.
41591
41592 Of course, you can also use any other lookup method that Exim
41593 supports, including LDAP, Postgres, MySQL, etc, as long as the
41594 result is a list of colon-separated strings.
41595
41596 Performing the check sets up information used by the
41597 &%authresults%& expansion item.
41598
41599 Several expansion variables are set before the DATA ACL is
41600 processed, and you can use them in this ACL.  The following
41601 expansion variables are available:
41602
41603 .vlist
41604 .vitem &$dmarc_status$&
41605 .vindex &$dmarc_status$&
41606 .cindex DMARC result
41607 A one word status indicating what the DMARC library
41608 thinks of the email.  It is a combination of the results of
41609 DMARC record lookup and the SPF/DKIM/DMARC processing results
41610 (if a DMARC record was found).  The actual policy declared
41611 in the DMARC record is in a separate expansion variable.
41612
41613 .vitem &$dmarc_status_text$&
41614 .vindex &$dmarc_status_text$&
41615 Slightly longer, human readable status.
41616
41617 .vitem &$dmarc_used_domain$&
41618 .vindex &$dmarc_used_domain$&
41619 The domain which DMARC used to look up the DMARC policy record.
41620
41621 .vitem &$dmarc_domain_policy$&
41622 .vindex &$dmarc_domain_policy$&
41623 The policy declared in the DMARC record.  Valid values
41624 are "none", "reject" and "quarantine".  It is blank when there
41625 is any error, including no DMARC record.
41626 .endlist
41627
41628 . subsection
41629
41630 By default, Exim's DMARC configuration is intended to be
41631 non-intrusive and conservative.  To facilitate this, Exim will not
41632 create any type of logging files without explicit configuration by
41633 you, the admin.  Nor will Exim send out any emails/reports about
41634 DMARC issues without explicit configuration by you, the admin (other
41635 than typical bounce messages that may come about due to ACL
41636 processing or failure delivery issues).
41637
41638 In order to log statistics suitable to be imported by the opendmarc
41639 tools, you need to:
41640 .ilist
41641 Configure the global option &%dmarc_history_file%&
41642 .next
41643 Configure cron jobs to call the appropriate opendmarc history
41644 import scripts and truncating the dmarc_history_file
41645 .endlist
41646
41647 In order to send forensic reports, you need to:
41648 .ilist
41649 Configure the global option &%dmarc_forensic_sender%&
41650 .next
41651 Configure, somewhere before the DATA ACL, the control option to
41652 enable sending DMARC forensic reports
41653 .endlist
41654
41655 . subsection
41656
41657 Example usage:
41658 .code
41659 (RCPT ACL)
41660   warn    domains        = +local_domains
41661           hosts          = +local_hosts
41662           control        = dmarc_disable_verify
41663
41664   warn    !domains       = +screwed_up_dmarc_records
41665           control        = dmarc_enable_forensic
41666
41667   warn    condition      = (lookup if destined to mailing list)
41668           set acl_m_mailing_list = 1
41669
41670 (DATA ACL)
41671   warn    dmarc_status   = accept : none : off
41672           !authenticated = *
41673           log_message    = DMARC DEBUG: $dmarc_status $dmarc_used_domain
41674
41675   warn    dmarc_status   = !accept
41676           !authenticated = *
41677           log_message    = DMARC DEBUG: '$dmarc_status' for $dmarc_used_domain
41678
41679   warn    dmarc_status   = quarantine
41680           !authenticated = *
41681           set $acl_m_quarantine = 1
41682           # Do something in a transport with this flag variable
41683
41684   deny    condition      = ${if eq{$dmarc_domain_policy}{reject}}
41685           condition      = ${if eq{$acl_m_mailing_list}{1}}
41686           message        = Messages from $dmarc_used_domain break mailing lists
41687
41688   deny    dmarc_status   = reject
41689           !authenticated = *
41690           message        = Message from $dmarc_used_domain failed sender's DMARC policy, REJECT
41691
41692   warn    add_header     = :at_start:${authresults {$primary_hostname}}
41693 .endd
41694
41695
41696
41697
41698
41699 . ////////////////////////////////////////////////////////////////////////////
41700 . ////////////////////////////////////////////////////////////////////////////
41701
41702 .chapter "Proxies" "CHAPproxies" &&&
41703          "Proxy support"
41704 .cindex "proxy support"
41705 .cindex "proxy" "access via"
41706
41707 A proxy is an intermediate system through which communication is passed.
41708 Proxies may provide a security, availability or load-distribution function.
41709
41710
41711 .section "Inbound proxies" SECTproxyInbound
41712 .cindex proxy inbound
41713 .cindex proxy "server side"
41714 .cindex proxy "Proxy protocol"
41715 .cindex "Proxy protocol" proxy
41716
41717 Exim has support for receiving inbound SMTP connections via a proxy
41718 that uses &"Proxy Protocol"& to speak to it.
41719 To include this support, include &"SUPPORT_PROXY=yes"&
41720 in Local/Makefile.
41721
41722 It was built on the HAProxy specification, found at
41723 &url(https://www.haproxy.org/download/1.8/doc/proxy-protocol.txt).
41724
41725 The purpose of this facility is so that an application load balancer,
41726 such as HAProxy, can sit in front of several Exim servers
41727 to distribute load.
41728 Exim uses the local protocol communication with the proxy to obtain
41729 the remote SMTP system IP address and port information.
41730 There is no logging if a host passes or
41731 fails Proxy Protocol negotiation, but it can easily be determined and
41732 recorded in an ACL (example is below).
41733
41734 Use of a proxy is enabled by setting the &%hosts_proxy%&
41735 main configuration option to a hostlist; connections from these
41736 hosts will use Proxy Protocol.
41737 Exim supports both version 1 and version 2 of the Proxy Protocol and
41738 automatically determines which version is in use.
41739
41740 The Proxy Protocol header is the first data received on a TCP connection
41741 and is inserted before any TLS-on-connect handshake from the client; Exim
41742 negotiates TLS between Exim-as-server and the remote client, not between
41743 Exim and the proxy server.
41744
41745 The following expansion variables are usable
41746 (&"internal"& and &"external"& here refer to the interfaces
41747 of the proxy):
41748 .display
41749 &'proxy_external_address   '& IP of host being proxied or IP of remote interface of proxy
41750 &'proxy_external_port      '& Port of host being proxied or Port on remote interface of proxy
41751 &'proxy_local_address      '& IP of proxy server inbound or IP of local interface of proxy
41752 &'proxy_local_port         '& Port of proxy server inbound or Port on local interface of proxy
41753 &'proxy_session            '& boolean: SMTP connection via proxy
41754 .endd
41755 If &$proxy_session$& is set but &$proxy_external_address$& is empty
41756 there was a protocol error.
41757 The variables &$sender_host_address$& and &$sender_host_port$&
41758 will have values for the actual client system, not the proxy.
41759
41760 Since the real connections are all coming from the proxy, and the
41761 per host connection tracking is done before Proxy Protocol is
41762 evaluated, &%smtp_accept_max_per_host%& must be set high enough to
41763 handle all of the parallel volume you expect per inbound proxy.
41764 With the option set so high, you lose the ability
41765 to protect your server from many connections from one IP.
41766 In order to prevent your server from overload, you
41767 need to add a per connection ratelimit to your connect ACL.
41768 A possible solution is:
41769 .display
41770   # Set max number of connections per host
41771   LIMIT   = 5
41772   # Or do some kind of IP lookup in a flat file or database
41773   # LIMIT = ${lookup{$sender_host_address}iplsearch{/etc/exim/proxy_limits}}
41774
41775   defer   ratelimit      = LIMIT / 5s / per_conn / strict
41776           message        = Too many connections from this IP right now
41777 .endd
41778
41779
41780
41781 .section "Outbound proxies" SECTproxySOCKS
41782 .cindex proxy outbound
41783 .cindex proxy "client side"
41784 .cindex proxy SOCKS
41785 .cindex SOCKS proxy
41786 Exim has support for sending outbound SMTP via a proxy
41787 using a protocol called SOCKS5 (defined by RFC1928).
41788 The support can be optionally included by defining SUPPORT_SOCKS=yes in
41789 Local/Makefile.
41790
41791 Use of a proxy is enabled by setting the &%socks_proxy%& option
41792 on an smtp transport.
41793 The option value is expanded and should then be a list
41794 (colon-separated by default) of proxy specifiers.
41795 Each proxy specifier is a list
41796 (space-separated by default) where the initial element
41797 is an IP address and any subsequent elements are options.
41798
41799 Options are a string <name>=<value>.
41800 The list of options is in the following table:
41801 .display
41802 &'auth   '& authentication method
41803 &'name   '& authentication username
41804 &'pass   '& authentication password
41805 &'port   '& tcp port
41806 &'tmo    '& connection timeout
41807 &'pri    '& priority
41808 &'weight '& selection bias
41809 .endd
41810
41811 More details on each of these options follows:
41812
41813 .ilist
41814 .cindex authentication "to proxy"
41815 .cindex proxy authentication
41816 &%auth%&: Either &"none"& (default) or &"name"&.
41817 Using &"name"& selects username/password authentication per RFC 1929
41818 for access to the proxy.
41819 Default is &"none"&.
41820 .next
41821 &%name%&: sets the username for the &"name"& authentication method.
41822 Default is empty.
41823 .next
41824 &%pass%&: sets the password for the &"name"& authentication method.
41825 Default is empty.
41826 .next
41827 &%port%&: the TCP port number to use for the connection to the proxy.
41828 Default is 1080.
41829 .next
41830 &%tmo%&: sets a connection timeout in seconds for this proxy.
41831 Default is 5.
41832 .next
41833 &%pri%&: specifies a priority for the proxy within the list,
41834 higher values being tried first.
41835 The default priority is 1.
41836 .next
41837 &%weight%&: specifies a selection bias.
41838 Within a priority set servers are queried in a random fashion,
41839 weighted by this value.
41840 The default value for selection bias is 1.
41841 .endlist
41842
41843 Proxies from the list are tried according to their priority
41844 and weight settings until one responds.  The timeout for the
41845 overall connection applies to the set of proxied attempts.
41846
41847 .section Logging SECTproxyLog
41848 To log the (local) IP of a proxy in the incoming or delivery logline,
41849 add &"+proxy"& to the &%log_selector%& option.
41850 This will add a component tagged with &"PRX="& to the line.
41851
41852 . ////////////////////////////////////////////////////////////////////////////
41853 . ////////////////////////////////////////////////////////////////////////////
41854
41855 .chapter "Internationalisation" "CHAPi18n" &&&
41856          "Internationalisation""
41857 .cindex internationalisation "email address"
41858 .cindex EAI
41859 .cindex i18n
41860 .cindex utf8 "mail name handling"
41861
41862 Exim has support for Internationalised mail names.
41863 To include this it must be built with SUPPORT_I18N and the libidn library.
41864 Standards supported are RFCs 2060, 5890, 6530 and 6533.
41865
41866 If Exim is built with SUPPORT_I18N_2008 (in addition to SUPPORT_I18N, not
41867 instead of it) then IDNA2008 is supported; this adds an extra library
41868 requirement, upon libidn2.
41869
41870 .section "MTA operations" SECTi18nMTA
41871 .cindex SMTPUTF8 "ESMTP option"
41872 .cindex "ESMTP extensions" SMTPUTF8
41873 The main configuration option &%smtputf8_advertise_hosts%& specifies
41874 a host list.  If this matches the sending host and
41875 accept_8bitmime is true (the default) then the ESMTP option
41876 SMTPUTF8 will be advertised.
41877
41878 If the sender specifies the SMTPUTF8 option on a MAIL command
41879 international handling for the message is enabled and
41880 the expansion variable &$message_smtputf8$& will have value TRUE.
41881
41882 The option &%allow_utf8_domains%& is set to true for this
41883 message. All DNS lookups are converted to a-label form
41884 whatever the setting of &%allow_utf8_domains%&
41885 when Exim is built with SUPPORT_I18N.
41886
41887 Both localparts and domain are maintained as the original
41888 UTF-8 form internally; any comparison or regular-expression use will
41889 require appropriate care.  Filenames created, eg. by
41890 the appendfile transport, will have UTF-8 names.
41891
41892 HELO names sent by the smtp transport will have any UTF-8
41893 components expanded to a-label form,
41894 and any certificate name checks will be done using the a-label
41895 form of the name.
41896
41897 .cindex log protocol
41898 .cindex SMTPUTF8 logging
41899 .cindex i18n logging
41900 Log lines and Received-by: header lines will acquire a "utf8"
41901 prefix on the protocol element, eg. utf8esmtp.
41902
41903 The following expansion operators can be used:
41904 .code
41905 ${utf8_domain_to_alabel:str}
41906 ${utf8_domain_from_alabel:str}
41907 ${utf8_localpart_to_alabel:str}
41908 ${utf8_localpart_from_alabel:str}
41909 .endd
41910
41911 .cindex utf8 "address downconversion"
41912 .cindex i18n "utf8 address downconversion"
41913 The RCPT ACL
41914 may use the following modifier:
41915 .display
41916 control = utf8_downconvert
41917 control = utf8_downconvert/<value>
41918 .endd
41919 This sets a flag requiring that envelope addresses are converted to
41920 a-label form before smtp delivery.
41921 This is usually for use in a Message Submission Agent context,
41922 but could be used for any message.
41923
41924 If a value is appended it may be:
41925 .display
41926 &`1  `& mandatory downconversion
41927 &`0  `& no downconversion
41928 &`-1 `& if SMTPUTF8 not supported by destination host
41929 .endd
41930 If no value is given, 1 is used.
41931
41932 If mua_wrapper is set, the utf8_downconvert control
41933 is initially set to -1.
41934
41935 The smtp transport has an option &%utf8_downconvert%&.
41936 If set it must expand to one of the three values described above,
41937 or an empty string.
41938 If non-empty it overrides value previously set
41939 (due to mua_wrapper or by an ACL control).
41940
41941
41942 There is no explicit support for VRFY and EXPN.
41943 Configurations supporting these should inspect
41944 &$smtp_command_argument$& for an SMTPUTF8 argument.
41945
41946 There is no support for LMTP on Unix sockets.
41947 Using the "lmtp" protocol option on an smtp transport,
41948 for LMTP over TCP, should work as expected.
41949
41950 There is no support for DSN unitext handling,
41951 and no provision for converting logging from or to UTF-8.
41952
41953
41954
41955 .section "MDA operations" SECTi18nMDA
41956 To aid in constructing names suitable for IMAP folders
41957 the following expansion operator can be used:
41958 .code
41959 ${imapfolder {<string>} {<sep>} {<specials>}}
41960 .endd
41961
41962 The string is converted from the charset specified by
41963 the "headers charset" command (in a filter file)
41964 or &%headers_charset%& main configuration option (otherwise),
41965 to the
41966 modified UTF-7 encoding specified by RFC 2060,
41967 with the following exception: All occurrences of <sep>
41968 (which has to be a single character)
41969 are replaced with periods ("."), and all periods and slashes that are not
41970 <sep> and are not in the <specials> string are BASE64 encoded.
41971
41972 The third argument can be omitted, defaulting to an empty string.
41973 The second argument can be omitted, defaulting to "/".
41974
41975 This is the encoding used by Courier for Maildir names on disk, and followed
41976 by many other IMAP servers.
41977
41978 Examples:
41979 .display
41980 &`${imapfolder {Foo/Bar}}       `& yields &`Foo.Bar`&
41981 &`${imapfolder {Foo/Bar}{.}{/}} `& yields &`Foo&&AC8-Bar`&
41982 &`${imapfolder {Räksmörgås}}    `& yields &`R&&AOQ-ksm&&APY-rg&&AOU-s`&
41983 .endd
41984
41985 Note that the source charset setting is vital, and also that characters
41986 must be representable in UTF-16.
41987
41988
41989 . ////////////////////////////////////////////////////////////////////////////
41990 . ////////////////////////////////////////////////////////////////////////////
41991
41992 .chapter "Events" "CHAPevents" &&&
41993          "Events"
41994 .cindex events
41995
41996 The events mechanism in Exim can be used to intercept processing at a number
41997 of points.  It was originally invented to give a way to do customised logging
41998 actions (for example, to a database) but can also be used to modify some
41999 processing actions.
42000
42001 Most installations will never need to use Events.
42002 The support can be left out of a build by defining DISABLE_EVENT=yes
42003 in &_Local/Makefile_&.
42004
42005 There are two major classes of events: main and transport.
42006 The main configuration option &%event_action%& controls reception events;
42007 a transport option &%event_action%& controls delivery events.
42008
42009 Both options are a string which is expanded when the event fires.
42010 An example might look like:
42011 .cindex logging custom
42012 .code
42013 event_action = ${if eq {msg:delivery}{$event_name} \
42014 {${lookup pgsql {SELECT * FROM record_Delivery( \
42015     '${quote_pgsql:$sender_address_domain}',\
42016     '${quote_pgsql:${lc:$sender_address_local_part}}', \
42017     '${quote_pgsql:$domain}', \
42018     '${quote_pgsql:${lc:$local_part}}', \
42019     '${quote_pgsql:$host_address}', \
42020     '${quote_pgsql:${lc:$host}}', \
42021     '${quote_pgsql:$message_exim_id}')}} \
42022 } {}}
42023 .endd
42024
42025 Events have names which correspond to the point in process at which they fire.
42026 The name is placed in the variable &$event_name$& and the event action
42027 expansion must check this, as it will be called for every possible event type.
42028
42029 The current list of events is:
42030 .display
42031 &`dane:fail              after    transport  `& per connection
42032 &`msg:complete           after    main       `& per message
42033 &`msg:defer              after    transport  `& per message per delivery try
42034 &`msg:delivery           after    transport  `& per recipient
42035 &`msg:rcpt:host:defer    after    transport  `& per recipient per host
42036 &`msg:rcpt:defer         after    transport  `& per recipient
42037 &`msg:host:defer         after    transport  `& per host per delivery try; host errors
42038 &`msg:fail:delivery      after    transport  `& per recipient
42039 &`msg:fail:internal      after    main       `& per recipient
42040 &`tcp:connect            before   transport  `& per connection
42041 &`tcp:close              after    transport  `& per connection
42042 &`tls:cert               before   both       `& per certificate in verification chain
42043 &`smtp:connect           after    transport  `& per connection
42044 &`smtp:ehlo              after    transport  `& per connection
42045 .endd
42046 New event types may be added in future.
42047
42048 The event name is a colon-separated list, defining the type of
42049 event in a tree of possibilities.  It may be used as a list
42050 or just matched on as a whole.  There will be no spaces in the name.
42051
42052 The second column in the table above describes whether the event fires
42053 before or after the action is associates with.  Those which fire before
42054 can be used to affect that action (more on this below).
42055
42056 The third column in the table above says what section of the configuration
42057 should define the event action.
42058
42059 An additional variable, &$event_data$&, is filled with information varying
42060 with the event type:
42061 .display
42062 &`dane:fail            `& failure reason
42063 &`msg:defer            `& error string
42064 &`msg:delivery         `& smtp confirmation message
42065 &`msg:fail:internal    `& failure reason
42066 &`msg:fail:delivery    `& smtp error message
42067 &`msg:host:defer       `& error string
42068 &`msg:rcpt:host:defer  `& error string
42069 &`msg:rcpt:defer       `& error string
42070 &`tls:cert             `& verification chain depth
42071 &`smtp:connect         `& smtp banner
42072 &`smtp:ehlo            `& smtp ehlo response
42073 .endd
42074
42075 The :defer events populate one extra variable: &$event_defer_errno$&.
42076
42077 For complex operations an ACL expansion can be used in &%event_action%&
42078 however due to the multiple contexts that Exim operates in during
42079 the course of its processing:
42080 .ilist
42081 variables set in transport events will not be visible outside that
42082 transport call
42083 .next
42084 acl_m variables in a server context are lost on a new connection,
42085 and after smtp helo/ehlo/mail/starttls/rset commands
42086 .endlist
42087 Using an ACL expansion with the logwrite modifier can be
42088 a useful way of writing to the main log.
42089
42090 The expansion of the event_action option should normally
42091 return an empty string.  Should it return anything else the
42092 following will be forced:
42093 .display
42094 &`tcp:connect      `&  do not connect
42095 &`tls:cert         `&  refuse verification
42096 &`smtp:connect     `&  close connection
42097 .endd
42098 All other message types ignore the result string, and
42099 no other use is made of it.
42100
42101 For a tcp:connect event, if the connection is being made to a proxy
42102 then the address and port variables will be that of the proxy and not
42103 the target system.
42104
42105 For tls:cert events, if GnuTLS is in use this will trigger only per
42106 chain element received on the connection.
42107 For OpenSSL it will trigger for every chain element including those
42108 loaded locally.
42109
42110 . ////////////////////////////////////////////////////////////////////////////
42111 . ////////////////////////////////////////////////////////////////////////////
42112
42113 .chapter "Adding new drivers or lookup types" "CHID13" &&&
42114          "Adding drivers or lookups"
42115 .cindex "adding drivers"
42116 .cindex "new drivers, adding"
42117 .cindex "drivers" "adding new"
42118 The following actions have to be taken in order to add a new router, transport,
42119 authenticator, or lookup type to Exim:
42120
42121 .olist
42122 Choose a name for the driver or lookup type that does not conflict with any
42123 existing name; I will use &"newdriver"& in what follows.
42124 .next
42125 Add to &_src/EDITME_& the line:
42126 .display
42127 <&'type'&>&`_NEWDRIVER=yes`&
42128 .endd
42129 where <&'type'&> is ROUTER, TRANSPORT, AUTH, or LOOKUP. If the
42130 code is not to be included in the binary by default, comment this line out. You
42131 should also add any relevant comments about the driver or lookup type.
42132 .next
42133 Add to &_src/config.h.defaults_& the line:
42134 .code
42135 #define <type>_NEWDRIVER
42136 .endd
42137 .next
42138 Edit &_src/drtables.c_&, adding conditional code to pull in the private header
42139 and create a table entry as is done for all the other drivers and lookup types.
42140 .next
42141 Edit &_scripts/lookups-Makefile_& if this is a new lookup; there is a for-loop
42142 near the bottom, ranging the &`name_mod`& variable over a list of all lookups.
42143 Add your &`NEWDRIVER`& to that list.
42144 As long as the dynamic module would be named &_newdriver.so_&, you can use the
42145 simple form that most lookups have.
42146 .next
42147 Edit &_Makefile_& in the appropriate sub-directory (&_src/routers_&,
42148 &_src/transports_&, &_src/auths_&, or &_src/lookups_&); add a line for the new
42149 driver or lookup type and add it to the definition of OBJ.
42150 .next
42151 Edit &_OS/Makefile-Base_& adding a &_.o_& file for the predefined-macros, to the
42152 definition of OBJ_MACRO.  Add a set of line to do the compile also.
42153 .next
42154 Create &_newdriver.h_& and &_newdriver.c_& in the appropriate sub-directory of
42155 &_src_&.
42156 .next
42157 Edit &_scripts/MakeLinks_& and add commands to link the &_.h_& and &_.c_& files
42158 as for other drivers and lookups.
42159 .endlist
42160
42161 Then all you need to do is write the code! A good way to start is to make a
42162 proforma by copying an existing module of the same type, globally changing all
42163 occurrences of the name, and cutting out most of the code. Note that any
42164 options you create must be listed in alphabetical order, because the tables are
42165 searched using a binary chop procedure.
42166
42167 There is a &_README_& file in each of the sub-directories of &_src_& describing
42168 the interface that is expected.
42169
42170
42171
42172
42173 . ////////////////////////////////////////////////////////////////////////////
42174 . ////////////////////////////////////////////////////////////////////////////
42175
42176 . /////////////////////////////////////////////////////////////////////////////
42177 . These lines are processing instructions for the Simple DocBook Processor that
42178 . Philip Hazel has developed as a less cumbersome way of making PostScript and
42179 . PDFs than using xmlto and fop. They will be ignored by all other XML
42180 . processors.
42181 . /////////////////////////////////////////////////////////////////////////////
42182
42183 .literal xml
42184 <?sdop
42185   format="newpage"
42186   foot_right_recto="&chaptertitle;"
42187   foot_right_verso="&chaptertitle;"
42188 ?>
42189 .literal off
42190
42191 .makeindex "Options index"   "option"
42192 .makeindex "Variables index" "variable"
42193 .makeindex "Concept index"   "concept"
42194
42195
42196 . /////////////////////////////////////////////////////////////////////////////
42197 . /////////////////////////////////////////////////////////////////////////////